ListSortScripts - OpenSearch - Alibaba Cloud Documentation Center

Queries all sort scripts of an application version.

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

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	Yes	The name or ID of the application.	my_app
appVersionId	string	Yes	The version ID of the application.	110142366

Response parameters

Parameter	Type	Description	Example
	object
requestId	string	The request ID.	ABCDEFGH
result	array<object>	The scripts.
scriptInfo	object
type	string	The type of the script.	cava_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. Valid values: configurable: The script is created, but no script files are uploaded. not compiled: The script is not compiled. compile failed: The compilation of the script failed. compile successful: The script is compiled. released: The script is published.	released
modifyTime	string	The time when the script was last modified.	2020-04-02 21:21:14
scriptName	string	The name of the script.	test

Error response { "requestId" : "ABCDEFGH", "code":"InvalidAppSpec", "message":"The cava scripts only support the private spec app.", "httpCode":400 }

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history