DescribeSecondRank - OpenSearch - Alibaba Cloud Documentation Center

Queries a fine sort expression that is 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.

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

Request syntax

GET /v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/second-ranks/{name} HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	Yes	The name of the application	my_app_group_name
appId	integer	Yes	The version number of the application.	110157886
name	string	Yes	The name of the fine sort expression	test

Response parameters

Parameter	Type	Description	Example
	object
requestId	string	The request ID.	0A6EB64B-B4C8-CF02-810F-E660812972FF
result	object	The information about the fine sort expression.
created	integer	The time when the expression was created.	1587052801
active	boolean	Specifies whether to set the fine sort expression as the default sort expression.	true
isDefault	string	Indicates whether the expression is the default one. This parameter appears only in the response. Valid values: true false	true
isSys	string	Indicates whether the expression is a system expression. This parameter appears only in the response. Valid values: true false	false
description	string	Description	-
updated	integer	The time when the expression was updated.	1587052801
name	string	The name.	tests
meta	string	The content of the fine sort expression. You can define an expression that consists of fields, feature functions, and mathematical functions to implement complex sort logic.	random()+now()
id	string	The ID of the expression. This parameter appears only in the response.	89047

Examples

Sample success responses

JSONformat

{
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result": {
    "created": 1587052801,
    "active": true,
    "isDefault": "true",
    "isSys": "false",
    "description": "-",
    "updated": 1587052801,
    "name": "tests",
    "meta": "random()+now()",
    "id": "89047"
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history