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. | |
| Queries all log groups under an account. | hcloud LTS ListLogGroups | This interface is used to query all log groups under an account. | |
| 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. | |
| Modifying a Log Group | hcloud LTS UpdateLogGroup | This interface is used to modify the log storage duration in a specified log group. |
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. | |
| 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. | |
| 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. | |
| Querying Log Stream Information | hcloud LTS ListLogStreams | This interface is used to query LTS log stream information. | |
| Modifying a Log Stream | hcloud LTS UpdateLogStream | This interface is used to change the log storage duration of a specified log stream. | |
| Creates an index for a specified flow. | hcloud LTS CreateLogStreamIndex | Creates an index for a specified flow. | |
| Querying Log Stream Indexes | hcloud LTS ListLogStreamIndex | Query the log stream index. |
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. | |
| Querying Structured Logs | hcloud LTS ListQueryStructuredLogs | This interface is used to query structured logs in a specified log stream. | |
| Querying Structured Logs (New Version) | hcloud LTS ListStructuredLogsWithTimeRange | This interface is used to query structured log content in a specified log stream (new version). | |
| Querying Log Histograms | hcloud LTS ListLogHistogram | Query the number of keywords. | |
| Querying Context Logs | hcloud LTS ListLogContext | Querying Context LogsThis interface is used to query several logs before and after a specified log. |
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. | |
| Turn on the excess collection switch. | hcloud LTS EnableLogCollection | This interface is used to enable the function of excessive collection logs. |
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. | |
| Create Structured Configuration | hcloud LTS CreateStructTemplate | This API is used to create structured configuration for a specified log stream. | |
| Modifying Structured Configurations | hcloud LTS UpdateStructTemplate | This interface is used to modify the structured configuration of a specified log stream. | |
| Deleting Structured Configurations | hcloud LTS DeleteStructTemplate | This interface is used to delete the structured configuration of a specified log stream. | |
| Creating Structured Configurations from Structured Templates (New) | hcloud LTS CreateStructConfig | This interface is used to create structured configurations using a structured template. | |
| Modifying Structured Configurations Using Structured Templates (New) | hcloud LTS UpdateStructConfig | This interface is used to modify structured configuration through a structured template. | |
| Querying Structured Templates | hcloud LTS ListStructTemplate | This interface is used to query structured templates. | |
| Querying a Brief List of Structured Templates | hcloud LTS ListBreifStructTemplate | This interface is used to query the abbreviated list of structured templates. |
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. | |
| Creating an Access Rule | hcloud LTS CreateAomMappingRules | This interface is used to create an AOM log access lts rule. | |
| Modifying an Access Rule | hcloud LTS UpdateAomMappingRules | This interface is used to modify an access rule. | |
| Deleting an Access Rule | hcloud LTS DeleteAomMappingRules | This interface is used to delete an lts access rule. | |
| Querying a Single Access Rule | hcloud LTS ShowAomMappingRule | This interface is used to query the access lts of a single AOM log. |
Alarm Subject
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying SMN Topics | hcloud LTS ListNotificationTopics | This interface is used to query SMN topics. |
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. | |
| Modifying an SQL Alarm Rule | hcloud LTS UpdateSqlAlarmRule | This interface is used to modify SQL alarms. | |
| Querying SQL Alarm Rules | hcloud LTS ListSqlAlarmRules | This interface is used to query SQL alarms. | |
| Deleting an SQL Alarm Rule | hcloud LTS DeleteSqlAlarmRule | This interface is used to delete SQL alarms. | |
| Switching Alarm Rule Status | hcloud LTS UpdateAlarmRuleStatus | Changing the status of an alarm rule |
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. | |
| Modifying a Keyword Alarm Rule | hcloud LTS UpdateKeywordsAlarmRule | This interface is used to modify keyword alarms. | |
| Querying a Keyword Alarm Rule | hcloud LTS ListKeywordsAlarmRules | This interface is used to query keyword alarms. | |
| Deleting a Keyword Alarm Rule | hcloud LTS DeleteKeywordsAlarmRule | This interface is used to delete keyword alarms. |
alarm list
Log Stream Chart
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Log Stream Charts | hcloud LTS ListCharts | This interface is used to query log stream charts. |
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. |
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. | |
| Update Log Dump | hcloud LTS UpdateTransfer | This API is used to update OBS dump, DIS dump, and DMS dump. | |
| Querying Log Dumping | hcloud LTS ListTransfers | This API is used to query OBS dump, DIS dump, and DMS dump configurations. | |
| Registering DMS Kafka Instances | hcloud LTS RegisterDmsKafkaInstance | This API is used to register a DMS Kafka instance. |
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. | |
| Modifying a Message Template | hcloud LTS UpdateNotificationTemplate | This interface is used to modify a notification template by name. | |
| Querying a Message Template | hcloud LTS ListNotificationTemplates | This interface is used to query notification templates. | |
| Deleting a Message Template | hcloud LTS DeleteNotificationTemplate | This interface is used to delete a notification template. | |
| Querying a Single Message Template | hcloud LTS ShowNotificationTemplate | This interface is used to query a notification template. | |
| Preview Message Template Email Format | hcloud LTS ListNotificationTemplate | This interface is used to preview the email format of a notification template. |
Host Group Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Host Information | hcloud LTS ListHost | Querying the Host List | |
| Querying a Host Group | hcloud LTS ListHostGroup | Querying the Host Group List | |
| Creating a Host Group | hcloud LTS CreateHostGroup | Creating a Host Group | |
| Deleting a host group | hcloud LTS DeleteHostGroup | Deleting a host group | |
| Modifying a Host Group | hcloud LTS UpdateHostGroup | Modifying a Host Group |
Log access
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Log Access | hcloud LTS ListAccessConfig | Querying the Log Access List | |
| Create Log Access | hcloud LTS CreateAccessConfig | Create Log Access | |
| Deleting Log Access | hcloud LTS DeleteAccessConfig | Deleting Log Access | |
| Modifying Log Access (CCE) | hcloud LTS UpdateAccessConfig | Modifying Log Access (CCE) | |
| Creating Cross-Account Log Access | hcloud LTS CreateAgencyAccess | Creating Cross-Account Log Access |
Dashboard Management
Collecting Logs
Tag Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Creating Tags | hcloud LTS CreateTags | Adding a Tag |
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. | |
| Querying Resource Statistics by Time Segment | hcloud LTS ListTimeLineTrafficStatistics | Querying Resource Statistics by Time Segment |
Quick query
| API Name | Command | Description | Operation |
|---|---|---|---|
| Quick query | hcloud LTS ListHistorySql | SQL statement for querying user history | |
| Add Quick Query | hcloud LTS CreateSearchCriterias | Add Quick Query | |
| Quick query | hcloud LTS ListCriterias | Get Quick Queries | |
| Delete Quick Query | hcloud LTS DeleteSearchCriterias | Delete Quick Query | |
| Queries all quick queries in a log group. | hcloud LTS ListQueryAllSearchCriterias | Queries all quick queries in a log group. |
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. | |
| Modifying the Log Aggregation Switch | hcloud LTS UpdateSwitch | The log aggregation switch can be modified only by the administrator or authorized administrator. | |
| 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. | |
| 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. | |
| Updating Aggregation Configurations | hcloud LTS UpdateLogConvergeConfig | Only administrators or delegated administrators can update aggregation configurations. |
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot