Automate Sort Script Creation with OpenSearch API - OpenSearch - Alibaba Cloud - OpenSearch

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:WriteSortScript

create

*App

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

None

Request syntax

POST /v4/openapi/app-groups/{appGroupIdentity}/apps/{appVersionId}/sort-scripts HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	Yes	The name or ID of the application.	search
appVersionId	string	Yes	The ID of the report under the application.	1234567

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
scriptName	string	No	The script name.	rank_cava_20230606_v7
type	string	No	The type of the script. Currently, only cava_script is supported.	cava_script
scope	string	No	The scope of the script.	second_rank
description	string	No	The remarks of the script.

Request parameters

Name	Type	Required	Description
scriptParams	Map	Yes	The script parameters to be registered.

scriptParams

Name	Type	Required	Description
scriptName	String	Yes	The script name.
type	String	Yes	The type of the script. Currently, only cava_script is supported.
scope	String	Yes	The scope of the script. Currently, only second_rank is supported.

Response elements

Element	Type	Description	Example
	object
requestId	string	The request ID.	ABCDEFGH
result	object	The returned result.
scriptName	string	The script name.	rank_cava_20230606_v7
type	string	The type of the script.	cava_script
scope	string	The scope of the script.	second_rank
status	string

Examples

Success response

JSON format

{
  "requestId": "ABCDEFGH",
  "result": {
    "scriptName": "rank_cava_20230606_v7\n",
    "type": "cava_script",
    "scope": "second_rank"
  },
  "status": ""
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.