All Products
Search
Document Center

OpenSearch:ListUserAnalyzers

Last Updated:Oct 16, 2024

Queries the custom analyzers that belong to the current account.

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.

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

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
pageNumberintegerNo

The number of the page to return. Default value: 1.

1
pageSizeintegerNo

The number of entries to return on each page. Default value: 10.

10

Response parameters

ParameterTypeDescriptionExample
object
totalCountinteger

The total number.

1
requestIdstring

The ID of the request.

0A6EB64B-B4C8-CF02-810F-E660812972FF
resultarray<object>

The custom analyzer.

For more information, see UserAnalyzer .

resultobject
createdinteger

The timestamp when the application was created.

1588054131
availableboolean

Indicates whether the application is available.

false
namestring

The name of the custom analyzer.

kevin_test2
updatedinteger

The timestamp when the application was last updated.

1588054131
idstring

The ID of the custom analyzer.

1234
businessstring

The basic analyzer. Valid values:

  • chn_standard: a common analyzer in Chinese
  • chn_scene_name: an analyzer for person names in Chinese
  • chn_ecommerce: an analyzer for E-commerce in Chinese
  • chn_it_content: an analyzer for IT content in Chinese
  • en_min: a small-granularity analyzer in English
  • th_standard: a common analyzer in Thai
  • th_ecommerce: an analyzer for E-commerce in Thai
  • vn_standard: a common analyzer in Vietnamese
  • chn_community_it: an analyzer for IT community content in Chinese
  • chn_ecommerce_general: a common analyzer for the E-commerce industry in Chinese
  • chn_esports_general: a common analyzer for the gaming industry in Chinese
  • chn_edu_question: an analyzer for question search of the education industry in Chinese
chn_standard
dictsarray<object>

The dictionaries that are used by the custom analyzer.

For more information, see UserDict .

dictsobject
createdinteger

The timestamp when the application was created.

1588054131
entriesCountinteger

The number of intervention entries.

-1
typestring

The type. Valid value:

  • segment
segment
entriesLimitinteger

The maximum number of intervention entries that can be created in the dictionary.

4
availableboolean

Indicates whether the application is available.

false
updatedinteger

The timestamp when the application was last updated.

1588054131
idstring

The ID of the dictionary.

123

Examples

Sample success responses

JSONformat

{
  "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

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

Change history

Change timeSummary of changesOperation
No change history