文档中心

日志服务

Trace 存储

DescribeTraceInstances

DescribeTraceInstances

调用 DescribeTraceInstances 接口获取 Trace 实例列表。

支持分页查询、按偏移量查询、按 Trace 实例名称和 TraceID 模糊查询。

请求说明

请求方式：GET

请求地址：https://{tls-endpoint}/DescribeTraceInstances

请求参数

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

Query

参数	类型	是否必选	示例值	描述
PageNumber	Integer	否	1	分页查询的页码，默认从 1开始。
PageSize	Integer	否	20	分页大小限制，表示每页返回的 Trace 实例数量，默认值为 20，最大值为 100。
TraceInstanceName	String	否	test-trace	Trace 实例名称，与 TraceInstanceId互斥，只能提供其中一个参数。
TraceInstanceId	String	否	0fdaa6b6-3c9f-424c-8664-fc0d222c****	Trace实例ID，与 TraceInstanceName互斥，只能提供其中一个参数。
ProjectId	String	否	c7e0e442-19bf-4fb3-b547-5992fb8b****	Trace 实例所属的日志项目 ID。
ProjectName	String	否	my-log-project	日志项目的名称，用于标识 Trace实例所属的日志项目。
Status	String	否	CREATED	Trace 实例的状态。
IamProjectName	String	否	my-iam-log-project	IAM 日志项目的名称，用于标识 Trace实例所属的 IAM 日志项目。
CsAccountChannel	String	否	web	CS 账号渠道标识，用于区分不同的账号来源或渠道。

返回参数

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

参数	类型	示例值	描述
Total	Integer	100	符合条件的 Trace实例总数，用于分页查询时计算总页数。
TraceInstances	Array of DescribeResp	-	返回符合条件的 Trace实例列表，每个实例包含项目 ID、创建时间、修改时间、描述、项目名称等信息。

DescribeResp

参数	类型	示例值	描述
ProjectId	String	c7e0e442-19bf-4fb3-b547-5992fb8b****	Trace 实例所属的日志项目 ID。
CreateTime	String	2023-01-15T10:30:00Z	Trace实例的创建时间，表示该实例在系统中的创建时间点。
ModifyTime	String	2023-01-15T14:45:00Z	Trace实例的最后修改时间，表示该实例在系统中的最近更新时间点。
Description	String	This is a test trace ins.	Trace 实例的描述信息。
ProjectName	String	my-log-project	日志项目的名称，用于标识 Trace实例所属的日志项目。
TraceTopicId	String	ca0c7da2-313e-4729-a66f-85f40380****	Trace实例关联的日志主题 ID，用于标识该实例对应的日志主题。
BackendConfig	Object of BackendConfig	{"Ttl":97,"EnableHotTtl":true,"HotTtl":7,"ColdTtl":30,"ArchiveTtl":60,"AutoSplit":true,"MaxSplitPartitions":10}	Trace 实例的后端配置，用于设置日志存储的分层策略、自动分裂功能等。
TraceTopicName	String	my-trace-topic	Trace实例关联的日志主题名称，用于标识该实例对应的日志主题。
TraceInstanceId	String	0fdaa6b6-3c9f-424c-8664-fc0d222c****	Trace 实例 ID。
CsAccountChannel	String	cs-channel-1234567890ab****	Trace实例的客户服务账号渠道，用于标识该实例所属的客户服务账号渠道。
DependencyTopicId	String	c1c28228-627a-476b-98b4-2914225d****	Trace实例依赖的日志主题 ID，用于标识该实例所依赖的其他日志主题。
TraceInstanceName	String	my-trace-instance	Trace实例的名称。
TraceInstanceStatus	String	CREATED	Trace 实例的状态。
DependencyTopicTopicName	String	dependency-topic-name	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 的最大分裂个数。

请求示例

返回示例

错误码

您可访问公共错误码，获取更多错误码信息。

最近更新时间：2025.12.23 17:35:13

这个页面对您有帮助吗？

有用

有用

无用

无用