CLI Command Reference
Trace Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying a Trace List | hcloud CTS ListTraces | This API is used to query records of operations on resources in the last seven days. |
Tracker Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Creating a Tracker | hcloud CTS CreateTracker | When you enable CTS, a tracker is automatically created to associate with the cloud services you are using and record all operations on the services. A management tracker and multiple data trackers can be created by an account in a region.Operation records (traces) are retained for 7 days and you can check them on the CTS console. To store traces for a longer period, you can transfer them to an Object Storage Service (OBS) bucket in real time. | |
| Modifying a Tracker | hcloud CTS UpdateTracker | This API is used to modify configurations of a tracker, including trace transfer to OBS buckets, key event notifications, trace file encryption, management trace retrieval using Log Tank Service (LTS), trace file integrity check, and tracker enablement or disablement. Modifying tracker parameters does not affect the collected traces. After the modification is complete, the new rules are immediately applied to operation recording. | |
| Querying a Tracker | hcloud CTS ListTrackers | This API is used to query tracker details, including the tracker name, name of OBS buckets for storing traces, and file name prefix of the traces files stored in OBS buckets. | |
| Deleting a Tracker | hcloud CTS DeleteTracker | This API is used to delete trackers. Only data trackers can be deleted. Deleting a tracker has no impact on the collected traces. When you enable CTS again, you can still view those traces. |
Key Event Notification Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Creating a Key Event Notification | hcloud CTS CreateNotification | SMS, email, or HTTP/HTTPS notifications can be sent through pre-configured SMN topics to subscribers when key operations occur. This helps you detect high-risk operations promptly. Notifications can also be used as triggers for workflows or to connect to your own audit system. | |
| Modifying a Key Event Notification | hcloud CTS UpdateNotification | This API is used to modify a key event notification. The notification ID carried in the request must be valid. | |
| Deleting a Key Event Notification | hcloud CTS DeleteNotification | This API is used to delete a key event notification. | |
| Querying a Key Event Notification | hcloud CTS ListNotifications | This API is used to query a key event notification. |
Other APIs
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the Tracker Quota of a Tenant | hcloud CTS ListQuotas | This API is used to query the tracker quota of a tenant. | |
| Querying All Operations on a Cloud Service | hcloud CTS ListOperations | This API is used to list all operations on a cloud service. | |
| Querying the Audit Log Operator List | hcloud CTS ListUserResources | This API is used to query the audit log operator list. | |
| Checking Whether Data Can Be Transferred to the Configured OBS Bucket | hcloud CTS CheckObsBuckets | This API is used to check whether data can be transferred to the OBS bucket. | |
| Querying the Resources Involved in the Traces | hcloud CTS ListTraceResources | This API is used to query the resources involved in the traces. |
Tag Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Adding CTS Resource Tags in Batches | hcloud CTS BatchCreateResourceTags | This API is used to add CTS resource tags in batches. | |
| Deleting CTS Resource Tags in Batches | hcloud CTS BatchDeleteResourceTags | This API is used to delete CTS resource tags in batches. |
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