All Products
Search
Document Center

OpenSearch:ModifySecondRank

Last Updated:Mar 15, 2024

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

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
appGroupIdentitystringYes

"my_app_group_name"

“my_app_group_name”
appIdintegerYes

110157886

110157886
namestringYes

true

true
dryRunbooleanNo

true

true
bodySecondRankNo

The request body.

Response parameters

ParameterTypeDescriptionExample
object
requestIdstring

The ID of the request.

C5E2F73C-8241-81F8-3A62-65478C5A3111
resultobject

The information about the fine sort expression.

createdinteger

The time when the cluster was created.

1
activeboolean

Indicates whether the expression is the default one.

true
isDefaultstring

Indicates whether the expression is the default one. This parameter appears only in the response. Valid values:

  • true
  • false
true
isSysstring

Indicates whether the expression is a system expression. This parameter appears only in the response. Valid values:

  • true
  • false
false
descriptionstring

The description of the expression.

"11"
updatedinteger

The time when the task was updated.

1
namestring

The name of the expression.

lsh_second_1
metastring

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
idstring

The ID of the expression. This parameter appears 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 timeSummary of changesOperation
2023-05-24The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: body