ListABMetricGroups

Updated at:

Retrieves a list of A/B metric groups.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

pairec:ListABMetricGroups

list

*All Resource

*

None None

Request syntax

GET /api/v1/abmetricgroups HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

SceneId

string

No

The scene ID. You can call the ListScenes operation to obtain this ID.

1

InstanceId

string

Yes

The instance ID. You can call the ListInstances operation to obtain this ID.

pairec-cn-test1

PageNumber

integer

No

The page number.

1

PageSize

integer

No

The number of entries to return on each page.

10

Realtime

boolean

No

Specifies whether to return only real-time A/B metric groups.

false

SortBy

string

No

The field to sort the results by. Valid values:

  • GmtCreateTime: creation time.

  • GmtModifiedTime: modification time.

GmtCreateTime

Order

string

No

The sort order. Valid values:

  • ASC: ascending.

  • DESC: descending.

ASC

Response elements

Element

Type

Description

Example

object

The data returned.

RequestId

string

The request ID.

E15A1443-7917-5BE0-AE70-25538ECF398D

TotalCount

integer

The total number of A/B metric groups.

10

ABMetricGroups

array<object>

The A/B metric groups.

object

An A/B metric group.

ABMetricGroupId

string

The A/B metric group ID.

1

Name

string

The A/B metric group name.

visits

SceneId

string

The scene ID.

1

Description

string

The description of the A/B metric group.

访问量相关指标

Owner

string

The owner.

2799614***

ABMetricIds

string

The comma-separated IDs of the A/B metrics in the group.

1,2

ABMetricNames

string

The comma-separated names of the A/B metrics in the group.

pv,uv

Realtime

boolean

Indicates whether the A/B metric group is a real-time group.

false

Examples

Success response

JSON format

{
  "RequestId": "E15A1443-7917-5BE0-AE70-25538ECF398D",
  "TotalCount": 10,
  "ABMetricGroups": [
    {
      "ABMetricGroupId": "1",
      "Name": "visits",
      "SceneId": "1",
      "Description": "访问量相关指标",
      "Owner": "2799614***",
      "ABMetricIds": "1,2",
      "ABMetricNames": "pv,uv",
      "Realtime": false
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.