All Products
Search
Document Center

OpenSearch:DescribeABTestExperiment

Last Updated:Apr 09, 2024

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:DescribeApp
  • AbTestExperiment
    acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}
    none
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
appGroupIdentitystringYes

The application name.

my_app_group_name
sceneIdintegerYes

The scenario ID.

20404
groupIdintegerYes

The group ID.

13467
experimentIdintegerYes

The experiment ID

12889

Response parameters

ParameterTypeDescriptionExample
object
requestIdstring

The ID of the request.

D77D0DAF-790D-F5F5-A9C0-133738165014
resultobject

The details of the test.

createdinteger

The time when the test was created.

1588842080
trafficinteger

The percentage of traffic that is routed to the test.

30
onlineboolean

The status of the test. Valid values:

  • true: in effect
  • false: not in effect
true
namestring

The name of the test.

test1
updatedinteger

The time when the test was last modified.

1588842080
idstring

The ID of the test.

12888
paramsobject

The parameters of the test.

first_formula_namestring

The name of the rough sort policy.

default

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
No change history