DescribeTopics

调用 DescribeTopics 接口获取日志项目的所有日志主题信息。

使用说明

此接口用于查看指定日志项目下的日志主题列表。支持分页查询、按偏移量查询、按日志主题名称和 ID 模糊查询。
此接口的调用频率限制为 20 次/s，超出频率限制会报错 ExceedQPSLimit。

请求说明

• 请求方式：GET
• 请求地址：https://tls-{Region}.ivolces.com/DescribeTopics

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

DescribeResp

Tag

请求示例

GET https://tls-{Region}.ivolces.com/DescribeTopics?ProjectId=662***&PageNumber=1&PageSize=10&TopicName=tes&IsFullName=false&Tags=[{"Key":"key1","Value":"value1"}] HTTP/1.1

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
...
{
    "Total": 2,
    "Topics": [
        {
            "TopicName": "test****",
            "ProjectId": "c7e0****",
            "ProjectName": "test****",
            "TopicId": "b80f****",
            "Ttl": 1023,
            "CreateTime": "2023-12-19 11:41:29",
            "ModifyTime": "2023-12-19 11:41:32",
            "ShardCount": 2,
            "Description": "test that this is a test s",
            "AutoSplit":true,
            "MaxSplitShard":10,
            "EnableTracking":false，
            "TimeKey": "request_time",
            "TimeFormat": "%Y-%m-%dT%H:%M:%S,%f"，
            "LogPublicIP": false,
            "Tags":[
                {
                    "Key":"key1",
                    "Value":"value1"
                }
            ]
        },
        {
            "TopicName": "test17-2",
            "ProjectId": "c7e0*********",
            "ProjectName": "test****",
            "TopicId": "bcb2*********",
            "Ttl": 1023,
            "CreateTime": "2021-08-19 10:43:13",
            "ModifyTime": "2021-08-19 10:43:16",
            "ShardCount": 2,
            "Description": "test that this is a test s",
            "AutoSplit":true,
            "MaxSplitShard":10,
            "EnableTracking":false，
            "TimeKey": "request_time",
            "TimeFormat": "%Y-%m-%dT%H:%M:%S,%f"，
            "Tags":[
                {
                    "Key":"key1",
                    "Value":"value1"
                }
            ]
        }
    ]
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。