API Overview

API V1

API versions

Querying All API Versions

Query all API versions supported by Cloud Eye.

Querying a Specific API Version

Query an API version supported by Cloud Eye.

Metrics

Querying the Metrics

Query metrics monitored by Cloud Eye.

Alarm rules

Querying Alarm Rules (V1)

Query alarm rules.

Querying an Alarm Rule

Query the alarm rule information based on the alarm rule 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 the alarm rule ID.

Creating an Alarm Rule (V1)

Create an alarm rule.

Creating a Custom Alarm Template

Create a custom alarm template.

Deleting a Custom Alarm Template

Delete a custom alarm template.

Querying Alarm History

Query alarm history based on the alarm rule ID.

Querying Custom Alarm Templates

Query custom alarm templates.

Updating a Custom Alarm Template

Update a custom alarm template.

Modifying an Alarm Rule

Modify an alarm rule.

Monitoring data

Querying Monitoring Data

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

Adding Monitoring Data

Add one or more pieces of metric data.

Querying Monitoring Data in Batches

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 10 metrics in batches.

Querying Server Configuration Data

Query the host configuration for a specified event type in a specified period. You can specify the dimension of data to be queried.

Quotas

Querying Quotas

Query the alarm rule quota.

Resource groups

Querying Resources in a Resource Group

Query resources in a resource group.

Creating a Resource Group

Create a resource group.

Updating a Resource Group

Update a resource group.

Deleting a Resource Group

Delete a resource group.

Querying All Resource Groups

Query all resource groups.

Event monitoring

Reporting an Event

Report custom events.

Querying Events

Query all events, including system events and custom events.

Querying the Monitoring Details of an Event

Query monitoring details of an event based on the event name.

API V2

Alarm rules

Creating an Alarm Rule (Recommended)

Create an alarm rule.

Batch Deleting Alarm Rules

Batch delete alarm rules.

Enabling or Disabling Alarm Rules in Batches

Batch enable or disable alarm rules.

Querying Alarm Rules (Recommended)

Query alarm rules.

Monitored resource

Batch Adding Resources to an Alarm Rule

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

Batch Deleting Resources from an Alarm Rule

Batch delete 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 alarm 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

Querying Alarm Records

Query alarm records.

Alarm templates

Creating a Custom Alarm Template

Create a custom alarm template.

Batch Deleting Custom Alarm Templates

Batch delete custom alarm templates.

Modifying a Custom Alarm Template

Modify a custom alarm template.

Querying Alarm Templates

Query alarm templates.

Querying Details of an Alarm Template

Query details of a template.

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

Create a resource group.

Batch Deleting Resource Groups

Batch delete resource groups.

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.

Resources in a resource group

Batch Adding Resources to a Resource Group

Batch add resources to a resource group whose resources are manually added.

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 One Service in One-Click Monitoring

Query alarm rules of one 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 one service in one-click monitoring.

Batch Disabling One-Click Motoring

Batch disable one-click monitoring.

Batch Modifying Alarm Notifications in Alarm Rules for One Service That Has 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 Policies 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

Creating Alarm Notification Masking Rules in Batches

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.

Modifying an Alarm Notification Masking Rule

Modify an alarm notification masking rule.

Deleting Alarm Notification Masking Rules in Batches

Delete alarm notification masking rules in batches.

Querying Alarm Notification Masking Rules

Query alarm notification masking rules of a specified type in batches.

Querying Resources for Which Alarm Notifications Have Been Masked

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 tags

Querying Tags of a Type of Resources in a Cloud Eye Project

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.

Querying Server Monitoring Metrics from Different Dimensions

Query metrics in batches.

API V3

Agent statuses

Querying Agent Statuses in Batches

Query the Agent (including the uniagent) statuses.

Tasks

Querying the Agent Maintenance Tasks

Query the Agent tasks.

Creating Agent maintenance Tasks in Batches

Batch create Agent tasks.