UpdateABTestGroup - OpenSearch - Alibaba Cloud Documentation Center

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:UpdateApp

update

*AbTestGroup

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

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	Yes	The name of the application.	“my_app_group_name”
sceneId	integer	Yes	The scenario ID.	20404
groupId	integer	Yes	The ID of the test group.	13467

Request parameters

Parameter	Type	Required	Description	Example
body	ABTestGroup	No	The request body. For more information, see ABTestGroup.
dryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: Performs a dry run. The system checks if the AccessKey is valid, if the RAM user is authorized, and if all required parameters are specified. The test group is not updated. false (default): Sends the request to update the test group.	true

Request body

Parameter	Type	Required	Example	Description
name	String	Yes	"kevintest3"	The name of the test group.

Response elements

Element	Type	Description	Example
	object
requestId	string	The request ID.	''1111''
result	object	The details of the test group.
created	integer	The time when the test group was created.	1588839490
status	integer	The status of the test group. Valid values: 0: inactive 1: active	1
updated	integer	The time when the test group was last updated.	1588839490
name	string	The name of the test group.	Group_2020-5-7_15:23:3
id	string	The ID of the test group.	13466

Examples

Success response

JSON format

{
  "requestId": "''1111''",
  "result": {
    "created": 1588839490,
    "status": 1,
    "updated": 1588839490,
    "name": "Group_2020-5-7_15:23:3",
    "id": "13466"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.