Queries the entries of a custom analyzer.

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/[name]/entries HTTP/1.1

Request parameters

Parameter Type Position Required Example Description
name String Path Yes kevin_test

The name of the analyzer.

word String Query No kevintest

The key to be used to query entries.

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 516A02B7-2167-8D92-12D0-B639A2A0F3C5

The ID of the request.

result Map []

The entries of the custom analyzer.

For more information, see UserAnalyzerEntry.

Examples

Sample requests

GET /v4/openapi/user-analyzers/test/entries

Sample success responses

XML format

<requestId>516A02B7-2167-8D92-12D0-B639A2A0F3C5</requestId>
<result>
    <cmd>add</cmd>
    <key>kevintest</key>
    <value>kevin test</value>
    <created>1536690285</created>
    <updated>1537348987</updated>
    <status>ACTIVE</status>
    <splitEnabled>true</splitEnabled>
</result>
<result>
    <cmd>add</cmd>
    <key>kevintest</key>
    <value>kevintest</value>
    <created>1536690285</created>
    <updated>1537348987</updated>
    <status>ACTIVE</status>
    <splitEnabled>false</splitEnabled>
</result>
<result>
    <cmd>delete</cmd>
    <key>kevintest</key>
    <created>1536690285</created>
    <updated>1537348987</updated>
    <status>ACTIVE_PENDING</status>
    <splitEnabled>true</splitEnabled>
</result>
<totalCount>3</totalCount>

JSON format

{
    "requestId": "516A02B7-2167-8D92-12D0-B639A2A0F3C5",
    "result": [
        {
            "cmd": "add",
            "key": "kevintest",
            "value": "kevin test",
            "created": 1536690285,
            "updated": 1537348987,
            "status": "ACTIVE",
            "splitEnabled": true
        },
        {
            "cmd": "add",
            "key": "kevintest",
            "value": "kevintest",
            "created": 1536690285,
            "updated": 1537348987,
            "status": "ACTIVE",
            "splitEnabled": false
        },
        {
            "cmd": "delete",
            "key": "kevintest",
            "created": 1536690285,
            "updated": 1537348987,
            "status": "ACTIVE_PENDING",
            "splitEnabled": true
        }
    ],
    "totalCount": 3
}

Error codes

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