UpdateSortScript - OpenSearch - Alibaba Cloud Documentation Center

Modifies the description of a sort script.

Operation description

You can call this operation to modify the description of a sort script.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:WriteSortScript		App acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}	none	none

Request syntax

PUT /v4/openapi/app-groups/{appGroupIdentity}/apps/{appVersionId}/sort-scripts/{scriptName}

Request parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	Yes	The name of the application or the ID of the application.	my_app
appVersionId	string	Yes	The version number of the application.	123456
scriptName	string	Yes	The name of the script.	test_cava

Response parameters

Parameter	Type	Description	Example
	object	The response body.
requestId	string	The ID of the request.	9F165784-5507-5342-ABF3-545293F9808A

Examples

Sample requests

PUT /v4/openapi/app-groups/my_app/apps/123456/sort-scripts/test_cava
{
    "description" : "just for test"
}

Sample success responses

XML format

<requestId>ABCDEFGH</requestId>

JSON format

{"requestId":"ABCDEFGH"}

Examples

Sample success responses

JSONformat

{
  "requestId": "9F165784-5507-5342-ABF3-545293F9808A"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history