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

文档中心

立即注册

导航

ModifyTopic

最近更新时间：2024.05.30 14:50:10首次发布时间：2022.05.11 11:26:47

调用 ModifyTopic 接口修改日志主题信息。

使用说明

此接口用于修改日志主题名称、日志保存时长和主题描述信息，不支持修改日志主题 ID。调用频率限制为 20 次/s，超出频率限制会报错 ExceedQPSLimit。

请求说明

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

请求参数

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

Body

参数	类型	是否必选	示例值	描述
TopicId	String	是	`0***********`	日志主题 ID。
TopicName	String	否	`test-topic`	日志主题名称。命名规则请参考资源命名规则。
Ttl	Integer	否	`1300`	日志在日志服务中的保存时间，超过指定的日志存储时长后，此日志主题中的过期日志会被自动清除。单位为天，默认为 30 天。取值范围为 1～3650，指定为 3650 天表示永久存储。
AutoSplit	Boolean	否	`true`	是否开启分区的自动分裂功能。 true：当写入的数据量连续 5 分钟超过已有分区服务能力时，日志服务会根据数据量自动分裂分区以满足业务需求，但分裂后的分区数量不可超出最大分裂数。最近15分钟内分裂出来的新分区不会自动分裂。 false：不开启分区的自动分裂。
MaxSplitShard	Integer	否	`10`	分区的最大分裂数，即分区分裂后，所有分区的最大数量。取值范围为 1~50，默认为 50。说明仅在开启自动分裂日志分区，即 AutoSplit 为 true 时必选。 MaxSplitShard 必须大于当前 Shard 数量，否则日志服务无法自动分裂分区。
EnableTracking	Boolean	否	`false`	是否开启 WebTracking 功能，开启后，可以通过 WebTracking 快速采集前端埋点数据。 true：开启 WebTracking 功能。 false：关闭 WebTracking 功能。说明为日志主题开启 Web Tracking 后，通过 API 接口 WebTracks 写入数据时无需经过鉴权，相当于面向公网开放了匿名写入权限，可能产生脏数据。详细说明请参考通过 WebTracking 采集日志。
Description	String	否	`This is a test topic.`	日志主题描述信息。不支持 `<>`、`'`、`\`、`\\`、所有 emoji 表情符号。长度为 0~64 个字符。
LogPublicIP	Boolean	否	`false`	是否开启记录外网 IP 功能。默认为开启状态。开启后日志服务会自动在日志内容中添加以下元数据字段。 `__tag____client_ip__`：日志来源设备的公网 IP 地址。使用日志服务的私网域名写入日志数据时，则记录私网 IP 地址。 `__tag____receive_time__`：日志达到服务端的时间，格式为 10 位的 Unixtime 时间戳。
EnableHotTtl	Boolean	否	`false`	是否开启低频存储。开启后，标准存储的数据在标准存储保存一段时间之后自动转化为低频存储类型。说明低频存储为邀测功能，若有相关业务需求，可联系客户经理开通白名单。
HotTtl	Integer	否	`7`	此参数用于在开启低频存储后，设置数据在标准存储的保留时长，超过该时长后，数据会自动沉降至低频存储进行后续保存，直到日志采集到服务端的总时长达到日志存储时长时，被后端服务自动清理。该时长默认为 30 天，取值范围为 7~3650，且不可大于 Ttl。此参数仅在 EnableHotTtl 为 true 时生效。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

PUT https://tls-{Region}.ivolces.com/ModifyTopic HTTP/1.1
Content-Type: application/json
{
    "TopicId": "66********",
    "TopicName": "test-topic",
    "Ttl": 30,
    "Description": "xxxxxx",
    "AutoSplit": true,
    "MaxSplitShard": 10,
    "EnableTracking": false
}

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8 
{}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HTTP 状态码	错误码	错误信息	说明
400	InvalidArgument	Invalid argument key %s, value %s, please check argument.	参数不合法。
404	TopicNotExist	topic %s does not exist.	日志主题不存在。
409	TopicAlreadyExist	Topic %s already exist	日志主题已存在。
500	InternalServerError	We encountered an unexpected server error, please try again later.	服务器内部错误。