Docs

Torch Log Service

API reference

API list

This topic provides a detailed list of all TLS APIs.

Log project management

API	Description
CreateProject	Call the CreateProject API to create a log project.
DeleteProject	Call the DeleteProject API to delete a log project.
ModifyProject	Call the ModifyProject API to modify a log project.
DescribeProject	Call the DescribeProject API to query information about a specified log project.
DescribeProjects	Call the DescribeProjects API to view information about all log projects.

Log topic management

API	Description
CreateTopic	Call the CreateTopic API to create a log topic.
DeleteTopic	Call the DeleteTopic API to delete a log topic.
ModifyTopic	Call the ModifyTopic API to modify log topic information.
DescribeTopic	Call the DescribeTopic API to obtain basic information about a specified log topic.
DescribeTopics	Call the DescribeTopics API to obtain information about all log topics in a log project.

Shard management

API	Description
DescribeShards	Call the DescribeShards API to obtain the shard list of a log topic.
ManualShardSplit	Call the ManualShardSplit API to manually split a specified shard.
ManualMergeShard	Call the ManualMergeShard to manually merge specified shards.

Index management

API	Description
CreateIndex	Call the CreateIndex API to create an index.
DeleteIndex	Call the DeleteIndex API to delete an index configuration.
ModifyIndex	Call the ModifyIndex API to modify an index configuration.
DescribeIndex	Call the DescribeIndex API to obtain index configuration information.

Log management

API	Description
PutLogs	Call the PutLogs API to upload logs to a specified log topic.
DescribeCursor	Call the DescribeCursor API to obtain the log download cursor.
ConsumeLogs	Call the ConsumeLogs API to consume logs.
SearchLogs	Call the SearchLogs API to search logs.
DescribeLogContext	Call the DescribeLogContext API to view the context information of a specified log.
DescribeHistogram(deprecated)	Call the DescribeHistogram API to search logs and view the time distribution of log data that meets the conditions.
DescribeHistogramV1	Call the DescribeHistogramV1 API to search logs and view the time distribution of log data that meets the conditions.
WebTracks	Call the WebTracks API to batch upload logs to a specified log topic.
CreateDownloadTask	Call the CreateDownloadTask API to create a log download task.
DescribeDownloadTasks	Call the DescribeDownloadTasks API to obtain the list of log download tasks in a specified log topic.
DescribeDownloadUrl	Call the DescribeDownloadUrl API to obtain the log download link for a specified task.
CancelDownloadTask	Call the CancelDownloadTask API to cancel a log download task.

Host group management

API	Note
CreateHostGroup	Call the CreateHostGroup API to create a host group.
DeleteHostGroup	Call the DeleteHostGroup API to delete a host group.
ModifyHostGroup	Call the ModifyHostGroup API to modify a host group.
DescribeHostGroups(Deprecated)	Call the DescribeHostGroups API to retrieve all host groups.
DescribeHostGroup(Deprecated)	Call the DescribeHostGroup API to view information about a specified host group.
DescribeHostGroupsV2	Call the DescribeHostGroupsV2 API to retrieve information about all host groups, excluding host group heartbeat information and the list of associated collection rules.
DescribeHostGroupV2	Call the DescribeHostGroupV2 API to retrieve information about a host group, excluding host group heartbeat information and the list of associated collection rules.
DescribeHosts	Call the DescribeHosts API to retrieve all hosts.
DeleteHost	Call the DeleteHost API to delete a host with a specified IP address from a host group.
DescribeHostGroupRules	Call the DescribeHostGroupRules API to retrieve the list of collection configurations already applied to a host group.
ModifyHostGroupsAutoUpdate	Call the ModifyHostGroupsAutoUpdate API to batch modify the LogCollector auto-upgrade configuration for host groups.
DeleteAbnormalHosts	Call the DeleteHost API to delete a host with a specified IP address from a host group.

Collection configuration management

API	Note
CreateRule	Call the CreateRule API to create a collection configuration.
DeleteRule	Call the DeleteRule API to delete a collection configuration.
ModifyRule	Call the ModifyRule API to modify a collection configuration.
DescribeRule(Deprecated)	Call the DescribeRule API to view information about a specified collection configuration.
DescribeRuleV2	Call the DescribeRuleV2 API to query details of a collection rule, excluding host group information.
DescribeRules	Call the DescribeRules API to view the list of collection configurations in a specified project.
ApplyRuleToHostGroups	Call the ApplyRuleToHostGroups API to bind a collection configuration to a list of host groups.
DeleteRuleFromHostGroups	Call the DeleteRuleFromHostGroups API to unbind a collection configuration from a list of host groups.
DescribeBoundHostGroups	Call the DescribeBoundHostGroups API to query the list of host groups bound to a collection rule.

