CLI Command Reference (V1)

Creating a Custom Alarm Template

hcloud CES CreateAlarmTemplate/v1

This API is used to create a custom alarm template.

Go debug

Querying Custom Alarm Templates

hcloud CES ListAlarmTemplates/v1

This API is used to query custom alarm templates.

Go debug

Updating a Custom Alarm Template

hcloud CES UpdateAlarmTemplate/v1

This API is used to update a custom alarm template.

Go debug

Deleting a Custom Alarm Template

hcloud CES DeleteAlarmTemplate/v1

This API is used to delete a custom alarm template based on the template ID.

Go debug

Querying the Metrics

hcloud CES ListMetrics/v1

This API is used to list metrics. You can specify the namespace, metric name, dimension, sorting order, start records, and the maximum number of records.

Go debug

Querying an Alarm Rule

hcloud CES ShowAlarm/v1

This API is used to query details of an alarm rule based on its ID. For API V1, only one alarm rule can be configured for a single resource. You are advised to use Querying Alarm Rules (Recommended) and Querying Resources in an Alarm Rule to work with the console.

Go debug

Deleting an Alarm Rule

hcloud CES DeleteAlarm/v1

This API is used to delete an alarm rule.

Go debug

Modifying an Alarm Rule

hcloud CES UpdateAlarm/v1

This API is used to modify an alarm rule.

Go debug

Enabling or Disabling an Alarm Rule

hcloud CES UpdateAlarmAction/v1

This API is used to enable or disable an alarm rule.

Go debug

Querying Alarm Rules (V1)

hcloud CES ListAlarms/v1

This API is used to query alarm rules. You can specify the paging parameters to limit the number of query results displayed on a page. You can also set the sorting order of query results. When you use this API to query alarm rules for multiple resources and policies, it returns only one alarm policy. In this case, use Querying Alarm Rules (Recommended) and the console functions together.

Go debug

Creating an Alarm Rule (V1)

hcloud CES CreateAlarm/v1

This API is used to create an alarm rule. For API V1, only an alarm rule can be configured for a single resource. You are advised to use Creating Alarm Rules (Recommended) to work with the console.

Go debug

Querying Alarm History

hcloud CES ListAlarmHistories/v1

This API is used to query the alarm history.

Go debug

Reporting an Event

hcloud CES CreateEvents/v1

This API is used to report custom events. Events with the same time, project_id, event_source, event_name, event_type, sub_event_type, event_state, event_level, event_user, resource_id, and resource_name fields are considered as the same event.

Go debug

Querying Events

hcloud CES ListEvents/v1

This API is used to query the event list, including system events and custom events.

Go debug

Querying the Monitoring Details of an Event

hcloud CES ListEventDetail/v1

This API is used to query details of an event based on the event name.

Go debug

Querying Monitoring Data in Batches

hcloud CES BatchListMetricData/v1

This API is used to query the monitoring data of specified metrics within a specified time range and a specified granularity in batches. You can query the monitoring data of up to 500 metrics in batches. The default maximum query intervals (the to-from value) for different periods and numbers of metrics to be queried are different. The following requirements must be met: Number of metrics x (to-from value)/Monitoring period ≤ 3000. If the obtained value is greater than 3000, the from value is automatically adjusted to meet the requirements.

Go debug

Querying Server Configuration Data

hcloud CES ShowEventData/v1

This API is used to query the server configuration for a specified event type in a specified time range. You can specify the dimension of data to be queried. This API is provided for SAP Monitor in the HANA scenario to query the server configuration. In other scenarios, the server configuration cannot be queried with this API.

Go debug

Querying Monitoring Data

hcloud CES ShowMetricData/v1

This API is used to query the monitoring metric data at a specified granularity in a specified period of time.

Go debug

Adding Monitoring Data

hcloud CES CreateMetricData/v1

This API is used to add one or more pieces of metric monitoring data.

Go debug

Querying Quotas

hcloud CES ShowQuotas/v1

This API is used to query a resource quota and the used amount. The current resource refers to alarm rules only.

Go debug

Querying Resources in a Resource Group

hcloud CES ShowResourceGroup/v1

This API is used to query resources in a resource group by resource group ID. This API has been deprecated. You are advised to use the V2 APIs. For details, see Querying Resources of a Specified Dimension for a Specified Service Type in a Resource Group.

Go debug

Updating a Resource Group

hcloud CES UpdateResourceGroup/v1

This API is used to update a resource group. With resource groups, you can manage resources by service and view monitoring and alarm information by group.

Go debug

Deleting a Resource Group

hcloud CES DeleteResourceGroup/v1

This API is used to delete a resource group.

Go debug

Creating a Resource Group

hcloud CES CreateResourceGroup/v1

This API is used to create a resource group. With resource groups, you can easily manage resources by service and view monitoring and alarm information by group.

Go debug

Querying All Resource Groups

hcloud CES ListResourceGroup/v1

This API is used to query all created resource groups.

Go debug