Build A/B Test Experiments via API for Search Traffic Splitting - OpenSearch

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

opensearch:CreateApp

*ABTestScenes

acs:opensearch:{#regionId}:{#accountId}:app-groups{#AppGroupId}

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	Yes	The name of the application group.	my_app_group_name

Request parameters

Parameter	Type	Required	Description	Example
body	ABTestScene	No	The A/B test scene. For more information, see ABTestScene.
dryRun	boolean	No	Specifies whether to validate only the request parameters. The default value is false. Values: true: Validates only the request parameters. false: Validates the request parameters and creates the attribution configuration.	false

Request body

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

Response elements

Element	Type	Description	Example
	object
requestId	string	The request ID.	D77D0DAF-790D-F5F5-A9C0-133738165014
result	object	The result of the request.
created	integer	The time when the scene was created.	0
status	integer	The status of the scene. Valid values: 0: disabled 1: enabled	1
updated	integer	The time when the scene was last updated.	1589012351
name	string	The name of the group.	kevintest_2020-5-7_15:21:48
id	string	The ID of the group.	20405
values	array	The IDs of the scenes.
	string	The ID of a scene.	[ "kevintest" ]

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.