Help Center/ Log Tank Service/ CLI Reference/ CLI Command Reference
Updated on 2026-09-01 GMT+08:00

CLI Command Reference

Log Group Management

API Name

Command

Description

Operation

Creating a Log Group

hcloud LTS CreateLogGroup

This interface is used to create a log group.

Go debug

Queries all log groups under an account.

hcloud LTS ListLogGroups

This interface is used to query all log groups under an account.

Go debug

Deleting a log group

hcloud LTS DeleteLogGroup

This interface is used to delete a specified log group. If log dumping is configured for log stream in a log group, you need to cancel log dumping before deleting the log stream.

Go debug

Modifying a Log Group

hcloud LTS UpdateLogGroup

This interface is used to modify the log storage duration in a specified log group.

Go debug

Log Stream Management

API Name

Command

Description

Operation

Creating a Log Stream

hcloud LTS CreateLogStream

This interface is used to create log streams in a specified log group.

Go debug

Querying All Log Streams in a Specified Log Group

hcloud LTS ListLogStream

This interface is used to query information about all log streams in a specified log group.

Go debug

Deleting a Log Stream

hcloud LTS DeleteLogStream

This interface is used to delete a specified log stream from a specified log group. If log dump is configured for the log stream, you need to cancel the log dump before deleting the log stream.

Go debug

Querying Log Stream Information

hcloud LTS ListLogStreams

This interface is used to query LTS log stream information.

Go debug

Modifying a Log Stream

hcloud LTS UpdateLogStream

This interface is used to change the log storage duration of a specified log stream.

Go debug

Creates an index for a specified flow.

hcloud LTS CreateLogStreamIndex

Creates an index for a specified flow.

Go debug

Querying Log Stream Indexes

hcloud LTS ListLogStreamIndex

Query the log stream index.

Go debug

Log Management

API Name

Command

Description

Operation

query log

hcloud LTS ListLogs

This interface is used to query log content in a specified log stream.

Go debug

Querying Structured Logs

hcloud LTS ListQueryStructuredLogs

This interface is used to query structured logs in a specified log stream.

Go debug

Querying Structured Logs (New Version)

hcloud LTS ListStructuredLogsWithTimeRange

This interface is used to query structured log content in a specified log stream (new version).

Go debug

Querying Log Histograms

hcloud LTS ListLogHistogram

Query the number of keywords.

Go debug

Querying Context Logs

hcloud LTS ListLogContext

Querying Context LogsThis interface is used to query several logs before and after a specified log.

Go debug

Excess Collection

API Name

Command

Description

Operation

Disabling the Excess Collection Function

hcloud LTS DisableLogCollection

This interface is used to disable the excessive collection log function.

Go debug

Turn on the excess collection switch.

hcloud LTS EnableLogCollection

This interface is used to enable the function of excessive collection logs.

Go debug

Structured Configuration

API Name

Command

Description

Operation

Querying Structured Configurations

hcloud LTS ShowStructTemplate

This interface is used to query the structured configuration of a specified log stream.

Go debug

Create Structured Configuration

hcloud LTS CreateStructTemplate

This API is used to create structured configuration for a specified log stream.

Go debug

Modifying Structured Configurations

hcloud LTS UpdateStructTemplate

This interface is used to modify the structured configuration of a specified log stream.

Go debug

Deleting Structured Configurations

hcloud LTS DeleteStructTemplate

This interface is used to delete the structured configuration of a specified log stream.

Go debug

Creating Structured Configurations from Structured Templates (New)

hcloud LTS CreateStructConfig

This interface is used to create structured configurations using a structured template.

Go debug

Modifying Structured Configurations Using Structured Templates (New)

hcloud LTS UpdateStructConfig

This interface is used to modify structured configuration through a structured template.

Go debug

Querying Structured Templates

hcloud LTS ListStructTemplate

This interface is used to query structured templates.

Go debug

Querying a Brief List of Structured Templates

hcloud LTS ListBreifStructTemplate

This interface is used to query the abbreviated list of structured templates.

Go debug

Connecting AOM Container Logs to the LTS

API Name

Command

Description

Operation

Querying All Access Rules

