The following tables describe the API operations that are available for use in CloudMonitor.
Each API operation can be called up to 20 times per second. Each Alibaba Cloud account and the RAM users within the account share the quota.
The size of an API request and response must conform to the following limits:
HTTP request header + Query ≤ 128 KB
HTTP request body ≤ 512 KB
HTTP response ≤ 2,048 KB
Application groups
API | Description |
Creates an application group. | |
Adds resources to an application group. | |
Creates an application group by using a resource group. | |
Creates a policy to pause alert notifications for an application group. | |
Creates a process monitoring task for an application group. | |
Creates or modifies an alert rule to dynamically add instances that meet the rule to an application group. | |
Changes the resources that are added to an application group. | |
Modifies an application group. | |
Modifies a process monitoring task for an application group. | |
Queries the dynamic rules of an application group. | |
Queries the details of the resources in an application group. | |
Queries the cloud services to which the resources in an application group belong and the number of resources that belong to each cloud service in the application group. | |
Queries application groups. | |
Queries the resources in an application group. | |
Queries the process monitoring tasks for an application group. | |
Queries policies that are used to pause alert notifications for an application group. | |
Deletes a policy that is used to pause alert notifications for an application group. | |
Removes instances from an application group. | |
Deletes a rule that is used to dynamically add the instances of a service to an application group. | |
Deletes an application group. | |
Deletes a process monitoring task for an application group. | |
Creates alert rules for an application group. | |
Creates or modifies an alert rule for an application group. | |
Creates an availability monitoring task. | |
Modifies an availability monitoring task. | |
Deletes availability monitoring tasks. | |
Enables availability monitoring tasks. | |
Queries availability monitoring tasks. | |
Queries unhealthy instances. | |
Disables availability monitoring tasks. | |
Creates tags for resources. | |
Queries tag values. | |
Queries tag keys. | |
Deletes tags. | |
Creates a tag rule based on which instances of cloud services can be automatically added to an application group. | |
Queries the keys of all tags that are attached to cloud resources in a region. | |
Queries tag rules. | |
Deletes a tag rule. |
Host monitoring
API | Description |
Disables monitoring on a process. | |
Queries the status of the CloudMonitor agent. | |
Queries monitored processes. | |
Queries the AccessKey ID and AccessKey secret that are required to install the CloudMonitor agent on a host that is not an Elastic Compute Service (ECS) instance. | |
Uninstalls the CloudMonitor agent from a host that is not provided by Alibaba Cloud. | |
Installs the CloudMonitor agent on an ECS instance. | |
Creates a task to monitor a process. | |
Queries all hosts within the current Alibaba Cloud account, including hosts on which the CloudMonitor agent is installed and uninstalled. | |
Queries the configurations of the CloudMonitor agent. | |
Creates a task to monitor a process. | |
Modifies the information about a host that is not provided by Alibaba Cloud. | |
Queries the global configurations of the CloudMonitor agent. | |
Configures global settings for the CloudMonitor agent. |
Event monitoring
API | Description |
Debugs a system event of an Alibaba Cloud resource. | |
Queries the meta information about system events. | |
Queries the number of times that a system event occurred within a period of time. | |
Queries the details of a system event. | |
Queries the number of times that a system event occurred during each interval within a period of time. | |
Queries the number of times that a custom event occurred within a period of time. | |
Queries the details of a custom event. | |
Reports custom events. | |
Queries the number of times that a custom event occurred during each interval within a period of time. |
Custom monitoring
API | Description |
Reports monitoring data. | |
Creates a custom alert rule. | |
Queries the reported monitoring data. | |
Deletes the reported monitoring data of a metric. |
Log monitoring
API | Description |
Queries log monitoring metrics. | |
Queries the details of a log monitoring metric. | |
Deletes a log monitoring metric. | |
Creates or modifies a log monitoring metric. |
Network Analysis and Monitoring
API | Description |
Disables site monitoring tasks. | |
Queries the quotas and version of site monitoring. | |
Queries the details of a site monitoring task. | |
Deletes site monitoring tasks. | |
Queries the detection points that are available for creating site monitoring tasks. | |
Queries the fine-grained monitoring data of a site monitoring task. | |
Queries the statistics of a site monitoring task within a period of time. | |
Creates a site monitoring task. | |
Creates site monitoring tasks. | |
Modifies a site monitoring task. | |
Enables site monitoring tasks. | |
Queries site monitoring tasks. |
Cloud service monitoring
API | Description |
Queries the metrics of the cloud services that are supported by CloudMonitor. | |
Queries the latest monitoring data of a metric. | |
Queries the descriptions of the metrics that are supported by CloudMonitor. | |
Queries the monitoring data of a cloud service. | |
Queries the monitoring data of a cloud service within a period of time. | |
Queries the sorted data of a metric for a cloud service. | |
Queries the resource quotas of CloudMonitor. |
Alert service
API | Description |
Queries historical alerts. | |
Queries the statistics of alert logs. | |
Queries the number of alert logs that are generated during each interval within a period of time. | |
Queries alert logs. | |
Applies an alert template to an application group to generate an alert rule. | |
Queries the details of an alert template. | |
Deletes an alert template. | |
Modifies an alert template. | |
Creates an alert template. | |
Queries alert templates. | |
Creates an alert rule for a performance metric of a resource. | |
Creates multiple alert rules for the metrics of multiple resources. | |
Deletes alert rules. | |
Queries the number of alert rules in each state. | |
Enables alert rules. | |
Queries alert rules. | |
Disables alert rules. | |
Queries the resources for which active alerts are triggered based on an alert rule. | |
Adds or modifies the resources that are associated with an alert rule. | |
Queries the resources that are associated with an alert rule. | |
Deletes the resources that are associated with an alert rule. | |
Associates resources with an alert rule. | |
Disassociates resources from an alert rule. | |
Queries the details of an alert rule. | |
Adds or modifies the recipients to which alert notifications are sent based on an event-triggered alert rule. | |
Deletes the recipients to which alert notifications are sent based on an event-triggered alert rule. | |
Enables event-triggered alert rules. | |
Queries event-triggered alert rules. | |
Deletes event-triggered alert rules. | |
Disables event-triggered alert rules. | |
Creates or modifies an event-triggered alert rule. | |
Queries the resources that are associated with an event-triggered alert rule. | |
Creates an alert rule for a custom event. | |
Creates or modifies an alert contact group. | |
Queries alert contacts. | |
Deletes an alert contact. | |
Creates or modifies an alert contact. | |
Queries alert contact groups. | |
Deletes an alert contact group. | |
Queries the alert contacts in an alert contact group. | |
Queries the cloud services for which the initiative alert feature is enabled. | |
Enables the initiative alert feature for a cloud service. | |
Queries the details of initiative alert rules. | |
Disables the initiative alert feature for a cloud service. |
Hybrid Cloud Monitoring
API | Description |
Imports the monitoring data of a metric to a namespace of Hybrid Cloud Monitoring. | |
Creates a metric import task for an Alibaba Cloud service or creates a metric for logs imported from Log Service. | |
Modifies a metric for the logs that are imported from Log Service. | |
Deletes a metric import task for Alibaba Cloud services or a metric for the logs that are imported from Log Service. | |
Queries metric import tasks. | |
Creates a namespace. | |
Modifies a namespace. | |
Deletes a namespace. | |
Queries namespaces and the details of the related metric import tasks. | |
Creates a Logstore group for the metrics of Log Service logs. | |
Modifies a Logstore group. | |
Deletes a Logstore group. | |
Queries Logstore groups. | |
Queries the monitoring data in a namespace. | |
Defines the range of monitoring data that you want to export. The Cursor information is returned. When you call the BatchExport operation for the first time, you must specify the Cursor information. | |
Exports the monitoring data that is defined in the Cursor operation. |