Queries the details 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] HTTP/1.1

Request parameters

Parameter Type Position Required Example Description
name String Path Yes kevin_test

The name of the custom analyzer.

with String Query No all

The analyzer information to query. Valid value:

  • all: the information about the applications that are associated to the analyzer.

Response parameters

Parameter Type Example Description
requestId String FFAEF396-10EF-53C7-1F51-518853880729

The ID of the request.

result Map {}

The details of the custom analyzer.

Examples

Sample requests

GET /v4/openapi/user-analyzers/kevin_test?with=all

Sample success responses

XML format

<requestId>FFAEF396-10EF-53C7-1F51-518853880729</requestId>
<result>
    <id>1234</id>
    <name>kevin_test</name>
    <business>chn_it_content</business>
    <available>true</available>
    <relatedAppInfoList>
        <id>100298352</id>
        <name>test_srn_mysql</name>
    </relatedAppInfoList>
    <dicts>
        <id>123</id>
        <type>segment</type>
        <entries>
            <cmd>add</cmd>
            <key>kevintest</key>
            <value>kevin test</value>
            <created>1536690285</created>
            <updated>1537348987</updated>
            <status>ACTIVE</status>
            <splitEnabled>true</splitEnabled>
        </entries>
        <entries>
            <cmd>add</cmd>
            <key>abcd</key>
            <value>abcd</value>
            <created>1536690285</created>
            <updated>1537348987</updated>
            <status>ACTIVE</status>
            <splitEnabled>true</splitEnabled>
        </entries>
        <entriesLimit>4</entriesLimit>
        <entriesCount>2</entriesCount>
        <available>true</available>
        <created>1584702214</created>
        <updated>1584702214</updated>
    </dicts>
    <created>1584702212</created>
    <updated>1584702212</updated>
</result>

JSON format

{
    "requestId": "FFAEF396-10EF-53C7-1F51-518853880729",
    "result": {
        "id": 1234,
        "name": "kevin_test",
        "business": "chn_it_content",
        "available": true,
        "relatedAppInfoList": {
            "id": 100298352,
            "name": "test_srn_mysql"
        },
        "dicts": {
            "id": 123,
            "type": "segment",
            "entries": [
                {
                    "cmd": "add",
                    "key": "kevintest",
                    "value": "kevin test",
                    "created": 1536690285,
                    "updated": 1537348987,
                    "status": "ACTIVE",
                    "splitEnabled": true
                },
                {
                    "cmd": "add",
                    "key": "abcd",
                    "value": "abcd",
                    "created": 1536690285,
                    "updated": 1537348987,
                    "status": "ACTIVE",
                    "splitEnabled": true
                }
            ],
            "entriesLimit": 4,
            "entriesCount": 2,
            "available": true,
            "created": 1584702214,
            "updated": 1584702214
        },
        "created": 1584702212,
        "updated": 1584702212
    }
}

Error codes

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