You need to enable JavaScript to run this app.
导航

DescribeTopic

最近更新时间2023.11.16 11:44:06

首次发布时间2022.05.11 11:26:47

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

使用说明

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

URI

请求方法
GET

URI

https://tls-{Region}.ivolces.com/DescribeTopic

传输协议

HTTPS

URI请求参数

参数
参数类型
是否必选
示例值

说明

TopicId

String

c7**********

日志主题ID。

响应参数

参数
类型
示例值
描述

TopicName

String

test-project

日志主题名称。

ProjectId

String

f**********

日志主题所属的日志项目 ID。

TopicId

String

faf**********

日志主题 ID。

Ttl

Integer

3650

日志主题的数据保存时间,单位为天。

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

10

分区的最大分裂数。

EnableTracking

Boolean

false

是否开启了 WebTracking 功能。

  • true:已开启
  • false:已关闭

TimeKey

String

request_time

日志时间字段的字段名称。

TimeFormat

String

%Y-%m-%dT%H:%M:%S,%f

时间字段的解析格式。

Tags

Array of TagInfo

[{"Key":"key1",
"Value":"value1"}]

日志主题标签信息,详细信息请参考TagInfo
标签用于云资源的标识与分类,您可以将日志项目、日志主题通过标签进行归类,便于资源的搜索和资源聚合。详细说明请参考标签管理

LogPublicIP

Boolean

false

是否开启了记录外网 IP 功能。

  • true:已开启
  • false:已关闭

EnableHotTtl

Boolean

true

是否开启低频存储。开启后,标准存储的数据在标准存储保存一段时间之后自动转化为低频存储类型。未开启则不返回此字段。

说明

低频存储为邀测功能,若有相关业务需求,可联系客户经理开通白名单。

HotTtl

Integer

7

此参数用于在开启低频存储后,设置数据在标准存储的保留时长,超过该时长后,数据会自动沉降至低频存储进行后续保存,直到日志采集到服务端的总时长达到日志存储时长时,被后端服务自动清理。
此参数仅在 EnableHotTtl 为 true 时返回。

示例

请求示例

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":10,
    "EnableTracking":false,
    "TimeKey": "request_time",
    "TimeFormat": "%Y-%m-%dT%H:%M:%S,%f",
    "LogPublicIP": false,
    "Tags":[
        {
            "Key":"key1",
            "Value":"value1"
        }
    ]
}

错误码

错误码(Code)
HTTP 状态码
错误信息(Message)
说明

InvalidArgument

400

Invalid argument key %s, value %s, please check argument.

参数不合法。

TopicNotExist

404

topic %s does not exist.

日志主题不存在。

InternalServerError

500

We encountered an unexpected server error, please try again later.

服务器内部错误。

更多信息,请参考通用错误码