DescribeTopics

Last updated: 2021-11-30 16:26:20

1. API Description

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

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

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 parameter. The value used for this API: DescribeTopics.
Version Yes String Common parameter. The value used for this API: 2020-10-16.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
Filters.N No Array of Filter
  • topicName

    Filter by log topic name.
    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 tag-key should be replaced with a specified tag key. For more information on how to use it, please see sample 2.

    Type: String

    Required: no


  • storageType

    Filter by log topic storage class. Valid values: hot: real-time storage; cold: offline storage.
    Type: String

    Required: no


    Each request can contain 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.

    3. Output Parameters

    Parameter Name Type Description
    Topics Array of TopicInfo Log topic list
    TotalCount Integer Total number
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Getting the list of log topics

    Input Example

    POST / HTTP/1.1
    Host: cls.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeTopics
    <Common request parameters>
    
    {
        "Filters": [],
        "Offset": 10,
        "Limit": 30
    }
    

    Output Example

    {
      "Response": {
        "TotalCount": 1,
        "Topics": [
          {
            "Status": true,
            "TopicId": "xx",
            "Tags": [
              {
                "Value": "xx",
                "Key": "xx"
              }
            ],
            "StorageType": "xx",
            "PartitionCount": 1,
            "MaxSplitPartitions": 0,
            "Period": 0,
            "AutoSplit": true,
            "LogsetId": "xx",
            "Index": true,
            "CreateTime": "xx",
            "TopicName": "xx"
          }
        ],
        "RequestId": "xx"
      }
    }
    

    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.
    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.