Help Center/ Cloud Eye/ clir/ CLI Command Reference (V2)
Updated on 2026-09-03 GMT+08:00

CLI Command Reference (V2)

Alarm Rules

API Name

Command

Description

Operation

Creating an Alarm Rule (Recommended)

hcloud CES CreateAlarmRules/v2

This API is used to create alarm rules.

Go debug

Querying Alarm Rules (Recommended)

hcloud CES ListAlarmRules/v2

This API is used to query the alarm rule list.

Go debug

Batch Deleting Alarm Rules

hcloud CES BatchDeleteAlarmRules/v2

This API (V2) is used to batch delete alarm rules.

Go debug

Enabling or Disabling Alarm Rules in Batches

hcloud CES BatchEnableAlarmRules/v2

This API is used to enable or disable alarm rules in batches.

Go debug

Alarm Resources

API Name

Command

Description

Operation

Querying Resources in an Alarm Rule

hcloud CES ListAlarmRuleResources/v2

This API is used to query resources in an alarm rule by alarm rule ID.

Go debug

Batch Deleting Resources from an Alarm Rule

hcloud CES DeleteAlarmRuleResources/v2

This API is used to batch delete resources from an alarm rule. This API does not support alarm rules whose AlarmType is RESOURCE_GROUP. To modify resources in such alarm rules, use the resource group management APIs.

Go debug

Batch Adding Resources to an Alarm Rule

hcloud CES AddAlarmRuleResources/v2

This API is used to batch add resources to an alarm rule. This API does not support alarm rules whose AlarmType is RESOURCE_GROUP. To modify resources in such alarm rules, use the resource group management APIs.

Go debug

Alarm Policies

API Name

Command

Description

Operation

Modifying All Fields in an Alarm Policy

hcloud CES UpdateAlarmRulePolicies/v2

This API is used to modify all fields in an alarm rule.

Go debug

Querying Alarm Policies

hcloud CES ListAlarmRulePolicies/v2

This API is used to query alarm policies by alarm rule ID.

Go debug

Alert Notifications

API Name

Command

Description

Operation

Modifying Alarm Notification Information in an Alarm Rule

hcloud CES UpdateAlarmNotifications/v2

This API is used to modify alarm notification information in an alarm rule.

Go debug

Alarm Records

API Name

Command

Description

Operation

This API is used to query alarm records.

hcloud CES ListAlarmHistories/v2

This API is used to query alarm records.

Go debug

Alarm Templates

API Name

Command

Description

Operation

Querying Alarm Templates

hcloud CES ListAlarmTemplates/v2

This API is used to query the alarm template list.

Go debug

Creating a Custom Alarm Template

hcloud CES CreateAlarmTemplate/v2

This API is used to create a custom alarm template.

Go debug

Deleting Custom Alarm Templates in Batches

hcloud CES BatchDeleteAlarmTemplates/v2

This API is used to delete custom alarm templates in batches.

Go debug

This API is used to modify a custom template.

hcloud CES UpdateAlarmTemplate/v2

This API is used to modify a custom template.

Go debug

Querying Details of an Alarm Template

hcloud CES ShowAlarmTemplate/v2

This API is used to query details of an alarm template.

Go debug

Alarm Rules Associated with an Alarm Template

API Name

Command

Description

Operation

Querying Alarm Rules Associated with an Alarm Template

hcloud CES ListAlarmTemplateAssociationAlarms/v2

This API is used to query alarm rules associated with the alarm template.

Go debug

Resource Groups

API Name

Command

Description

Operation

Creating a Resource Group (Recommended)

hcloud CES CreateResourceGroup/v2

This API is used to create a resource group.

Go debug

Querying Resource Groups

hcloud CES ListResourceGroups/v2

This API is used to query resource groups.

Go debug

Modifying a Resource Group

hcloud CES UpdateResourceGroup/v2

This API is used to modify a resource group.

Go debug

Querying Details of a Resource Group

hcloud CES ShowResourceGroup/v2

This API is used to query details of a resource group.

Go debug

This API is used to delete resource groups in batches.

hcloud CES BatchDeleteResourceGroups/v2

This API is used to delete resource groups in batches.

Go debug

Asynchronously Associating a Resource Group with a Custom Alarm Template

hcloud CES UpdateResourceGroupAssociationAlarmTemplate/v2

This API is used to submit an asynchronous task for batch associating a resource group with custom alarm templates. These tasks create or replace existing alarm rules. Each user can create up to 100 asynchronous tasks in the pending state. Each resource group allows only one pending task.

Go debug

Resources in a Resource Group

API Name

Command

Description

Operation

Querying Resources of a Specified Dimension and a Specified Service Type in a Resource Group

hcloud CES ListResourceGroupsServicesResources/v2

This API is used to query resources of a specified dimension for a specified resource type in a resource group.

Go debug

Batch Adding Resources to a Resource Group

hcloud CES BatchCreateResources/v2

