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
APIs V1	API versions	Querying All API Versions	List all API versions supported by Cloud Eye.
	API versions	Querying a Specific API Version	Query a specified API version of Cloud Eye.
	Metrics	Querying the Metrics	List metrics supported by Cloud Eye.
	Alarm rules	Querying Alarm Rules (V1)	List alarm rules.
		Querying an Alarm Rule	Query an alarm rule based on its ID.
		Enabling or Disabling an Alarm Rule	Enable or disable an alarm rule based on its ID.
		Deleting an Alarm Rule	Delete an alarm rule based on its ID.
		Creating an Alarm Rule (V1)	Create an alarm rule for a metric.
		Creating a Custom Alarm Template	Create a custom alarm template to add alarm rules for one or more metrics.
		Deleting a Custom Alarm Template	Delete a custom alarm template.
		Querying Alarm History	Query the alarm history based on the alarm ID.
		Querying Custom Alarm Templates	List 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 monitoring data of a specified metric at 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 monitoring data of specified metrics at a specified granularity in a specified time range. You can query up to 10 metrics in a batch.
		Querying Server Configuration Data	Query the host configuration of a specified event type in a specified time range. 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 you created.
	Event monitoring	Reporting an Event	Report a custom event.
		Querying Events	List events, including system events and custom events.
		Querying the Monitoring Details of an Event	Query details of an event based on its name.
APIs 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)	List alarm rules.
	Monitored resources	Batch Adding Resources to an Alarm Rule	Batch add resources to an alarm rule. (Alarm rules of resources in resource groups are not supported.)
		Batch Deleting Resources from an Alarm Rule	Batch delete resources in an alarm rule. (Alarm rules of resources in resource groups are not supported.)
		Querying Resources in an Alarm Rule	List resources of an alarm rule based on the alarm rule ID.
	Alarm policies	Modifying All Fields in an Alarm Policy	Modify all alarm policies in an alarm rule.
	Alarm policies	Querying Alarm Policies	List 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	List 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	List alarm templates.
		Querying Details of an Alarm Template	Query details about an alarm template.
	Alarm rules associated with an alarm template	Querying Alarm Rules Associated with an Alarm Template	List 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 about a resource group.
		Querying Resource Groups	List 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 associated with a resource group	Batch Adding Resources to a Resource Group	Batch add resources to a resource group to which resources are manually added.
		Batch Deleting Resources from a Resource Group	Batch remove associated resources from a resource group to which resources are manually added.
		Querying Resources of a Specified Dimension and a Specified Service Type in a Resource Group	List resources of a specified dimension and a specified service 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	List services and resources with one-click monitoring enabled.
		Querying Alarm Rules of One Service in One-Click Monitoring	List alarm rules for a service with one-click monitoring enabled.
		Batch Enabling or Disabling Alarm Rules for One Service in One-Click Monitoring	Batch enable or disable alarm rules for a service with one-click monitoring enabled.
		Batch Disabling One-Click Monitoring	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 a service with 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 a service with 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	List alarm masking rules.
		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	List dashboards.
		Modifying a Dashboard	Modify a dashboard.
		Deleting Dashboards in Batches	Batch delete dashboards.
	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	List 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	Batch update graphs.
	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.
	Metrics	Querying Server Monitoring Metrics from Different Dimensions	Query metrics in batches.
APIs V3	Agent statuses	Querying Agent Statuses in Batches	Query the Agent (including the uniagent) status.
	Agent tasks	Querying the Agent Maintenance Tasks	List Agent tasks.
	Agent tasks	Creating Agent maintenance Tasks in Batches	Batch create Agent tasks.

Previous topic: Before You Start

Next topic: Calling APIs

API Overview

What is your overall rating for this page?