ModifySecondRank - OpenSearch - Alibaba Cloud Documentation Center

Modifies a fine sort expression that is configured for a specific OpenSearch application version. If you set dryRun to true, the specified fine sort expression is checked after the expression is modified. By default, the value of dryRun is false if you do not specify this parameter.

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

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	Yes	The application name.	“my_app_group_name”
appId	integer	Yes	The version number of the application.	110157886
name	string	Yes	The name of the fine sort expression.	true
dryRun	boolean	No	Specifies whether the request is a dry run.	true
body	SecondRank	No	The request parameters.

Request body

Parameter	Type	Required	Example	Description
meta	String	No	"text_relevance(name)"	The content of the expression.
description	String	No	"my_test"	The description of the expression.
active	Boolean	No	true	Indicates whether the expression is the default one.

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
requestId	string	The request ID.	C5E2F73C-8241-81F8-3A62-65478C5A3111
result	object	The information about the fine sort expression.
created	integer	The time when the expression was created.	1
active	boolean	Indicates whether the expression is the default one.	true
isDefault	string	Indicates whether the expression is the default one. This parameter is displayed only in the response. Valid values: true: the expression is the default one. false: the expression is not the default one.	true
isSys	string	Indicates whether the expression is a system expression. This parameter is displayed only in the response. Valid values: true: The expression is a system expression. false:The expression is not a system expression	false
description	string	The description of the expression.	"11"
updated	integer	The time when the expression was updated.	1
name	string	The expression name.	lsh_second_1
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.	cate_id > 0 and cate_id < 1000
id	string	The expression ID. This parameter is displayed only in the response.	890473

Examples

Sample success responses

JSONformat

{
  "requestId": "C5E2F73C-8241-81F8-3A62-65478C5A3111",
  "result": {
    "created": 1,
    "active": true,
    "isDefault": "true",
    "isSys": "false",
    "description": "\"11\"",
    "updated": 1,
    "name": "lsh_second_1",
    "meta": "cate_id > 0 and cate_id < 1000",
    "id": "890473"
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2023-05-24	The request parameters of the API has changed	View Change Details