1. 接口描述
接口请求域名： cls.api3.fincloud.tencent.cn。
本接口用于获取日志主题列表，支持分页
默认接口请求频率限制：20次/秒。
接口更新时间：2025-01-15 02:44:13。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeTopics |
| Version | 是 | 否 | String | 公共参数，本接口取值：2020-10-16 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| Filters | 否 | 否 | 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 | 否 | 否 | Int64 | 分页的偏移量，默认值为0。 示例值： 10 |
| Limit | 否 | 否 | Int64 | 分页单页限制数目，默认值为20，最大值100。 示例值： 30 |
| PreciseSearch | 否 | 否 | Uint64 | 控制Filters相关字段是否为精确匹配。 0: 默认值，topicName 和 logsetName 模糊匹配 1: topicName 精确匹配 2: logsetName精确匹配 3: topicName 和logsetName 都精确匹配 示例值： 1 |
| BizType | 否 | 否 | Uint64 | 主题类型 0:日志主题，默认值 1:指标主题 示例值： 0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Topics | Array of TopicInfo | 日志主题列表 示例值：查看 |
| TotalCount | Int64 | 总数目 示例值： 1 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |
| InternalError | 内部错误。 |
| FailedOperation | 操作失败。 |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.ACLFailed | ACL校验失败。 |
| OperationDenied.AnalysisSwitchClose | 字段没有开启分析功能。 |
| OperationDenied.AccountIsolate | 账户欠费。 |
| OperationDenied.AccountDestroy | 账户已销毁。 |
| OperationDenied.AccountNotExists | 账户不存在。 |