All Products
Search
Document Center

OpenSearch:ListABTestExperiments

Last Updated:Oct 16, 2024

Queries a list of experiments.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
opensearch:ListApp
  • AbTestExperiment
    acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}
    none
none

Request syntax

GET /v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}/groups/{groupId}/experiments HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
appGroupIdentitystringYes

The application name.

“my_app_group_name”
sceneIdintegerYes

The scenario ID.

13467
groupIdintegerYes

The group ID.

20404

Response parameters

ParameterTypeDescriptionExample
object
requestIdstring

The request ID.

D77D0DAF-790D-F5F5-A9C0-133738165014
resultarray<object>

The experiment details.
For more information, see ABTestExperiment .

resultobject
createdinteger

The time when the experiment was created.

1588842080
paramsobject

The experiment parameters.

1
trafficinteger

The percentage of traffic that is routed to the experiment.

Valid values: [0,100]

30
onlineboolean

Indicates whether the experiment is in effect. Valid values:

  • true
  • false
true
namestring

The group alias.

test1
updatedinteger

The time when the experiment was last modified.

1588842080
idstring

The experiment ID.

12888

Examples

Sample success responses

JSONformat

{
  "requestId": "D77D0DAF-790D-F5F5-A9C0-133738165014",
  "result": [
    {
      "created": 1588842080,
      "params": 1,
      "traffic": 30,
      "online": true,
      "name": "test1",
      "updated": 1588842080,
      "id": "12888"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history