API Overview

API V1

API Version Management

Querying All API Versions

Query all API versions supported by Cloud Eye.

Querying a Specified API Version

Query a specified API version of Cloud Eye.

Metric Management

Querying Metrics

Query metrics supported by Cloud Eye.

Alarm Rules

Querying Alarm Rules

Query alarm rules.

Querying Details of an Alarm Rule

Query details of an alarm rule based on its ID.

Enabling or Disabling an Alarm Rule

Enable or disable an alarm rule based on the alarm rule ID.

Deleting an Alarm Rule

Delete an alarm rule based on its ID.

Creating an Alarm Rule

Create an alarm rule.

Creating a Custom Alarm Template

Create a custom alarm template to add an alarm rule for one or more metrics.

Deleting a Custom Alarm Template

Delete a custom alarm template.

Querying the Alarm History of an Alarm Rule

Query the alarm history of an alarm rule based on its ID.

Querying Custom Alarm Templates

Query the list of custom alarm templates.

Updating a Custom Alarm Template

Update a custom alarm template.

Modifying an Alarm Rule

Modify an alarm rule.

Monitoring Data Management

Querying Monitoring Data of a Metric

Query the monitoring data of a metric at a specified granularity in a specified time range.

Adding Monitoring Data

Add one or more pieces of metric data.

Querying Monitoring Data of Multiple Metrics

Batch query data of a specified metric at a specified granularity in a specified time range.

Querying the Host Configuration

Query the server configuration for a specified event type in a specified time range. You can specify the dimension of data to be queried.

Quota Management

Querying Quotas

Query the alarm rule quota.

Resource Groups

Querying Resources in a Resource Group

Query resources in resource groups by resource group ID.

Creating a Resource Group

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.

Updating a Resource Group

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.

Deleting a Resource Group

Delete a resource group.

Query Resource Groups

Query all resource groups you created.

Event Monitoring

Reporting Events

Report custom events.

Querying Events

Query events, including system events and custom events.

Querying Details of an Event

Query details of an event based on its name.

API V2

Alarm Rules

Creating an Alarm Rule (Recommended)

Create an alarm rule.

Batch Deleting Alarm Rules

Delete alarm rules in batches.

Enabling or Disabling Alarm Rules in Batches

Enable or disable alarm rules in batches.

Querying Alarm Rules (Recommended)

Query the alarm rule list.

Monitored Resources

Batch Adding Resources to an Alarm Rule

Batch add monitored resources to an alarm rule. (Alarm rules for resources in resource groups are excluded.)

Batch Deleting Resources from an Alarm Rule

Batch delete monitored resources from an alarm rule. (Alarm rules for resources in resource groups are excluded.)

Querying Resources in an Alarm Rule

Query resources in an alarm rule based on the alarm rule ID.

Alarm Policies

Modifying All Fields in an Alarm Policy

Modify policies in an alarm rule.

Querying Alarm Policies

Query alarm policies based on the alarm rule ID.

Alarm Notifications

Modifying Alarm Notification Information in an Alarm Rule

Modify alarm notification information in an alarm rule.

Alarm Records

This API is used to query alarm records.

Query alarm records.

Alarm Templates

Creating a Custom Alarm Template

Create a custom alarm template.

Deleting Custom Alarm Templates in Batches

Delete custom templates in batches.

This API is used to modify a custom template.

Modify a custom template.

Querying Alarm Templates

Query alarm templates.

Querying Details of an Alarm Template

Query the alarm template details.

Alarm Rules Associated with an Alarm Template

Querying Alarm Rules Associated with an Alarm Template

Query alarm rules associated with an alarm template.

Resource Groups

Creating a Resource Group (Recommended)

Create a resource group.

This API is used to delete resource groups in batches.

Delete resource groups in batches.

Modifying a Resource Group

Modify a resource group.

Querying Details of a Resource Group

Query details of a resource group.

Querying Resource Groups

Query resource groups.

Asynchronously Associating a Resource Group with a Custom Alarm Template

Submit an asynchronous task for batch associating custom alarm templates with a resource group. This process will create alarm rules to replace existing ones.

Resource Association in a Resource Group

Batch Adding Resources to a Resource Group

Batch add resources to a custom resource group.

Batch Deleting Resources from a 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

Enabling 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.

Querying Alarm Rules of a Service in One-Click Monitoring

Query alarm rules of a service in one-click monitoring.

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

Batch enable or disable alarm rules for a service in one-click monitoring.

Batch Disabling One-Click Motoring

Batch disable one-click motoring.

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

Batch modify alarm notifications in alarm rules for one service that has one-click monitoring enabled.

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

Batch enable or disable alarm policies in alarm rules for one service that has one-click monitoring enabled.

Alarm Masking

Creating Alarm Masking Rules in Batches

Create alarm masking rules in batches.

Modifying the Masking Time of Alarm Masking Rules in Batches

Modify the masking duration of alarm masking rules in batches.

Modifying an Alarm Masking Rule

Modify an alarm masking rule.

Deleting Alarm Masking Rules in Batches

Delete alarm masking rules in batches.

Querying Alarm Masking Rules

Query alarm masking rules of a specified type in batches. Currently, a maximum of 100 masking rules can be queried in batches.

Querying Resources for Which an Alarm Masking Rule Is Applied

Query resources for which alarm notifications have been masked.

Dashboards

Creating or Copying a Dashboard

Create or copy a dashboard.

Querying Dashboards

Query dashboards.

Modifying a Dashboard

Modify a dashboard.

Deleting Dashboards in Batches

Delete dashboards in batches.

Graphs

Creating, Copying, or Batch Creating Graphs on a Dashboard

Create, copy, or batch create graphs on a dashboard.

Querying Graphs Added to a Dashboard

Query graphs added to a dashboard.

Querying Information About a Graph

Query information about a graph.

Deleting a Graph

Delete a graph.

Updating Graphs in Batches

Update graphs in batches.

Resource Tag Management

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

Query tags of a type of resources in a Cloud Eye project.

Metric Management

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

Querying Agent Statuses in Batches

Query the Agent (including the UniAgent) statuses.

Agent Task-related APIs

Querying the Agent Maintenance Tasks

Query the Agent tasks.

Creating Agent maintenance Tasks in Batches

Batch create Agent tasks.