日志服务
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 日志服务 > API 文档 > 主题管理相关接口 > 获取日志主题列表

获取日志主题列表

最近更新时间：2024-03-12 01:18:14

我的收藏

本页目录：

1. 接口描述

接口请求域名： cls.tencentcloudapi.com 。

本接口用于获取日志主题列表，支持分页

默认接口请求频率限制：50次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeTopics。
Version 是 String 公共参数，本接口取值：2020-10-16。
Region 是 String 公共参数，详见产品支持的 地域列表。
Filters.N 否 Array of Filter
  • topicName按照【日志主题名称】进行过滤，默认为模糊匹配，可使用PreciseSearch参数设置为精确匹配。类型：String必选：否
  • logsetName按照【日志集名称】进行过滤，默认为模糊匹配，可使用PreciseSearch参数设置为精确匹配。类型：String必选：否
  • topicId按照【日志主题ID】进行过滤。类型：String必选：否
  • logsetId按照【日志集ID】进行过滤，可通过调用DescribeLogsets查询已创建的日志集列表或登录控制台进行查看；也可以调用CreateLogset创建新的日志集。类型：String必选：否
  • tagKey按照【标签键】进行过滤。类型：String必选：否
  • tag:tagKey按照【标签键值对】进行过滤。tagKey使用具体的标签键进行替换，例如tag:exampleKey。类型：String必选：否
  • storageType按照【日志主题的存储类型】进行过滤。可选值 hot（标准存储），cold（低频存储）类型：String必选：否每次请求的Filters的上限为10，Filter.Values的上限为100。
    		•
    Offset 否 Integer 分页的偏移量，默认值为0。
    示例值：10
    Limit 否 Integer 分页单页限制数目，默认值为20，最大值100。
    示例值：30
    PreciseSearch 否 Integer 控制Filters相关字段是否为精确匹配。
    - 0: 默认值，topicName和logsetName模糊匹配
    - 1: topicName精确匹配
    - 2: logsetName精确匹配
    - 3: topicName和logsetName都精确匹配
    示例值：1
    BizType 否 Integer 主题类型
    - 0:日志主题，默认值
    - 1:指标主题

    3. 输出参数

    参数名称 类型 描述
    Topics Array of TopicInfo 日志主题列表
    TotalCount Integer 总数目
    示例值：1
    RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 获取日志主题列表

    获取日志主题列表

    输入示例

    POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTopics
<公共请求参数>

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

    输出示例

    {
    "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. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

    错误码 描述
    FailedOperation 操作失败。
    FailedOperation.TagQpsLimit 请求标签服务限频。
    InternalError 内部错误。
    InvalidParameter 参数错误。
    InvalidParameterValue 参数取值错误。
    MissingParameter 缺少参数错误。
    OperationDenied 操作被拒绝。
    OperationDenied.ACLFailed ACL校验失败。
    OperationDenied.AccountDestroy 账户已销毁。
    OperationDenied.AccountIsolate 账户欠费。
    OperationDenied.AccountNotExists 账户不存在。
    OperationDenied.AnalysisSwitchClose 字段没有开启分析功能。
    ResourceNotFound.LogsetNotExist 指定的日志集不存在。
    ResourceNotFound.TopicNotExist 日志主题不存在。
    UnsupportedOperation 操作不支持。
    中国站