Automate A/B Test Experiments with the OpenSearch API - OpenSearch - Alibaba Cloud - 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

create

*AbTestExperiment

acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	Yes	The application name.	my_app_group_name
sceneId	integer	Yes	The scene ID.	20404
groupId	integer	Yes	The group ID.	13467

Request parameters

Parameter	Type	Required	Description	Example
dryRun	boolean	No	Specifies whether to only validate the request parameters. Default value: false. Valid values: true: Only validates the request parameters. false: Validates the request parameters and creates the attribution configuration.	false
body	ABTestExperiment	No	The request body.

Request body

Field	Type	Required	Example	Description
name	String	Yes	"my_test"	The experiment name.
traffic	Integer	Yes	30	The experiment traffic.
online	Boolean	Yes	true	Specifies whether the experiment is active.
params	Object	Yes	{"firstFormulaName": "default"}	The experiment configuration. For more information, see ABTestExperiment.

Response elements

Element	Type	Description	Example
	object
requestId	string	The request ID.	D77D0DAF-790D-F5F5-A9C0-133738165014
result	object	The experiment details.
created	integer	The creation time.	0
params	object	The experiment parameters.	{"firstFormulaName": "default"}
traffic	integer	The experiment bucketing percentage.	30
online	boolean	The experiment status. true: Active. false: Inactive.	true
name	string	The experiment alias.	test3
updated	integer	The last modification time.	1589017861
id	string	The experiment ID.	12889
serialNumber	integer

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.