CreateABTestScene - OpenSearch - Alibaba Cloud Documentation Center

Creates an scenario.

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		ABTestScenes acs:opensearch:{#regionId}:{#accountId}:app-groups{#AppGroupId}	none	none

Request syntax

POST /v4/openapi/app-groups/{appGroupIdentity}/scenes HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	Yes	The name of the application	my_app_group_name
body	ABTestScene	No	The ABTest scenario. For more information, see ABTestScene
dryRun	boolean	No	Specifies whether to check the validity of input parameters. Default value: false. Valid values: true: checks only the validity of input parameters. false: checks the validity of input parameters and creates an attribution configuration.	false

Request body

Parameter	Type	Required	Example	Description
name	String	Yes	"kevintest22"	The name of the test scenario.
status	Integer	No	0	The status of the scenario. Valid values:- 0: The test is stopped.- 1: The test is started.
created	Integer	No	1589012351	The time when the test scenario was created.
updated	Integer	No	1589012351	The time when the test scenario was last updated.
values[]	String	No	"kevintest22"	The ID of the test scenario

Response parameters

Parameter	Type	Description	Example
	object
requestId	string	The request ID.	D77D0DAF-790D-F5F5-A9C0-133738165014
result	object	The returned data.
created	integer	The time when the test scenario was created.	0
status	integer	The status. Valid values: 0: not in effect 1: in effect	1
updated	integer	The time when the test scenario was last updated.	1589012351
name	string	The name of the A/B test group.	kevintest_2020-5-7_15:21:48
id	string	The ID of the test group.	20405
values	array	The ID of the test scenario
values	string	The ID of the test scenario	[ "kevintest" ]

Examples

Sample success responses

JSONformat

{
  "requestId": "D77D0DAF-790D-F5F5-A9C0-133738165014",
  "result": {
    "created": 0,
    "status": 1,
    "updated": 1589012351,
    "name": "kevintest_2020-5-7_15:21:48",
    "id": "20405",
    "values": [
      "[       \"kevintest\"     ]"
    ]
  }
}

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