nav-img
Advanced

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.

Table 1 API description

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.

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

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.

Enable or disable alarm rules in batches.

Query alarm rules.

Monitored resources

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

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

Query alarm rules based on the alarm rule IDs.

Alarm policies

Modify all fields in an alarm rule.

Query alarm policies based on the alarm rule ID.

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.

Query resources of a specified dimension for a specified resource type in a resource group.

Metrics

Query metrics by disk, mount point, process, graphics card, or RAID controller based on the ECS or BMS ID.