All Products
Search
Document Center

OpenSearch:CreateUserAnalyzer

Last Updated:Mar 03, 2024

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
opensearch:CreateUserAnalyzer
  • Analyzer
    acs:opensearch:{#regionId}:{#accountId}:user-analyzers/*
    none
none

Request syntax

POST /v4/openapi/user-analyzers

Request parameters

ParameterTypeRequiredDescriptionExample
bodyobjectNo

The request body.

namestringNo

The analyzer name.

jmbon_analyzer
businessstringNo

The basic analyzer.

chn_standard
businessTypestringNo

The basic analyzer type. Valid values: AUTO, MODEL, SYSTEM, and USER.

AUTO
typestringNo

The engine type. Valid values: HA3 and ES.

HA3
businessAppGroupIdstringNo

The application ID of the custom analyzer.

110123123
dryRunbooleanNo

Specifies whether to perform only a dry run, without performing the actual request. Default value: false.

Valid values:

  • true
  • false
false

Response parameters

ParameterTypeDescriptionExample
object
resultobject

The custom analyzer.

{}
RequestIdstring

The ID of the request.

98724351-D6B2-5D8A-B089-7FFD1821A7E9

Examples

Sample success responses

JSONformat

{
  "result": {},
  "RequestId": "98724351-D6B2-5D8A-B089-7FFD1821A7E9"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-05-24The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: body
    Added Input Parameters: dryRun