hcloud LTS ShowAomMappingRules

This interface is used to query all access lts rules in AOM logs.

Go debug

Creating an Access Rule

hcloud LTS CreateAomMappingRules

This interface is used to create an AOM log access lts rule.

Go debug

Modifying an Access Rule

hcloud LTS UpdateAomMappingRules

This interface is used to modify an access rule.

Go debug

Deleting an Access Rule

hcloud LTS DeleteAomMappingRules

This interface is used to delete an lts access rule.

Go debug

Querying a Single Access Rule

hcloud LTS ShowAomMappingRule

This interface is used to query the access lts of a single AOM log.

Go debug

Alarm Subject

API Name

Command

Description

Operation

Querying SMN Topics

hcloud LTS ListNotificationTopics

This interface is used to query SMN topics.

Go debug

SQL Alarm Rule

API Name

Command

Description

Operation

Creating an SQL Alarm Rule

hcloud LTS CreateSqlAlarmRule

This interface is used to create SQL alarms. Currently, each account can create a maximum of 200 keyword alarms and SQL alarms.

Go debug

Modifying an SQL Alarm Rule

hcloud LTS UpdateSqlAlarmRule

This interface is used to modify SQL alarms.

Go debug

Querying SQL Alarm Rules

hcloud LTS ListSqlAlarmRules

This interface is used to query SQL alarms.

Go debug

Deleting an SQL Alarm Rule

hcloud LTS DeleteSqlAlarmRule

This interface is used to delete SQL alarms.

Go debug

Switching Alarm Rule Status

hcloud LTS UpdateAlarmRuleStatus

Changing the status of an alarm rule

Go debug

Keyword alarm rule

API Name

Command

Description

Operation

Creating a Keyword Alarm Rule

hcloud LTS CreateKeywordsAlarmRule

This interface is used to create keyword alarms. Currently, each account can create a maximum of 200 keyword alarms and SQL alarms.

Go debug

Modifying a Keyword Alarm Rule

hcloud LTS UpdateKeywordsAlarmRule

This interface is used to modify keyword alarms.

Go debug

Querying a Keyword Alarm Rule

hcloud LTS ListKeywordsAlarmRules

This interface is used to query keyword alarms.

Go debug

Deleting a Keyword Alarm Rule

hcloud LTS DeleteKeywordsAlarmRule

This interface is used to delete keyword alarms.

Go debug

alarm list

API Name

Command

Description

Operation

Querying the Active or Historical Alarm List

hcloud LTS ListActiveOrHistoryAlarms

This interface is used to query the alarm list.

Go debug

Deleting Active Alarms

hcloud LTS DeleteActiveAlarms

This interface is used to delete active alarms.

Go debug

Log Stream Chart

API Name

Command

Description

Operation

Querying Log Stream Charts

hcloud LTS ListCharts

This interface is used to query log stream charts.

Go debug

og transfer

API Name

Command

Description

Operation

Creating Log Dumps (New Version)

hcloud LTS CreateTransfer

This API is used to create OBS dump, DIS dump, and DMS dump.

Go debug

log transfer

API Name

Command

Description

Operation

Delete Log Dump

hcloud LTS DeleteTransfer

This API is used to delete OBS dump, DIS dump, and DMS dump.

Go debug

Update Log Dump

hcloud LTS UpdateTransfer

This API is used to update OBS dump, DIS dump, and DMS dump.

Go debug

Querying Log Dumping

hcloud LTS ListTransfers

This API is used to query OBS dump, DIS dump, and DMS dump configurations.

Go debug

Registering DMS Kafka Instances

hcloud LTS RegisterDmsKafkaInstance

This API is used to register a DMS Kafka instance.

Go debug

Message Template Management

API Name

Command

Description

Operation

Creating a Message Template

hcloud LTS CreateNotificationTemplate

This interface is used to create notification templates. Currently, a maximum of 100 notification templates can be created for each account. The name cannot be changed after being created.

Go debug

Modifying a Message Template

hcloud LTS UpdateNotificationTemplate

This interface is used to modify a notification template by name.

Go debug

Querying a Message Template

hcloud LTS ListNotificationTemplates