Scheduled SQL analysis

API	Note
CreateScheduleSqlTask	Call the CreateScheduleSqlTask API to create a scheduled SQL analysis task.
ModifyScheduleSqlTask	Call the ModifyScheduleSqlTask API to modify a scheduled SQL analysis task.
DeleteScheduleSqlTask	Call the DeleteScheduleSqlTask API to delete a scheduled SQL analysis task.
DescribeScheduleSqlTask	Call the DescribeScheduleSqlTask API to view details of a specified scheduled SQL analysis task.
DescribeScheduleSqlTasks	Call the DescribeScheduleSqlTasks API to view details of all scheduled SQL analysis tasks in a specified region.

Data import

API	Note
CreateImportTask	Call the CreateImportTask API to create a data import task.
DeleteImportTask	Call the DeleteImportTask API to delete a specified data import task.
ModifyImportTask	Call the ModifyImportTask API to modify a specified data import task.
DescribeImportTask	Call the DescribeImportTask API to obtain information about a data import task.
DescribeImportTasks	Call the DescribeImportTasks API to obtain the list of data import tasks.

Data processor

API	Description
CreateProcessor	Call the CreateProcessor API to create a new data processor.
ModifyProcessor	Call the ModifyProcessor API to update configurations including the name, description and DSL content of a data processor.
BindTopicProcessor	Call the BindTopicProcessor API to bind a data processor to a specified log topic.
BatchBindTopics	Call the BatchBindTopics API to bind multiple log topics to a specified data processor in batches.
ExecProcessor	Call the ExecProcessor API to debug DSL rules of a data processor.
OperateProcessor	Call the OperateProcessor API to enable or suspend a specified data processor.
UnbindTopicProcessor	Call the UnbindTopicProcessor API to unbind the data processor associated with a specified log topic.
DeleteProcessor	Call the DeleteProcessor API to delete a specified data processor.
DescribeProcessor	Call the DescribeProcessor API to query detailed information of a specified data processor.
DescribeProcessors	Call the DescribeProcessors API to filter and query data processor information by log project, log topic and other conditions.
DescribeTopicsByProcessor	Call the DescribeTopicsByProcessor API to obtain the list of log topics bound to a data processor.
DescribeProcessorFunctions	Call the DescribeProcessorFunctions API to query all data processor functions.
DescribeProcessorByTopic	Call the DescribeProcessorByTopic API to obtain the data processor associated with a specified log topic.
DescribeProcessorBindings	Call the DescribeProcessorBindings API to obtain the association between log topics and data processors under a specified project.

Data transformation

API	Note
CreateETLTask	Call the CreateETLTask API to create an ETL task.
DeleteETLTask	Call the DeleteETLTask API to delete an ETL task.
ModifyETLTask	Call the ModifyETLTask API to modify a specified ETL task.
DescribeETLTask	Call the DescribeETLTask API to obtain detailed information about a specified ETL task.
DescribeETLTasks	Call the DescribeETLTasks API to obtain the list of ETL tasks.
ModifyETLTaskStatus	Call the ModifyETLTaskStatus API to modify the status of an ETL task.

Log shipping

API	Note
CreateShipper	Call the CreateShipper API to create a delivery configuration.
DeleteShipper	Call the DeleteShipper API to delete a specified delivery configuration.
ModifyShipper	Call the ModifyShipper API to modify a specified delivery configuration.
DescribeShipper	Call the DescribeShipper API to obtain detailed information about a delivery configuration.
DescribeShippers	Call the DescribeShippers API to obtain the list of delivery configurations.

Data backflow

API	Note
CreateLogBackFlowTask	Call the CreateLogBackFlowTask API to create a log re-ingestion task.
DeleteLogBackFlowTask	Call the DeleteLogBackFlowTask API to delete a log re-ingestion task.
DescribeLogBackFlowTasks	Call the DescribeLogBackFlowTasks API to query the list of log re-ingestion tasks.
ModifyLogBackFlowTask	Call the ModifyLogBackFlowTask API to modify a log re-ingestion task.

Alert management

