tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeTopics

Last updated: 2024-11-27 11:09:58

    1. API Description

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

    This API is used to get the list of log topics and supports pagination.

    A maximum of 50 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: DescribeTopics.
    Version Yes String Common Params. The value used for this API: 2020-10-16.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-mumbai, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
    Filters.N No Array of Filter
  • topicName: Filter by log topic name. Fuzzy match is implemented by default. You can use the PreciseSearch parameter to set exact match. Type: String. Required. No.
  • logsetName: Filter by logset name. Fuzzy match is implemented by default. You can use the PreciseSearch parameter to set exact match. Type: String. Required: No.
  • topicId: Filter by log topic ID. Type: String. Required: No.
  • logsetId: Filter by logset ID. You can call DescribeLogsets to query the list of created logsets or log in to the console to view them. You can also call CreateLogset to create a logset. Type: String. Required: No.
  • tagKey: Filter by tag key. Type: String. Required: No.
  • tag:tagKey: Filter by tag key-value pair. The tagKey should be replaced with a specified tag key, such as tag:exampleKey. Type: String. Required: No.
  • storageType: Filter by log topic storage type. Valid values: hot (standard storage) and cold (IA storage). Type: String. Required: No. Each request can have up to 10 Filters and 100 Filter.Values.
    		•
    Offset No Integer Page offset. Default value: 0.
    Limit No Integer Maximum number of entries per page. Default value: 20. Maximum value: 100.
    PreciseSearch No Integer Match mode for Filters fields.
    - 0: Fuzzy match for topicName and logsetName. This is the default value.
    - 1: Exact match for topicName.
    - 2: Exact match for logsetName.
    - 3: Exact match for topicName and logsetName.
    BizType No Integer Topic type
    - 0 (default): Log topic.
    - 1: Metric topic.

    3. Output Parameters

    Parameter Name Type Description
    Topics Array of TopicInfo Log topic list
    TotalCount Integer Total number
    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 Getting the List of Log Topics

    This example shows you how to get the list of log topics.

    Input Example

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

{
    "Filters": [],
    "Offset": 10,
    "Limit": 30
}

    Output Example

    {
    "Response": {
        "TotalCount": 1,
        "Topics": [
            {
                "Index": true,
                "PartitionCount": 1,
                "Describes": "x1",
                "Status": true,
                "Tags": [
                    {
                        "Value": "x10",
                        "Key": "x11"
                    }
                ],
                "AssumerName": "x12",
                "SubAssumerName": "x13",
                "MaxSplitPartitions": 0,
                "LogsetId": "x15",
                "TopicId": "x16",
                "HotPeriod": 1,
                "StorageType": "x17",
                "Period": 0,
                "AutoSplit": true,
                "CreateTime": "x18",
                "TopicName": "x19"
            }
        ],
        "RequestId": "x20"
    }
}

    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

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    FailedOperation Operation failed.
    FailedOperation.TagQpsLimit The frequency of tag service requests is limited.
    InternalError Internal error.
    InvalidParameter Incorrect parameter.
    InvalidParameterValue Incorrect parameter value.
    MissingParameter Missing parameter.
    OperationDenied Operation denied.
    OperationDenied.ACLFailed ACL verification failed.
    OperationDenied.AccountDestroy The account has been terminated.
    OperationDenied.AccountIsolate The account has overdue payments.
    OperationDenied.AccountNotExists The account does not exist.
    OperationDenied.AnalysisSwitchClose The analysis feature is not enabled for the field.
    ResourceNotFound.LogsetNotExist The specified logset does not exist.
    ResourceNotFound.TopicNotExist The log topic does not exist.
    UnsupportedOperation Unsupported operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy