Updated on 2023-05-06 GMT+08:00

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 version management

Querying All API Versions

Query all API versions supported by Cloud Eye.

Querying a Specified API Version

Query a specified API version supported by Cloud Eye.

Metric management

Querying Metrics

Query the list of metrics that currently monitored by Cloud Eye.

Alarm rule management

Querying Alarm Rules

Query the alarm rule list.

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

Create an alarm rule.

Monitoring data management

Querying Monitoring Data

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

Adding Monitoring Data

Add one or more pieces of metric monitoring data.

Querying the Host Configuration

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

Quota management

Querying Quotas

Query the alarm rule quota.

Event monitoring

Reporting Events

Report custom events.

API V2

Alarm rule

Creating an Alarm Rule

Create an alarm rule.

Deleting Alarm Rules in Batches

Delete alarm rules in batches.

Enabling or Disabling Alarm Rules in Batches

Enable or disable alarm rules in batches.

Querying Alarm Rules

Query alarm rules.

Adding Alarm Rules in Batches

Add alarm rules in batches. (Alarm rules for resources in resource groups are not excluded.)

Deleting Alarm Rules in Batches

Delete alarm rules in batches. (Alarm rules for resources in resource groups are excluded.)

Querying Alarm Rules

Query cloud service resources configured in an alarm rule based on the alarm rule ID.

Modify Policies in an Alarm Rule

Modify policies in an alarm rule.

Querying Alarm Policies

Query alarm policies based on the alarm rule ID.

Alarm records

Querying Alarm Records.

Query alarm records.

Metric management

Querying Server Monitoring Metrics

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