All Products
Search
Document Center

OpenSearch:GetSortScriptFile

Last Updated:Mar 03, 2024

Queries the content 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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
opensearch:DescribeSortScript
  • SortScript
    acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}
    none
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
appGroupIdentitystringYes

my_app

my_app
scriptNamestringYes

UserScorer.cava

UserScorer.cava
appVersionIdstringYes

123456

123456
fileNamestringYes

script1

script1

Response parameters

ParameterTypeDescriptionExample
object
requestIdstring

The ID of the request.

ABCDEFGH
resultobject

The content of the sort script.

contentstring

The script content that is encoded in the Base64 format.

YWJjZGVmZw==
createTimestring

The time when the script was created.

2020-04-02 20:21:14
modifyTimestring

The last time when the script was last modified.

2020-04-02 21:21:14
versionlong

The version of the script.

123456

Examples

Sample success responses

JSONformat

{
  "requestId": "ABCDEFGH",
  "result": {
    "content": "YWJjZGVmZw==",
    "createTime": "2020-04-02 20:21:14",
    "modifyTime": "2020-04-02 21:21:14",
    "version": 123456
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history