Call the ModifyTraceInstance API to update Trace instance information.

Request instructions

Request method: PUT

Request URL: https://{tls-endpoint}/ModifyTraceInstance

Request parameters

The table below lists unique request parameters for this API and several common parameters. For more details, see Common parameters.

Body

Parameters	Type	Required	Example value	Description
TraceInstanceId	String	Yes	0fdaa6b6-3c9f-424c-8664-fc0d222c****	Trace instance ID.
Description	String	No	This is a test trace ins.	Description of the trace instance Characters <>, ', \, and \\ are not supported. The length must be between 0 and 64 characters.
BackendConfig	Object of BackendConfig	No	{"Ttl":97,"EnableHotTtl":true,"HotTtl":7,"ColdTtl":30,"ArchiveTtl":60,"AutoSplit":true,"MaxSplitPartitions":10}	Backend configuration for Trace instances, used to set log storage tiering strategy, auto split, and more.

BackendConfig

Parameters	Type	Required	Example value	Description
Ttl	Integer	No	97	The total time logs are retained in TLS. Expired logs in the topic will be automatically deleted after the specified log storage period. The unit is days. The default value is 30 days. The value ranges from 1 to 3650. If it is set to 3650, the storage time becomes permanent storage. tip If you set EnableHotTtl to true, the Ttl duration must be the same as the total value of HotTtl, ColdTtl, and ArchiveTtl.
EnableHotTtl	Boolean	No	true	Enable tiered storage. When enabled, TLS supports standard, infrequent, and archive storage. After setting HotTtl, ArchiveTtl, and ColdTtl, if data is stored beyond the specified duration, it is automatically moved to infrequent or archive storage for preservation, until the total log storage period reaches Ttl and is then deleted by backend services. tip The Ttl duration must equal the total of HotTtl, ColdTtl, and ArchiveTtl.
HotTtl	Integer	No	7	Standard storage duration The default duration is 30 days, with a range of 7–3650 days This parameter takes effect only when EnableHotTtl is set to true
ColdTtl	Integer	No	30	Low-frequency storage duration. The range for this duration is 30–3650. Low-frequency storage is available for standard storage durations of 7 days or longer. This parameter only applies when EnableHotTtl is set to true.
ArchiveTtl	Integer	No	60	Archive storage duration. The valid range is 60–3650. Archive storage is available when any of the following conditions are met. Standard storage period of 30 days or longer. Standard storage period of 7 days or longer and IAS storage period of 30 days or longer. This parameter takes effect only when EnableHotTtl is set to true.
AutoSplit	Boolean	No	true	Automatic sharding can be enabled or disabled. When enabled, if the amount of data written exceeds the capacity of an existing shard for five consecutive minutes, TLS automatically splits shards based on data volume to meet business needs. However, the number of shards cannot exceed the maximum split limit. New shard created within the last 15 minutes will not split automatically. true: enabled. false: disabled.
MaxSplitPartitions	Integer	No	10	Maximum number of shard splits

Return parameters

This API does not have specific return parameters. For more information, see return structure.

Sample request

Sample response

Error Code

You can visit Common Error Codes for more details about error codes.

Torch Log Service