All Products
Search
Document Center

OpenSearch:UpdateABTestExperiment

Last Updated:Mar 15, 2024

Modifies the parameters of an A/B test.

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

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
appGroupIdentitystringYes

The name of the application.

“my_app_group_name”
sceneIdintegerYes

The scenario ID.

20404
groupIdintegerYes

The ID of the test group

13467
experimentIdintegerYes

The test ID.

12889
dryRunbooleanNo

Specifies whether to perform only a dry run, without performing the actual request. Valid values:

  • true: performs only a dry run. No endpoint is created. The system checks whether your AccessKey is valid, whether Resource Access Management (RAM) users are authorized, and whether the required parameters are set.
  • false (default): creates an endpoint immediately.
true
bodyABTestExperimentNo

The request body. For more information, see ABTestExperiment .

Request body

ParameterTypeRequiredExampleDescription
nameStringNo"my_test"The name of the test.
trafficIntegerNo30The traffic that is routed to the test.
onlineBooleanNotrueSpecifies whether the test is in effect.
paramsObjectNo{"firstFormulaName": "default"}The test configurations.

Response parameters

ParameterTypeDescriptionExample
object
requestIdstring

The request ID.

D77D0DAF-790D-F5F5-A9C0-133738165014
resultobject

The details of the test.

createdinteger

The time when the test was created.

1588842080
paramsobject

The test parameters.

{}
trafficinteger

The percentage of traffic that is routed to the test. Valid values: [0,100]

30
onlineboolean

Indicates whether the test is in effect. Valid values:

  • true
  • false
true
namestring

The alias of the test.

test1
updatedinteger

The time when the test was last modified.

1588842080
idstring

The test ID.

12888

Examples

Sample success responses

JSONformat

{
  "requestId": "D77D0DAF-790D-F5F5-A9C0-133738165014",
  "result": {
    "created": 1588842080,
    "params": {},
    "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
2023-05-24The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: dryRun
    Added Input Parameters: body