CreateFirstRank - 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:WriteFirstRank

*FirstRank

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

None

Request syntax

POST /v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/first-ranks HTTP/1.1

Path 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

Request parameters

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

Request body

Parameter	Type	Required	Example	Description
name	String	Yes	"test"	The name of the expression.
type	String	Yes	"STRUCT"	The type of the expression. Valid values: - STRUCT: The expression is a structure. This is the default value. - STRING: The expression is a custom formula.
meta	Array or String	Yes		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 one.

Response elements

Element	Type	Description	Example
	object
requestId	string	The request ID.	0A6EB64B-B4C8-CF02-810F-E660812972FF
result	object	The information about the rough sort expression.
active	boolean	Indicates whether the expression is the default one.	true
name	string	The name of the expression.	default
meta	array<object>	The content of the expression.
	object
arg	string	The parameters that are used by a function in the expression.	1
attribute	string	The attribute, feature functions, or field to be searched for.	static_bm25()
weight	number	The weight. Valid values: [-100000, 100000]. The value cannot be 0.	10

Examples

Success response

JSON format

{
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result": {
    "active": true,
    "name": "default",
    "meta": [
      {
        "arg": "1",
        "attribute": "static_bm25()",
        "weight": 10
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.