This API is used to batch add resources to a resource group whose type is Manual.

Go debug

Batch Deleting Resources from a Resource Group

hcloud CES BatchDeleteResources/v2

This API is used to batch delete resources from a resource group whose type is Manual.

Go debug

One-Click Monitoring

API Name

Command

Description

Operation

Enabling One-Click Monitoring

hcloud CES CreateOneClickAlarm/v2

This API is used to enable one-click monitoring.

Go debug

Querying Services and Resources That Support One-Click Monitoring

hcloud CES ListOneClickAlarms/v2

This API is used to query services and resources that support one-click monitoring.

Go debug

Querying Alarm Rules of a Service in One-Click Monitoring

hcloud CES ListOneClickAlarmRules/v2

This API is used to query alarm rules of a service in one-click monitoring.

Go debug

Batch Enabling or Disabling Alarm Rules for One Service in One-Click Monitoring

hcloud CES BatchUpdateOneClickAlarmsEnabledState/v2

This API is used to batch enable or disable alarm rules for one service that has one-click monitoring enabled.

Go debug

Batch Disabling One-Click Motoring

hcloud CES BatchDeleteOneClickAlarms/v2

This API is used to batch disable one-click monitoring.

Go debug

Batch Modifying Alarm Notifications in Alarm Rules for One Service with One-Click Monitoring Enabled

hcloud CES UpdateOneClickAlarmNotifications/v2

This API is used to batch modify alarm notifications in alarm rules for one service that has one-click monitoring enabled.

Go debug

Batch Enabling or Disabling Alarm Rules for One Service with One-Click Monitoring Enabled

hcloud CES BatchUpdateOneClickAlarmPoliciesEnabledState/v2

This API is used to batch enable or disable alarm rules for one service with one-click monitoring enabled.

Go debug

Alarm Masking Rules

API Name

Command

Description

Operation

Creating Alarm Masking Rules in Batches

hcloud CES BatchUpdateNotificationMasks/v2

This API is used to create alarm masking rules in batches.

Go debug

Modifying the Masking Time of Alarm Masking Rules in Batches

hcloud CES BatchUpdateNotificationMaskTime/v2

Modify the masking time of alarm masking rules in batches.

Go debug

Modifying an Alarm Masking Rule

hcloud CES UpdateNotificationMask/v2

This API is used to modify an alarm notification masking rule.

Go debug

Deleting Alarm Masking Rules in Batches

hcloud CES BatchDeleteNotificationMasks/v2

This API is used to delete alarm masking rules in batches.

Go debug

Querying Alarm Masking Rules

hcloud CES ListNotificationMasks/v2

This API is used to query notification masking rules of a specified type in batches. Currently, a maximum of 100 notification masking rules can be queried in batches.

Go debug

Querying Resources for Which an Alarm Masking Rule Is Applied

hcloud CES ListNotificationMaskResources/v2

This API is used to query resources for which an alarm masking rule is applied.

Go debug

Dashboards

API Name

Command

Description

Operation

Creating or Copying a Dashboard

hcloud CES CreateOneDashboard/v2

This API is used to create or copy a dashboard.

Go debug

Querying Dashboards

hcloud CES ListDashboardInfos/v2

This API is used to query dashboards.

Go debug

Modifying a Dashboard

hcloud CES UpdateDashboard/v2

This API is used to modify a dashboard.

Go debug

Deleting Dashboards in Batches

hcloud CES DeleteDashboards/v2

This API is used to delete dashboards in batches.

Go debug

Graphs

API Name

Command

Description

Operation

Creating, Copying, or Batch Creating Graphs on a Dashboard

hcloud CES CreateDashboardWidgets/v2

This API is used to create, copy, or batch create graphs on a dashboard.

Go debug

Querying Graphs Added to a Dashboard

hcloud CES ListDashboardWidgets/v2

This API is used to query graphs on a dashboard.

Go debug

Querying Information About a Graph

hcloud CES ShowWidget/v2

This API is used to query information about a graph.

Go debug

Deleting a Graph

hcloud CES DeleteOneWidget/v2

This API is used to delete a graph.

Go debug

Updating Graphs in Batches

hcloud CES BatchUpdateWidgets/v2

This API is used to update graphs in batches.

Go debug

Resource Tag Management

API Name

Command

Description

Operation

Querying Tags for a Specified Resource Type in a Cloud Eye Project

hcloud CES ListCesTargetProjectTags/v2

This API is used to query tags of a type of resources in a Cloud Eye project.

Go debug

Metric Management

API Name

Command

Description

Operation

Querying the Original Dimension Values in Server Monitoring

hcloud CES ListAgentDimensionInfo/v2

This API is used to query the original dimension value based on the ECS/BMS resource ID and special dimension value for disks, mount points, processes, GPUs, and RAID controllers. This API is not required for other dimensions.

Go debug

Batch Querying Metric Data

hcloud CES BatchListSpecifiedMetricData/v2

This API is used to query metric data in batches.

Go debug