调用 DescribeTopics 接口获取日志项目的所有日志主题信息。
此接口用于查看指定日志项目下的日志主题列表。支持分页查询、按偏移量查询、按日志主题名称和 ID 模糊查询。
此接口的调用频率限制为 20 次/s,超出频率限制会报错 ExceedQPSLimit。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
PageNumber | Integer | 否 | 1 | 分页查询时的页码。默认为 1,即从第一页数据开始返回。 |
PageSize | Integer | 否 | 10 | 分页大小。默认为 20,最大为 100。 |
TopicName | String | 否 | test | 日志主题名称,支持模糊匹配。 |
TopicId | String | 否 | 77 | 日志主题 ID,支持模糊匹配。 |
ProjectId | String | 否 | 6622a14b-770f-4171-a385-3b68486f**** | 日志项目 ID,支持模糊匹配。 |
ProjectName | String | 否 | test-tls | 日志项目名称,支持模糊匹配。 |
Tags | String | 否 | [{\"key\":\"key2\",\"Value\":\"value1\"}] | 根据日志主题标签进行筛选。支持的筛选方式请参考根据标签筛选资源。 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Total | Integer | 2 | 日志主题数量。 |
Topics | Array of DescribeResp | 日志主题列表。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Ttl | Integer |
| 日志在日志服务中的总保存时间,超过指定的日志存储时长后,此日志主题中的过期日志会被自动清除。 单位为天,默认为 30 天。取值范围为 1~3650,指定为 3650 天表示永久存储。 说明 设置 |
Tags | Array of Tag |
| 日志项目标签信息。 |
HotTtl | Integer |
| 标准存储时长。该时长默认为 30 天,取值范围为 7~3650。 |
TopicId | String | faf6d529-e75e-457f-a23a-9c4203a6dff3 | 日志主题 ID。 |
AutoSplit | Boolean |
| 是否开启分区的自动分裂功能。
|
ProjectId | String | f********** | 日志主题所属的日志项目 ID。 |
TopicName | String | test-project | 日志主题名称。 |
CreateTime | String | 2021-08-19 11:41:29 | 日志主题创建时间。 |
ModifyTime | String | 2021-08-19 11:41:32 | 日志主题修改时间。 |
ShardCount | Integer | 2 | 日志主题 Shard 个数。 |
Description | String | This is a test topic | 日志主题的描述。 |
LogPublicIP | Boolean |
| 是否开启了记录外网 IP 功能。
|
EnableHotTtl | Boolean |
| 是否开启分层存储。开启后,日志服务支持标准存储、低频存储和归档存储。 说明
|
MaxSplitShard | Integer | 50 | 分区的最大分裂数,即分区分裂后,所有分区的最大数量。 |
EnableTracking | Boolean |
| 是否开启了 WebTracking 功能,开启后,可以通过 WebTracking 快速采集前端埋点数据。
|
ColdTtl | Integer |
| 低频存储时长。该时长取值范围为 30~3650。 |
ArchiveTtl | Integer |
| 归档存储时长。该时长取值范围为 60~3650。
|
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Key | String | owner | 标签 Key 的值。设置规则请参考标签设置规则。 |
Value | String | zhangsan | 标签 Value 的值。设置规则请参考标签设置规则。 |
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":50, "EnableTracking":false, "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":50, "EnableTracking":false, "Tags":[ { "Key":"key1", "Value":"value1" } ] } ] }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
HTTP 状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
400 | InvalidArgument | Invalid argument key %s, value %s, please check argument. | 参数不合法。 |
404 | TopicNotExist | topic %s does not exist. | 日志主题不存在。 |
500 | InternalServerError | We encountered an unexpected server error, please try again later. | 服务器内部错误。 |