CreateSortScript - OpenSearch - Alibaba Cloud Documentation Center

Creates a sort script.

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

Request syntax

POST /v4/openapi/app-groups/{appGroupIdentity}/apps/{appVersionId}/sort-scripts HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	Yes	The application name or ID.	search
appVersionId	string	Yes	The ID of the report in the application.	1234567
body	object	No	The request body.
scriptName	string	No	The script name.	rank_cava_20230606_v7
type	string	No	The script type. Set the value to cava_script.	cava_script
scope	string	No	The sort phase to which the script applies.	second_rank

Request parameters

Parameter	Type	Required	Description
scriptParams	Map	Yes	The parameters of the script to register.

scriptParams

Parameter	Type	Required	Description
scriptName	String	Yes	The script name.
type	String	Yes	The script type. Set the value to cava_script.
scope	String	Yes	The sort phase to which the script applies. Set the value to second_rank.

Response parameters

Parameter	Type	Description	Example
	object
requestId	string	The request ID.	ABCDEFGH
result	object	The response parameters.
scriptName	string	The script name.	rank_cava_20230606_v7
type	string	The script type.	cava_script
scope	string	The sort phase to which the script applies.	second_rank

Examples

Sample success responses

JSONformat

{
  "requestId": "ABCDEFGH",
  "result": {
    "scriptName": "rank_cava_20230606_v7\n",
    "type": "cava_script",
    "scope": "second_rank"
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2023-08-16	The request parameters of the API has changed. The response structure of the API has changed	View Change Details