API Overview
Cloud Eye APIs allow you to use all Cloud Eye functions. For example, you can query the metric list and create alarm rules.
Type |
Subtype |
API |
Description |
---|---|---|---|
API V1 |
API versions |
Query all API versions supported by Cloud Eye. |
|
Query a specified API version of Cloud Eye. |
|||
Metrics |
Query metrics supported by Cloud Eye. |
||
Alarm rules |
Query alarm rules. |
||
Query details of an alarm rule based on its ID. |
|||
Enable or disable an alarm rule based on the alarm rule ID. |
|||
Delete an alarm rule based on its ID. |
|||
Create an alarm rule. |
|||
Create a custom alarm template to add alarm rules for one or more metrics. |
|||
Delete a custom alarm template. |
|||
Query the alarm history of an alarm rule based on the alarm rule ID. |
|||
Query custom alarm templates. |
|||
Update a custom alarm template. |
|||
Modify an alarm rule. |
|||
Monitoring data |
Query the monitoring data of a specified metric at a specified granularity in a specified time range. |
||
Add one or more pieces of metric data. |
|||
Batch query data of a specified metric at a specified granularity in a specified time range. |
|||
Query the host configuration for a specified event type in a specified time range. You can specify the dimension of data to be queried. |
|||
Quotas |
Query the alarm rule quota. |
||
Resource groups |
Query resources in a resource group based on the resource group ID. |
||
Create a resource group. You can use resource groups to manage resources by service, and view monitoring and alarm information by group to ease O&M. |
|||
Update a resource group. You can use resource groups to manage resources by service, and view monitoring and alarm information by group to ease O&M. |
|||
Delete a resource group. |
|||
Query all resource groups you created. |
|||
Event monitoring |
Report custom events. |
||
Query events, including system events and custom events. |
|||
Query details of an event based on the event name. |
|||
API V2 |
Alarm rules |
Create an alarm rule. |
|
Delete alarm rules in batches. |
|||
Batch enable or disable alarm rules. |
|||
Query the alarm rule list. |
|||
Monitored resources |
Batch add resources to an alarm rule. (Alarm rules for resources in resource groups are excluded.) |
||
Batch delete resources from an alarm rule. (Alarm rules for resources in resource groups are excluded.) |
|||
Query resources in an alarm rule based on the alarm rule ID. |
|||
Alarm policies |
Modify policies in an alarm rule. |
||
Query alarm policies based on the alarm rule ID. |
|||
Alarm notifications |
Modify alarm notification information in an alarm rule. |
||
Alarm records |
Query alarm records. |
||
Alarm templates |
Create a custom template. |
||
Delete custom templates in batches. |
|||
Modify a custom template. |
|||
Query alarm templates. |
|||
Query the alarm template details. |
|||
Alarm rules associated with an alarm template |
Query alarm rules associated with an alarm template. |
||
Resource groups |
Create a resource group. |
||
Delete resource groups in batches. |
|||
Modify a resource group. |
|||
Query details of a resource group. |
|||
Query resource groups. |
|||
Resources in a resource group |
Batch add resources to a custom resource group. |
||
Batch delete resources from a resource group whose resources are manually added. |
|||
Querying Resources of a Specified Dimension and a Specified Service Type in a Resource Group |
Query resources of a specified dimension for a specified resource type in a resource group. |
||
One-click monitoring |
Enable one-click monitoring. |
||
Querying Services and Resources That Support One-Click Monitoring |
Query services and resources that support one-click monitoring. |
||
Query alarm rules of a service in one-click monitoring. |
|||
Batch Enabling or Disabling Alarm Rules of One Service in One-Click Monitoring |
Batch enable or disable alarm rules for a service in one-click monitoring. |
||
Batch disable one-click motoring. |
|||
Batch modify alarm notifications in alarm rules for one service that has one-click monitoring enabled. |
|||
Batch enable or disable alarm policies in alarm rules for one service that has one-click monitoring enabled. |
|||
Alarm notification masking |
Create alarm notification masking rules in batches. |
||
Modifying the Masking Time of Alarm Notification Masking Rules in Batches |
Modify the masking time of alarm notification masking rules in batches. |
||
Modify an alarm notification masking rule. |
|||
Delete alarm notification masking rules in batches. |
|||
Query notification masking rules of a specified type in batches. Currently, a maximum of 100 notification masking rules can be queried in batches. |
|||
Querying Resources for Which Alarm Notifications Have Been Masked |
Query resources for which alarm notifications have been masked. |
||
Dashboards |
Create or copy a dashboard. |
||
Query dashboards. |
|||
Modify a dashboard. |
|||
Delete dashboards in batches. |
|||
Graphs |
This API is used to create, copy, or batch create graphs on a dashboard. |
Create, copy, or batch create graphs on a dashboard. |
|
Query graphs added to a dashboard. |
|||
Query information about a graph. |
|||
Delete a graph. |
|||
Update graphs in batches. |
|||
Resource tags |
Query tags of a type of resources in a Cloud Eye project. |
||
Metrics |
Querying Server Monitoring Metrics from Different Dimensions |
Query metrics by disk, mount point, process, graphics card, or RAID controller based on the ECS or BMS ID. |
|
API V3 |
Agent statuses |
Query the Agent (including the UniAgent) statuses. |
|
Agent tasks |
Query the Agent tasks. |
||
Batch create Agent tasks. |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.