This interface is used to query notification templates.

Go debug

Deleting a Message Template

hcloud LTS DeleteNotificationTemplate

This interface is used to delete a notification template.

Go debug

Querying a Single Message Template

hcloud LTS ShowNotificationTemplate

This interface is used to query a notification template.

Go debug

Preview Message Template Email Format

hcloud LTS ListNotificationTemplate

This interface is used to preview the email format of a notification template.

Go debug

Host Group Management

API Name

Command

Description

Operation

Querying Host Information

hcloud LTS ListHost

Querying the Host List

Go debug

Querying a Host Group

hcloud LTS ListHostGroup

Querying the Host Group List

Go debug

Creating a Host Group

hcloud LTS CreateHostGroup

Creating a Host Group

Go debug

Deleting a host group

hcloud LTS DeleteHostGroup

Deleting a host group

Go debug

Modifying a Host Group

hcloud LTS UpdateHostGroup

Modifying a Host Group

Go debug

Log access

API Name

Command

Description

Operation

Querying Log Access

hcloud LTS ListAccessConfig

Querying the Log Access List

Go debug

Create Log Access

hcloud LTS CreateAccessConfig

Create Log Access

Go debug

Deleting Log Access

hcloud LTS DeleteAccessConfig

Deleting Log Access

Go debug

Modifying Log Access (CCE)

hcloud LTS UpdateAccessConfig

Modifying Log Access (CCE)

Go debug

Creating Cross-Account Log Access

hcloud LTS CreateAgencyAccess

Creating Cross-Account Log Access

Go debug

Dashboard Management

API Name

Command

Description

Operation

Creating a Dashboard

hcloud LTS CreateDashBoard

Creating a Dashboard

Go debug

Creating a Dashboard Group

hcloud LTS CreateDashboardGroup

Creating a Dashboard Group

Go debug

Collecting Logs

API Name

Command

Description

Operation

Creating a log collection

hcloud LTS Createfavorite

Creating a log collection

Go debug

Remove from Favorites

hcloud LTS Deletefavorite

Remove from Favorites

Go debug

Tag Management

API Name

Command

Description

Operation

Creating Tags

hcloud LTS CreateTags

Adding a Tag

Go debug

Resource statistics

API Name

Command

Description

Operation

Collect statistics on the traffic of top N log groups or log streams.

hcloud LTS ListTopnTrafficStatistics

Collect statistics on the traffic of top N log groups or log streams.

Go debug

Querying Resource Statistics by Time Segment

hcloud LTS ListTimeLineTrafficStatistics

Querying Resource Statistics by Time Segment

Go debug

Quick query

API Name

Command

Description

Operation

Quick query

hcloud LTS ListHistorySql

SQL statement for querying user history

Go debug

Add Quick Query

hcloud LTS CreateSearchCriterias

Add Quick Query

Go debug

Quick query

hcloud LTS ListCriterias

Get Quick Queries

Go debug

Delete Quick Query

hcloud LTS DeleteSearchCriterias

Delete Quick Query

Go debug

Queries all quick queries in a log group.

hcloud LTS ListQueryAllSearchCriterias

Queries all quick queries in a log group.

Go debug

Multi-account log aggregation

API Name

Command

Description

Operation

Obtaining the Log Aggregation Switch

hcloud LTS ShowAdminConfig

The log aggregation switch can be invoked only by administrators or delegated administrators.

Go debug

Modifying the Log Aggregation Switch

hcloud LTS UpdateSwitch

The log aggregation switch can be modified only by the administrator or authorized administrator.

Go debug

Obtaining Organization Member Aggregation Configurations

hcloud LTS ShowLogConvergeConfig

This interface can be invoked only by the organization administrator or authorized administrator to obtain the organization member aggregation configuration.

Go debug

Obtaining the Log Stream of an Organization Member Log Group

hcloud LTS ShowMemberGroupAndStream

This command can be invoked only by the administrator or delegated administrator to obtain the log streams of the organization member log group.

Go debug

Updating Aggregation Configurations

hcloud LTS UpdateLogConvergeConfig

Only administrators or delegated administrators can update aggregation configurations.

Go debug