API	Note
CreateAlarmNotifyGroup	Call the CreateAlarmNotifyGroup API to create an alarm group.
DeleteAlarmNotifyGroup	Call the DeleteAlarmNotifyGroup API to delete an alarm group.
ModifyAlarmNotifyGroup	Call the ModifyAlarmNotifyGroup API to modify an alarm group.
DescribeAlarmNotifyGroups	Call the DescribeAlarmNotifyGroups API to obtain the list of alarm groups.
CreateAlarm	Call the CreateAlarm API to create an alarm policy.
DeleteAlarm	Call the DeleteAlarm API to delete an alarm policy.
ModifyAlarm	Call the ModifyAlarm API to modify an alarm policy.
DescribeAlarms	Call the DescribeAlarms API to view the list of alarm policies.
CreateAlarmContentTemplate	Call the CreateAlarmContentTemplate API to create an alarm content template.
DeleteAlarmContentTemplate	Call the DeleteAlarmContentTemplate API to delete an alarm content template.
ModifyAlarmContentTemplate	Call the ModifyAlarmContentTemplate API to modify an alarm content template.
DescribeAlarmContentTemplates	Call the DescribeAlarmContentTemplates API to query alarm content templates.
CreateAlarmWebhookIntegration	Call the CreateAlarmWebhookIntegration API to create an alarm Webhook integration configuration.
DeleteAlarmWebhookIntegration	Call the DeleteAlarmWebhookIntegration API to delete an alarm Webhook integration configuration.
DescribeAlarmWebhookIntegrations	Call the DescribeAlarmWebhookIntegrations API to query alarm Webhook integration configurations.
ModifyAlarmWebhookIntegration	Call the ModifyAlarmWebhookIntegration API to modify an alarm Webhook integration configuration.

Consumer group management

API	Note
CreateConsumerGroup	Call the CreateConsumerGroup API to create a TLS consumer group (ConsumerGroup).
DeleteConsumerGroup	Call the DeleteConsumerGroup API to delete a TLS consumer group.
DescribeConsumerGroups	Call the DescribeConsumerGroups API to obtain information about all consumer groups in a project.
ModifyConsumerGroup	Call the ModifyConsumerGroup API to modify the configuration of a TLS consumer group.
ConsumerHeartbeat	Call the ConsumerHeartbeat API to send heartbeat information for a consumer in a consumer group to TLS.
DescribeCheckPoint	Call the DescribeCheckPoint API to view the current consumer checkpoint of the specified consumer group on the specified log shard.
ModifyCheckPoint	Call the ModifyCheckPoint API to reset the consumer checkpoint of the specified consumer group for the specified shard.
ResetCheckPoint	Call the ResetCheckPoint API to reset all consumer checkpoints for the specified consumer group.

Kafka protocol consumption

API	Note
OpenKafkaConsumer	Call the OpenKafkaConsumer API to enable Kafka protocol consumption for the specified log topic.
CloseKafkaConsumer	Call the CloseKafkaConsumer API to disable Kafka protocol consumption for the specified log topic.
DescribeKafkaConsumer	Call the DescribeKafkaConsumer API to view the Kafka consumption status of the specified log topic.

Tag management

API	Note
AddTagsToResource	Call the AddTagsToResource API to batch bind tags to the specified project or log topic.
RemoveTagsFromResource	Call the RemoveTagsFromResource API to batch unbind tags from the specified project or log topic.
UntagResources	Call the UntagResources API to batch remove resource tags.
TagResources	Call the TagResources API to batch bind tags to resources.
ListTagsForResources	Call the ListTagsForResources API to query all tags bound to resources.

Trace storage

API	Note
CreateTraceInstance	Call the CreateTraceInstance API to create a Trace instance.
ModifyTraceInstance	Call the ModifyTraceInstance API to modify Trace instance information.
DeleteTraceInstance	Call the DeleteTraceInstance API to delete a Trace instance.
DescribeTraceInstances	Call the DescribeTraceInstances API to obtain the list of Trace instances.
DescribeTraceInstance	Call the DescribeTraceInstance API to obtain Trace instance information.
DescribeTrace	Call the DescribeTrace API to query the list of Spans under the Trace by specifying the Trace instance ID and TraceID.
SearchTraces	Call the SearchTraces API to query the Trace details list based on specific conditions.

Account management

API	Note
ActiveTlsAccount	Call the ActiveTlsAccount API to activate TLS.
GetAccountStatus	Call the GetAccountStatus API to check whether TLS is activated.

Last updated: 2026.05.28 17:47:04