PushUserAnalyzerEntries - OpenSearch - Alibaba Cloud Documentation Center

Accepts the changes in the entries of a custom analyzer.

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:WriteUserAnalyzer		Analyzer acs:opensearch:{#regionId}:{#accountId}:user-analyzers/{#AnalyzerId}	none	none

Request syntax

POST /v4/openapi/user-analyzers/{name}/entries/actions/bulk HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
name	string	Yes	The name of the analyzer.	“kevin_test”
dryRun	boolean	No	Specifies whether to perform a dry run. This parameter is only used to check whether the data source is valid. Valid values: true and false.	true
body	object	No	The request body.
entries	array<object>	No	The entries of the custom analyzer.
	object	No
cmd	string	No	The operation to be performed on the entries. Valid values: add delete	"add"
key	string	No	The key to be used to query entries.	"testvalue"
value	string	No	The analysis result.	"test value"
splitEnabled	boolean	No	Specifies whether to further analyze the terms that are generated after the search query is analyzed. Default value: true.	true

Note: Use lowercase letters when you add intervention entries.

Response parameters

Parameter	Type	Description	Example
	object
result	object	The result returned.	{}
RequestId	string	The request ID.	D77D0DAF-790D-F5F5-A9C0-133738165014

Examples

Sample success responses

JSONformat

{
  "result": {},
  "RequestId": "D77D0DAF-790D-F5F5-A9C0-133738165014"
}

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