All Products
Search

This Product

    OpenSearch:ListUserAnalyzers

    Document Center

    OpenSearch:ListUserAnalyzers

    Last Updated:Dec 08, 2025

    Retrieves a list of custom analyzers for your account.

    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

    *Analyzer

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

    		 None None

    Request syntax

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

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    pageNumber

    integer

    No

    The page number. The default value is 1.

    1
    pageSize

    integer

    No

    The number of entries to return on each page. The default value is 10.

    10

    Response elements

    Element

    Type

    Description

    Example

    object

    totalCount

    integer

    The total number of entries.

    1
    requestId

    string

    The ID of the request.

    0A6EB64B-B4C8-CF02-810F-E660812972FF
    result

    array<object>

    The list of custom analyzers.

    For more information, see UserAnalyzer.

    array<object>

    created

    integer

    The timestamp when the analyzer was created.

    1588054131
    available

    boolean

    Indicates whether the analyzer is available.

    false
    name

    string

    The name of the custom analyzer.

    kevin_test2
    updated

    integer

    The timestamp when the analyzer was last updated.

    1588054131
    id

    string

    The ID of the custom analyzer.

    1234
    business

    string

    The basic analyzer. Valid values:

    • chn_standard: A general-purpose analyzer for Chinese.

    • chn_scene_name: An analyzer for Chinese person names.

    • chn_ecommerce: An analyzer for e-commerce in Chinese.

    • chn_it_content: An analyzer for IT content in Chinese.

    • en_min: A fine-grained analyzer for English.

    • th_standard: A general-purpose analyzer for Thai.

    • th_ecommerce: An analyzer for e-commerce in Thai.

    • vn_standard: A general-purpose analyzer for Vietnamese.

    • chn_community_it: An analyzer for IT community content in Chinese.

    • chn_ecommerce_general: A general-purpose analyzer for the e-commerce industry in Chinese.

    • chn_esports_general: A general-purpose analyzer for the gaming industry in Chinese.

    • chn_edu_question: An analyzer for question-answering search in the education industry in Chinese.

    chn_standard
    dicts

    array<object>

    The dictionaries that the custom analyzer uses.

    For more information, see 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

    Examples

    Success response

    JSON format

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

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.