CLI Command Reference
Monitoring
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Time Series Objects | hcloud AOM ListSeries | This API is used to query the time series objects that can be monitored in the system. You can specify a namespace, name, dimension, and resource ID (format: resType_resId). You can also specify the start position and the maximum number of returned records for a pagination query. | |
| Querying Time Series Data | hcloud AOM ListSample | This API is used to query time series data within a specified period. You can specify a dimension or period to query. | |
| Querying Metrics | hcloud AOM ListMetricItems | This API is used to query the metrics that can be monitored in the system. You can query specific metrics by specifying a namespace, metric name, dimension, and resource ID (format: resType_resId). You can also specify the start position and the maximum number of returned records for a pagination query. | |
| Querying Monitoring Data | hcloud AOM ShowMetricsData | This API is used to query monitoring data of metrics within a specified period. You can specify a dimension or period to query. | |
| Adding Monitoring Data | hcloud AOM AddMetricData | This API is used to add one or more monitoring data records to a server. | |
| Adding or Modifying One or More Service Discovery Rules | hcloud AOM AddOrUpdateServiceDiscoveryRules | This API is used to add or modify one or more service discovery rules. A maximum of 100 rules can be added to a project. | |
| Deleting a Service Discovery Rule | hcloud AOM DeleteserviceDiscoveryRules | This API is used to delete a service discovery rule. | |
| Querying Existing Service Discovery Rules | hcloud AOM ListServiceDiscoveryRules | This API is used to query existing service discovery rules in the system. | |
| Adding a Threshold Rule | hcloud AOM AddAlarmRule | This API is used to add a threshold rule. | |
| Querying the Threshold Rule List | hcloud AOM ListAlarmRule | This API is used to query the threshold rule list. | |
| Modifying a Threshold Rule | hcloud AOM UpdateAlarmRule | This API is used to modify a threshold rule. | |
| Deleting a Threshold Rule | hcloud AOM DeleteAlarmRule | This API is used to delete a threshold rule. | |
| Querying a Threshold Rule | hcloud AOM ShowAlarmRule | This API is used to query a threshold rule. | |
| Deleting Threshold Rules in Batches | hcloud AOM DeleteAlarmRules | This API is used to delete threshold rules in batches. |
CMDB (AOM 2.0)
| API Name | Command | Description | Operation |
|---|---|---|---|
| Creating an Application | hcloud AOM CreateApp | This API is used to create an application. | |
| Querying the Details of an Application Based on the Application Name | hcloud AOM ShowAppByName | This API is used to query the details of an application. | |
| Deleting an Application | hcloud AOM DeleteApp | This API is used to delete an application. | |
| Querying the Details of an Application | hcloud AOM ShowApp | This API is used to obtain the details of an application. | |
| Modifying an Application | hcloud AOM UpdateApp | This API is used to modify an application. | |
| Adding a Component | hcloud AOM CreateComponent | This API is used to add a component. | |
| Deleting a Component | hcloud AOM DeleteComponent | This API is used to delete a component. | |
| Querying the Details of a Component | hcloud AOM ShowComponent | This API is used to query the details of a component. | |
| Modifying a Component | hcloud AOM UpdateComponent | This API is used to modify a component. | |
| Creating an Environment | hcloud AOM CreateEnv | This API is used to create an environment. | |
| Deleting an Environment | hcloud AOM DeleteEnv | This API is used to delete an environment. | |
| Querying the Details of an Environment | hcloud AOM ShowEnv | This API is used to query the details of an environment. | |
| Modifying an Environment | hcloud AOM UpdateEnv | This API is used to modify an environment. | |
| Querying the Resource List of a Node | hcloud AOM ListResourceUnderNode | This API is used to query the resource list of a node. | |
| Querying the Details of a Component Based on the Component Name | hcloud AOM ShowComponentByName | This API is used to query the details of a component based on the component name. | |
| Querying the Details of an Environment Based on the Environment Name | hcloud AOM ShowEnvByName | This API is used to query the details of an environment. | |
| Adding a Sub-application | hcloud AOM CreateSubApp | This API is used to add a sub-application. | |
| Deleting a Sub-application | hcloud AOM DeleteSubApp | This API is used to delete a sub-application. | |
| Modifying a Sub-application | hcloud AOM UpdateSubApp | This API is used to modify a sub-application. |
Prometheus Monitoring
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Expression Calculation Results in a Specified Period Using the GET Method | hcloud AOM ListRangeQueryAomPromGet | This API is used to query the calculation results of a PromQL expression in a specified period using the GET method. | |
| (Recommended) Querying Expression Calculation Results in a Specified Period Using the POST Method | hcloud AOM ListRangeQueryAomPromPost | This API is used to query the calculation results of a PromQL expression in a specified period using the POST method. | |
| Querying the Expression Calculation Result at a Specified Time Point Using the GET Method | hcloud AOM ListInstantQueryAomPromGet | This API is used to query the calculation result of a PromQL expression at a specified time point using the GET method. | |
| (Recommended) Querying Expression Calculation Results at a Specified Time Point Using the POST Method | hcloud AOM ListInstantQueryAomPromPost | This API is used to query the calculation result of a PromQL expression at a specified time point using the POST method. | |
| Querying Tag Values | hcloud AOM ListLabelValuesAomPromGet | This API is used to query the values of a specified tag. | |
| Obtaining the Tag Name List Using the GET Method | hcloud AOM ListLabelsAomPromGet | This API is used to obtain the tag name list using the GET method. | |
| (Recommended) Obtaining the Tag Name List Using the POST Method | hcloud AOM ListLabelsAomPromPost | This API is used to obtain the tag name list using the POST method. | |
| Querying Metadata | hcloud AOM ListMetadataAomPromGet | This API is used to query the metadata of time series and corresponding tags. |
Log
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Logs | hcloud AOM ListLogItems | This API is used to query logs by different dimensions, such as by cluster, IP address, or application. Pagination queries are supported. |
Alarm
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Events and Alarms | hcloud AOM ListEvents | This API is used to query events and alarms of a user. | |
| Counting Events and Alarms | hcloud AOM CountEvents | This API is used to count events and alarms that meet specified conditions. | |
| Reporting Events and Alarms | hcloud AOM PushEvents | This API is used to report events and alarms to AOM. It is also used to clear alarms. | |
| Obtaining the Alarm Sending Result | hcloud AOM ListNotifiedHistories | This API is used to obtain the alarm sending result. | |
| Deleting a Silence Rule | hcloud AOM DeleteMuteRules | This API is used to delete a silence rule. | |
| Adding a Silence Rule | hcloud AOM AddMuteRules | This API is used to add a silence rule. | |
| Modifying a Silence Rule | hcloud AOM UpdateMuteRule | This API is used to modify a silence rule. | |
| Obtaining the Silence Rule List | hcloud AOM ListMuteRule | This API is used to obtain the silence rule list. | |
| Querying an Alarm Action Rule Based on Rule Name | hcloud AOM ShowActionRule | This API is used to query an alarm action rule based on the rule name. | |
| Adding an Alarm Action Rule | hcloud AOM AddActionRule | This API is used to add an alarm action rule. | |
| Deleting an Alarm Action Rule | hcloud AOM DeleteActionRule | This API is used to delete an alarm action rule. | |
| Modifying an Alarm Action Rule | hcloud AOM UpdateActionRule | This API is used to modify an alarm action rule. | |
| Querying the Alarm Action Rule List | hcloud AOM ListActionRule | This API is used to query the alarm action rule list. | |
| Querying the Event Alarm Rule List | hcloud AOM ListEvent2alarmRule | This API is used to query the event alarm rule list. | |
| Adding an Event Alarm Rule | hcloud AOM AddEvent2alarmRule | This API is used to add an event alarm rule. | |
| Modifying an Event Alarm Rule | hcloud AOM UpdateEventRule | This API is used to modify an event alarm rule. | |
| Deleting an Event Alarm Rule | hcloud AOM DeleteEvent2alarmRule | This API is used to delete an event alarm rule. | |
| Querying Metric or Event Alarm Rules | hcloud AOM ListMetricOrEventAlarmRule | This API is used to query AOM 2.0 metric or event alarm rules. | |
| Adding or Modifying Metric or Event Alarm Rules | hcloud AOM AddOrUpdateMetricOrEventAlarmRule | This API is used to add or modify AOM 2.0 metric or event alarm rules. | |
| Deleting Metric or Event Alarm Rules | hcloud AOM DeleteMetricOrEventAlarmRule | This API is used to delete AOM 2.0 metric or event alarm rules. | |
| Querying the Message Template List | hcloud AOM ListNotificationTemplates | This API is used to query the message template list. | |
| Deleting a Message Template | hcloud AOM DeleteNotificationTemplate | This API is used to delete a message template. | |
| Adding a Message Template | hcloud AOM CreateNotificationTemplate | This API is used to add a message template. | |
| Modifying a Message Template | hcloud AOM UpdateNotificationTemplate | This API is used to modify a message template. | |
| Querying a Message Template Based on the Template Name | hcloud AOM ListNotificationTemplateByName | This API is used to query a message template based on the template name. | |
| Deleting an Alarm Template | hcloud AOM DeleteAlarmRuleTemplate | This API is used to delete an alarm template. | |
| Querying the Alarm Template List | hcloud AOM ListAlarmRuleTemplate | This API is used to query the alarm template list. |
Prometheus Instance
| API Name | Command | Description | Operation |
|---|---|---|---|
| Uninstalling a Hosted Prometheus Instance | hcloud AOM DeletePromInstance | This API is used to uninstall a hosted Prometheus instance. | |
| Querying a Prometheus Instance | hcloud AOM ListPromInstance | This API is used to query a Prometheus instance. | |
| Adding a Prometheus Instance | hcloud AOM CreatePromInstance | This API is used to add a Prometheus instance. | |
| Modifying a Prometheus Instance | hcloud AOM UpdatePromInstance | This API is used to modify a Prometheus instance. | |
| Creating a Recording Rule for a Prometheus Instance | hcloud AOM CreateRecordingRule | This API is used to create a recording rule for a Prometheus instance. | |
| Obtaining the Credential for Calling a Prometheus Instance | hcloud AOM ListAccessCode | This API is used to obtain the credential for calling a Prometheus instance. |
Configuration Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the Cloud Services for Which AOM 2.0 Has Been Granted Permissions | hcloud AOM ListPermissions | This API is used to query the cloud services for which AOM 2.0 has been granted permissions. | |
| Querying the ICAgent Installed on a Host | hcloud AOM ListAgents | This API is used to query the ICAgent installed on a cluster host or a custom host. |
Dashboard
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the Dashboard List | hcloud AOM ListDashBoards | This API is used to query the dashboard list. | |
| Deleting a Dashboard | hcloud AOM DeleteDashboard | This API is used to delete a dashboard. | |
| Querying Dashboard Details | hcloud AOM ShowDashBoard | This API is used to query dashboard details. | |
| Querying the Dashboard Group List | hcloud AOM ListDashboardsFolder | This API is used to query the dashboard group list. | |
| Deleting a Dashboard Group | hcloud AOM DeleteDashboardsFolder | This API is used to delete a dashboard group. |
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
