Automate Intervention Dictionary Updates via PushInterventionDictionaryEntries API - OpenSearch - Alibaba Cloud - OpenSearch

Accepts intervention entry changes.

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

update

*InterventionDictionary

acs:opensearch:{#regionId}:{#accountId}:intervention-dictionaries/{#InterventionDictionaryId}

None

Request syntax

POST /v4/openapi/intervention-dictionaries/{name}/entries/actions/bulk HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
name	string	Yes	The intervention dictionary name.	my_dict

Request parameters

Parameter	Type	Required	Description	Example
dryRun	boolean	No	Specifies whether to only validate the request parameters. Default value: false. Valid values: true: Only validates the request parameters. false: Validates the request parameters and creates the attribution configuration.	false
body	array<object>	No	The request body.
	array<object>	No	The request body.	{ "cmd": "add", "word": "search", "created": 1536661485, "updated": 1537320187, "status": "ACTIVE", "relevance": { "100": "0", "200": "2" } }
cmd	string	No
word	string	No
status	string	No
stopword	boolean	No
alias	array	No
	string	No
antiAlias	array	No
	string	No
correction	string	No
enabled	boolean	No
relevance	object	No
	integer	No
tokens	array<object>	No
	object	No
token	string	No
weight	integer	No
tag	string	No
tagLabel	string	No
order	integer	No
matchType	integer	No
expirationTime	integer	No
tags	array	No
	integer	No
rank	integer	No

Request body Common parameters.

Field	Type	Required	Example	Description
[]	Object	Yes		The entry information.
[].cmd	String	Yes	"add"	The operation command. - add: Create. - delete: Delete.
[].word	String	Yes	"Alibaba Cloud"	The entry.

Specific parameters Reference:

Response elements

Element	Type	Description	Example
	object
requestId	string	The request ID.	D77D0DAF-790D-F5F5-A9C0-133738165014
result	array	The response result.
	string	The response result.	[]

Examples

Success response

JSON format

{
  "requestId": "D77D0DAF-790D-F5F5-A9C0-133738165014",
  "result": [
    "[]"
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.