You need to enable JavaScript to run this app.
文档中心
日志服务

日志服务

复制全文
下载 pdf
Trace 存储
CreateTraceInstance
复制全文
下载 pdf
CreateTraceInstance
调用 CreateTraceInstance 接口创建 Trace 实例。​
请求说明​
  • 请求方式:POST​
  • 请求地址:https://{tls-endpoint}/CreateTraceInstance​
请求参数​
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Body​
​
参数​
类型​
是否必选​
示例值​
描述​
TraceInstanceName​
String​
是​
test-trace​
Trace 实例名称。​
实例名称不可重复,只能包括小写字母、数字、中文和短划线(-)。必须以小写字母、中文或者数字开头和结尾,长度为3~30字符。​
ProjectId​
String​
是​
c7e0e442-19bf-4fb3-b547-5992fb8b****​
Trace 实例所属的日志项目 ID。​
Description​
String​
否​
This is a test trace ins.​
Trace 实例的描述信息。不支持使用 <>、'、\ 和 \\字符,长度限制为 0 到 64 个字符。​
BackendConfig​
Object of BackendConfig​
否​
{"Ttl":97,"EnableHotTtl":true,"HotTtl":7,"ColdTtl":30,"ArchiveTtl":60,"AutoSplit":true,"MaxSplitPartitions":10}​
Trace 实例的后端配置,用于设置日志存储的分层策略、自动分裂功能等。​
​
BackendConfig​
​
参数​
类型​
是否必选​
示例值​
描述​
Ttl​
Integer​
否​
97​
日志在日志服务中的总保存时间,超过指定的日志存储时长后,此日志主题中的过期日志会被自动清除。 单位为天,默认为 30 天。取值范围为 1~3650,指定为 3650 天表示永久存储。​
说明​
设置 EnableHotTtl为 true 后,Ttl 时长需与 HotTtl、ColdTtl 和 ArchiveTtl 总值相同。​
EnableHotTtl​
Boolean​
否​
true​
是否开启分层存储。开启后,日志服务支持标准存储、低频存储和归档存储。​
设置 HotTtl、ArchiveTtl、ColdTtl 后,如果数据存储时间超过对应时长,那么数据会自动沉降至低频存储、归档存储进行后续保存,直到日志采集到服务端的总时长达到 Ttl 时,被后端服务自动清理。​
说明​
Ttl 时长需与 HotTtl、ColdTtl 和 ArchiveTtl 总值相同。​
HotTtl​
Integer​
否​
7​
标准存储时长。该时长默认为 30 天,取值范围为 7~3650。​
此参数仅在 EnableHotTtl 为 true 时生效。​
ColdTtl​
Integer​
否​
30​
低频存储时长。该时长取值范围为 30~3650。​
标准存储时长 7 天及以上可实现低频存储。​
此参数仅在 EnableHotTtl 为 true 时生效。​
ArchiveTtl​
Integer​
否​
60​
归档存储时长。该时长取值范围为 60~3650。​
满足如下任一条件时,可实现归档存储。​
  • 标准存储时长 30 天及以上。​
  • 标准存储时长 7 天及以上且低频存储时长 30 天及以上。​
此参数仅在 EnableHotTtl 为 true 时生效。​
AutoSplit​
Boolean​
否​
true​
是否开启分区的自动分裂功能。​
开启后,当写入的数据量连续 5 分钟超过已有分区服务能力时,日志服务会根据数据量自动分裂分区以满足业务需求,但分裂后的分区数量不可超出最大分裂数。最近 15 分钟内分裂出来的新分区不会自动分裂。​
  • true:开启。​
  • false:关闭。​
MaxSplitPartitions​
Integer​
否​
10​
Shard 的最大分裂个数。​
​
返回参数​
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。​
​
参数​
类型​
示例值​
描述​
TraceInstanceId​
String​
0fdaa6b6-3c9f-424c-8664-fc0d222c****​
Trace 实例 ID。​
​
请求示例​
​
POST https://{tls-endpoint}/CreateTraceInstance HTTP/1.1​
Content-Type: application/json​
{​
"TraceInstanceName": "test-trace",​
"ProjectId": "c7e0e442-19bf-4fb3-b547-5992fb8b****",​
"Description": "This is a test trace ins.",​
"BackendConfig": {​
"Ttl": 97,​
"EnableHotTtl": true,​
"HotTtl": 7,​
"ColdTtl": 30,​
"ArchiveTtl": 60,​
"AutoSplit": true,​
"MaxSplitPartitions": 10​
}​
}​
​
返回示例​
​
Content-Type: application/json; charset=utf-8​
{​
"TraceInstanceId": "0fdaa6b6-3c9f-424c-8664-fc0d222c****"​
}​
​
错误码​
您可访问公共错误码,获取更多错误码信息。​
最近更新时间:2025.12.23 17:35:13
这个页面对您有帮助吗?
有用
有用
无用
无用