ModifySecondRank - OpenSearch - Alibaba Cloud Documentation Center

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

opensearch:WriteSecondRank

*SecondRank

acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}

None

Request syntax

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

Path Parameters

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

Request parameters

Parameter	Type	Required	Description	Example
dryRun	boolean	No	Specifies whether to perform a dry run.	true
body	SecondRank	No	The request body, which contains the fine sort information.

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	Specifies whether the expression is the default expression.

Response elements

Element	Type	Description	Example
	object	The response body.	{}
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 expression. This parameter is returned only in the response. true: The expression is the default expression. false: The expression is not the default expression.	true
isSys	string	Indicates whether the expression is a system expression. This parameter is returned only in the response. 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 name of the expression.	lsh_second_1
meta	string	The fine sort expression. You can create an expression that contains fields, scoring features, and mathematical functions to implement complex sorting logic.	cate_id > 0 and cate_id < 1000
id	string	The ID of the expression. This parameter is returned only in the response.	890473

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.