DescribeTopic--日志服务-火山引擎

文档中心

立即注册

导航

DescribeTopic

最近更新时间：2024.12.05 11:09:50首次发布时间：2022.05.11 11:26:47

调用 DescribeTopic 接口获取日志主题基本信息。

使用说明

此接口的调用频率限制为 20 次/s，超出频率限制会报错 ExceedQPSLimit。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
TopicId	String	是	`c7e0e442-19bf-4fb3-b547-5992fb8b****`	日志主题 ID。

返回参数

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

参数	类型	示例值	描述
TopicName	String	`test-project`	日志主题名称。
ProjectId	String	`f**********`	日志主题所属的日志项目 ID。
TopicId	String	`faf**********`	日志主题 ID。
Ttl	Integer	`3650`	日志在日志服务中的总保存时间，超过指定的日志存储时长后，此日志主题中的过期日志会被自动清除。单位为天，默认为 30 天。取值范围为 1～3650，指定为 3650 天表示永久存储。说明设置 `EnableHotTtl` 为 true 后，Ttl 时长需与 HotTtl、ColdTtl 和 ArchiveTtl 总值相同。
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`	日志主题的描述。
AutoSplit	Boolean	`true`	是否开启分区的自动分裂功能。 true：已开启 false：已关闭
MaxSplitShard	Integer	`50`	分区的最大分裂数。
EnableTracking	Boolean	`false`	是否开启了 WebTracking 功能。 true：已开启 false：已关闭
Tags	Array of Tag	`[{"Key":"key1", "Value":"value1"}]`	日志主题标签信息。标签用于云资源的标识与分类，您可以将日志项目、日志主题通过标签进行归类，便于资源的搜索和资源聚合。详细说明请参考标签管理。
LogPublicIP	Boolean	`false`	是否开启了记录外网 IP 功能。 true：已开启 false：已关闭
EnableHotTtl	Boolean	`true`	是否开启分层存储。开启后，日志服务支持标准存储、低频存储和归档存储。设置 HotTtl、ArchiveTtl、ColdTtl 后，如果数据存储时间超过对应时长，那么数据会自动沉降至低频存储、归档存储进行后续保存，直到日志采集到服务端的总时长达到 Ttl 时，被后端服务自动清理。说明分层存储为邀测功能，若有相关业务需求，可联系客户经理开通白名单。 Ttl 时长需与 HotTtl、ColdTtl 和 ArchiveTtl 总值相同。
HotTtl	Integer	`7`	标准存储时长。该时长默认为 30 天，取值范围为 7~3650。此参数仅在 EnableHotTtl 为 true 时生效。
ColdTtl	Integer	`10`	低频存储时长。该时长取值范围为 30~3650。标准存储时长 7 天及以上可实现低频存储。此参数仅在 EnableHotTtl 为 true 时生效。
ArchiveTtl	Integer	`10`	归档存储时长。该时长取值范围为 60~3650。满足如下任一条件时，可实现归档存储。标准存储时长 30 天及以上。标准存储时长 7 天及以上且低频存储时长 30 天及以上。此参数仅在 EnableHotTtl 为 true 时生效。

Tag

参数	类型	示例值	描述
Key	String	`owner`	标签 Key 的值。设置规则请参考标签设置规则。
Value	String	`zhangsan`	标签 Value 的值。设置规则请参考标签设置规则。

请求示例

GET https://tls-{Region}.ivolces.com/DescribeTopic?TopicId=fa******** HTTP/1.1

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
    "TopicName": "test17-2",
    "ProjectId": "c7e***********",
    "TopicId": "bc***********",
    "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,
    "LogPublicIP": 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.	服务器内部错误。