Queries the details of a sort script.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only the common request headers. For more information, see Common request parameters.

Request syntax

GET /v4/openapi/app-groups/[appGroupIdentity]/apps/[appVersionId]/sort-scripts/[scriptName] HTTP/1.1

Request parameters

Parameter Type Position Required Example Description
appGroupIdentity String Path Yes my_app

The name or ID of the application.

appVersionId String Path Yes 123456

The version number of the application.

scriptName String Path Yes script1

The name of the script to query.

Response parameters

Parameter Type Example Description
requestId String ABCDEFGH

The ID of the request.

result Struct

The details of the script

createTime String 2020-04-02 20:21:14

The time when the script was created.

modifyTime String 2020-04-02 21:21:14

The time when the script was last modified.

scope String second_rank

The sort phase to which the script applies.

status String released

The status of the script. For more information, see the Script status table.

type String cava_script

The type of the script.

Script status

Status value



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.


The script is published.


Sample requests

GET /v4/openapi/app-groups/my_app/apps/123456/sort-scripts/script1

Sample success responses

XML format

    <createTime>2020-04-02 20:21:14</createTime>
    <modifyTime>2020-04-02 21:21:14</modifyTime>

JSON format

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

Sample error response

Error response
    "requestId" : "ABCDEFGH",
    "message":"The specified script not found.",

Error codes

For a list of error codes, visit the API Error Center.