Query Custom Analyzers via ListUserAnalyzers API with Pagination - OpenSearch - Alibaba Cloud - OpenSearch

Retrieves the list of custom tokenizers for a user.

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

list

*Analyzer

acs:opensearch:{#regionId}:{#accountId}:user-analyzers/*

None

Request syntax

GET /v4/openapi/user-analyzers HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
pageNumber	integer	No	The page number. Default value: 1.	1
pageSize	integer	No	The number of entries to return on each page. Default value: 10.	10

Response elements

Element	Type	Description	Example
	object
totalCount	integer	The total number of entries.	1
requestId	string	The request ID.	0A6EB64B-B4C8-CF02-810F-E660812972FF
result	array<object>	The custom analyzers. References: UserAnalyzer
	array<object>
created	integer	The creation timestamp.	1588054131
name	string	The name.	kevin_test2
business	string	The basic tokenizer. chn_standard Chinese - general analysis chn_scene_name Chinese - person name analysis chn_ecommerce Chinese - E-commerce analysis chn_it_content IT - content analysis en_min English - fine-grained analysis th_standard Thai - general analysis th_ecommerce Thai - E-commerce analysis vn_standard Vietnamese - general analysis chn_community_it Industry - content IT analysis chn_ecommerce_general Industry - E-commerce general analysis chn_esports_general Industry - game general analysis chn_edu_question Industry - education question-answering search	chn_standard
dicts	array<object>	The custom tokenization dictionaries. References: UserDict
	object
created	integer	The timestamp when the dictionary was created.	1588054131
entriesCount	integer	The number of entries.	-1
type	string	The type of the dictionary. Valid value: segment: A dictionary for word segmentation.	segment
entriesLimit	integer	The maximum number of entries in the dictionary.	4
available	boolean	Indicates whether the dictionary is available.	false
updated	integer	The timestamp when the dictionary was last updated.	1588054131
id	string	The ID of the dictionary.	123
updated	integer	The update timestamp.	1588054131
businessType	string
type	string

Examples

Success response

JSON format

{
  "totalCount": 1,
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result": [
    {
      "created": 1588054131,
      "name": "kevin_test2",
      "business": "chn_standard",
      "dicts": [
        {
          "created": 1588054131,
          "entriesCount": -1,
          "type": "segment",
          "entriesLimit": 4,
          "available": false,
          "updated": 1588054131,
          "id": "123"
        }
      ],
      "updated": 1588054131,
      "businessType": "",
      "type": ""
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.