Queries the custom analyzers that belong to the current account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only the common request headers. For more information, see Common request parameters.

Request syntax

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

Request parameters

Parameter Type Position Required Example Description
pageNumber Integer Query No 1

The number of the page to return. Default value: 1.
pageSize Integer Query No 10

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

Response parameters

Parameter Type Example Description
requestId String 0A6EB64B-B4C8-CF02-810F-E660812972FF

The ID of the request.
result Array of result

The details of the custom analyzers.

For more information, see UserAnalyzer.

available Boolean false

Indicates whether the analyzer is available.
business String chn_standard

The basic analyzer. Valid values:
created Integer 1588054131

The time when the custom analyzer was created.
dicts Array of dicts

The dictionaries that are used by the custom analyzer.

For more information, see UserDict.

available Boolean false

Indicates whether the dictionary is available.
created Integer 1588054131

The time when the dictionary was created.
entriesCount Integer -1

The number of entries in the dictionary.
entriesLimit Integer 4

The maximum number of entries that the dictionary can contain.
id String 123

The ID of the dictionary.
type String segment

The type of the dictionary. Valid value:

  • segment
updated Integer 1588054131

The time when the dictionary was updated.
id String 1234

The ID of the custom analyzer.
name String kevin_test2

The name of the custom analyzer.
updated Integer 1588054131

The time when the custom analyzer was updated.
totalCount Integer 1

The total number of custom analyzers that belong to the current account.

Examples

Sample requests

GET /v4/openapi/user-analyzers

Sample success responses

XML format 

<id>1234</id>
<name>kevin_test2</name>
<business>chn_standard</business>
<dicts>
    <id>123</id>
    <type>segment</type>
    <entriesLimit>4</entriesLimit>
    <entriesCount>-1</entriesCount>
    <available>false</available>
    <created>1588054131</created>
    <updated>1588054131</updated>
</dicts>
<available>true</available>
<created>1588054131</created>
<updated>1588054131</updated>

JSON format 

{
    "id": 1234,
    "name": "kevin_test2",
    "business": "chn_standard",
    "dicts": {
        "id": 123,
        "type": "segment",
        "entriesLimit": 4,
        "entriesCount": -1,
        "available": false,
        "created": 1588054131,
        "updated": 1588054131
    },
    "available": true,
    "created": 1588054131,
    "updated": 1588054131
}

Error codes

For a list of error codes, visit the API Error Center.