GetSortScript - OpenSearch - Alibaba Cloud Documentation Center

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

Request syntax

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

Request parameters

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

Response parameters

Parameter	Type	Description	Example
	object
requestId	string	The request ID.	ABCDEFGH
result	object	The details of the script.
scope	string	The sort phase to which the script applies.	second_rank
createTime	string	The time when the script was created.	2020-04-02 20:21:14
status	string	The status of the script. For more information, see the description of the status response parameter in the ListSortScripts topic.	released
modifyTime	string	The time when the script was last modified.	2020-04-02 21:21:14
type	string	The type of the script.	cava_script
scriptName	string	The name of the script.	rank_cava_20230606_v7

Error response{ "requestId" : "ABCDEFGH", "code":"ResourceNotFound", "message":"The specified script not found.", "httpCode":404 }

Examples

Sample success responses

JSONformat

{
  "requestId": "ABCDEFGH",
  "result": {
    "scope": "second_rank",
    "createTime": "2020-04-02 20:21:14",
    "status": "released",
    "modifyTime": "2020-04-02 21:21:14",
    "type": "cava_script",
    "scriptName": "rank_cava_20230606_v7\n"
  }
}

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 response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.