tencent cloud

APIs

DescribeCategoryList

Baixar
Modo Foco
Tamanho da Fonte
Última atualização: 2026-11-04 21:50:01

1. API Description

Domain name for API request: adp.intl.tencentcloudapi.com.

Query the classification list

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeCategoryList.
Version Yes String Common Params. The value used for this API: 2026-05-20.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
KbId Yes String

Associated knowledge base ID

FilterList.N No Array of Filter

Filter criteria (multiple Filters are in an AND relationship, and multiple Values of the same Filter are in an OR relationship): CategoryType - classification type, enumeration value, exact match (CATEGORY_TYPE_DOC=1/CATEGORY_TYPE_QA=2); ParentCategoryId - parent category ID, exact match

PageNumber No Integer

Pagination page number, starting from 0

PageSize No Integer

Number of items per page. Default: 10. Maximum: 100

Query No String

Keyword search

SummaryListSwitch No SummaryListSwitch

Switch configuration

3. Output Parameters

Parameter Name Type Description
CategoryList Array of KBCategory

Classification list

TotalCount Integer

Total.

RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Query the classification list

Query the classification list

Input Example

POST / HTTP/1.1
Host: adp.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCategoryList
<Common request parameters>

{
    "KbId": "2082355981171975296",
    "FilterList": [
        {
            "Name": "CategoryType",
            "Operator": 0,
            "ValueList": [
                "1"
            ]
        }
    ],
    "PageNumber": 0,
    "PageSize": 20
}

Output Example

{
    "Response": {
        "CategoryList": [
            {
                "CanAdd": false,
                "CanDelete": false,
                "CanEdit": false,
                "CategoryId": "2082355982908901632",
                "ChildList": [],
                "ItemCount": 0,
                "Name": "Unclassified"
            }
        ],
        "RequestId": "b8e226f9-8a05-4b6a-b901-9ce41fedc989"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Ajuda e Suporte

Esta página foi útil?

comentários