All Products
Search
Document Center

OpenSearch:ListSortExpressions

Last Updated:Oct 16, 2024

Queries a list of sort expressions that are configured for a version of an OpenSearch application.

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.

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:ListSortExpressionnone
  • FirstRank
    acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}
  • SecondRank
    acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}
    none
none

Request syntax

GET /v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/sort-expressions HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
appGroupIdentitystringYes

The application name.

my_app_group_name
appIdintegerYes

The version ID.

110116134

Paging parameters

ParameterTypeRequiredExampleDescription
pageNumberIntegerNo1The page number. Default value: 1.
pageSizeIntegerNo10The number of entries per page. Default value: 10.

Response parameters

ParameterTypeDescriptionExample
object
requestIdstring

The request ID.

D77D0DAF-790D-F5F5-A9C0-133738165014
resultarray<object>

The information about the rough sort or fine sort expressions that are returned.

For more information, see FirstRank and SecondRank .

firstRankItemobject
createdinteger

The timestamp when the sort expression was created.

1655793690
activeboolean

Indicates whether the expression is the default one.

true
descriptionstring

The description of the sort expression.

""
updatedinteger

The timestamp when the sort expression was updated.

1655793690
namestring

The name of the sort expression.

default

Examples

Sample success responses

JSONformat

{
  "requestId": "D77D0DAF-790D-F5F5-A9C0-133738165014",
  "result": [
    {
      "created": 1655793690,
      "active": true,
      "description": "\"\"",
      "updated": 1655793690,
      "name": "default"
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history