All Products
Search
Document Center

OpenSearch:CreateABTestExperiment

Last Updated:Mar 03, 2024

Creates an experiment.

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

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
appGroupIdentitystringYes

The application name.

my_app_group_name
sceneIdintegerYes

The scenario ID.

20404
groupIdintegerYes

The group ID.

13467
dryRunbooleanNo

Specifies whether to perform a dry run. This parameter is only used to check whether the data source is valid. Valid values: true and false.

false
bodyABTestExperimentNo

The request body.

Request body

ParameterTypeRequiredExampleDescription
nameStringYes"my_test"The experiment name.
trafficIntegerYes30The traffic that is routed to the experiment.
onlineBooleanYestrueSpecifies whether the experiment is in effect.
paramsObjectYes{"firstFormulaName": "default"}The experiment configurations. For more information, see ABTestExperiment .

Response parameters

ParameterTypeDescriptionExample
object
requestIdstring

The request ID.

D77D0DAF-790D-F5F5-A9C0-133738165014
resultobject

The experiment details.

createdinteger

The time when the experiment was created.

0
paramsobject

The experiment parameters.

{"firstFormulaName": "default"}
trafficinteger

The percentage of traffic that is routed to the experiment.

30
onlineboolean

Indicates whether the experiment is in effect. Valid values:

  • true
  • false
true
namestring

The experiment alias.

test3
updatedinteger

The time when the experiment was last modified.

1589017861
idstring

The experiment ID.

12889

Examples

Sample success responses

JSONformat

{
  "requestId": "D77D0DAF-790D-F5F5-A9C0-133738165014",
  "result": {
    "created": 0,
    "params": {
      "firstFormulaName": "default"
    },
    "traffic": 30,
    "online": true,
    "name": "test3",
    "updated": 1589017861,
    "id": "12889"
  }
}

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