API Overview

Updated on 2025-02-27 GMT+08:00

View PDF

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	Querying All API Versions	Query all API versions supported by Cloud Eye.
	API versions	Querying a Specified API Version	Query a specified API version of Cloud Eye.
	Metrics	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 alarm rules 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 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 of a Metric	Query the 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 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 host configuration for 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 based on the 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 the event name.
API V2	Alarm rules	Creating an Alarm Rule (Recommended)	Create an alarm rule.
		Deleting Alarm Rules in Batches	Delete alarm rules in batches.
		Enabling or Disabling Alarm Rules in Batches	Batch enable or disable alarm rules.
		Querying Alarm Rules (Recommended)	Query the alarm rule list.
	Monitored resources	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 policies in an alarm rule.
	Alarm policies	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 template.
		Deleting Custom Alarm Templates in Batches	Delete custom templates in batches.
		Modifying a Custom Alarm 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	This API is used to create a resource group (recommended).	Create a resource group.
		Batch Deleting Resource Groups	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.
	Resources 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 One Service in One-Click Monitoring	Query alarm rules of a service in one-click monitoring.
		Batch Enabling or Disabling Alarm Rules of 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 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 notification masking rules of a specified type in batches. Currently, a maximum of 100 notification masking rules can be queried in batches.
		Querying Resources for Which Alarm Notifications Have Been Masked	Query resources for which alarm notifications have been masked.
	Dashboards	This API is used to create or copy a dashboard.	Create or copy a dashboard.
		Querying Dashboards	Query dashboards.
		Modifying a Dashboard	Modify a dashboard.
		This API is used to delete dashboards in batches.	Delete dashboards in batches.
	Graphs	This API is used to create, copy, or batch create 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.
API V3	Agent statuses	Querying Agent Statuses in Batches	Query the Agent (including the UniAgent) statuses.
	Agent tasks	Querying the Agent Maintenance Tasks	Query the Agent tasks.
	Agent tasks	Creating Agent maintenance Tasks in Batches	Batch create Agent tasks.