CreateABTestExperiment - OpenSearch - Alibaba Cloud Documentation Center

Creates an experiment.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated 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 HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	Yes	The application name.	my_app_group_name
sceneId	integer	Yes	The scenario ID.	20404
groupId	integer	Yes	The group ID.	13467
dryRun	boolean	No	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
body	ABTestExperiment	No	The request body.

Request body

Parameter	Type	Required	Example	Description
name	String	Yes	"my_test"	The experiment name.
traffic	Integer	Yes	30	The traffic that is routed to the experiment.
online	Boolean	Yes	true	Specifies whether the experiment is in effect.
params	Object	Yes	{"firstFormulaName": "default"}	The experiment configurations. For more information, see ABTestExperiment .

Response parameters

Parameter	Type	Description	Example
	object
requestId	string	The request ID.	D77D0DAF-790D-F5F5-A9C0-133738165014
result	object	The experiment details.
created	integer	The time when the experiment was created.	0
params	object	The experiment parameters.	{"firstFormulaName": "default"}
traffic	integer	The percentage of traffic that is routed to the experiment.	30
online	boolean	Indicates whether the experiment is in effect. Valid values: true false	true
name	string	The experiment alias.	test3
updated	integer	The time when the experiment was last modified.	1589017861
id	string	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 time	Summary of changes	Operation
2023-05-24	The request parameters of the API has changed	View Change Details