日志服务获取日志主题列表-API 文档-文档中心-腾讯云

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": {
        "Topics": [
            {
                "LogsetId": "46c34030-f7fd-xxxx-91ee-053215c2bf9c",
                "TopicId": "305f8be8-25a9-xxxx-8f05-361dafab39fe",
                "TopicName": "test",
                "PartitionCount": 1,
                "Index": true,
                "AssumerName": "",
                "SubAssumerName": "",
                "CreateTime": "2022-12-30 16:02:52",
                "Status": true,
                "Tags": [],
                "AutoSplit": true,
                "MaxSplitPartitions": 50,
                "StorageType": "hot",
                "Period": 27,
                "Describes": "",
                "HotPeriod": 0,
                "BizType": 0,
                "IsWebTracking": false,
                "Extends": {
                    "AnonymousAccess": null
                }
            }
        ],
        "RequestId": "cdb48d76-9be0-xxxx-8654-56290de7442e",
        "TotalCount": 1
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

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	操作不支持。