CreateFirstRank - OpenSearch - Alibaba Cloud Documentation Center

Creates a rough sort expression for a version of an OpenSearch application. If you set dryRun to true, this operation checks the specified rough sort expression. By default, the value of dryRun is false if you do not set 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:WriteFirstRank		FirstRank acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
dryRun	boolean	No	Specifies whether to perform a dry run.	true
appGroupIdentity	string	Yes	The name of the application	my_app_group_name
appId	integer	Yes	The version number of the application.	110157886
body	FirstRank	No	The request body that contains the parameters of 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 content of the expression is a structure. This is the default value.STRING: The content of 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 parameters

Parameter	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.
metaItem	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	float	The weight. Valid values: [-100000,100000]. The value cannot be 0.	10

Examples

Sample success responses

JSONformat

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

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