API overview-阿里云帮助中心

This topic lists all Cloud Monitor APIs and their descriptions.

Note

The call frequency for a single API is limited to 20 calls per second. This limit is shared between an Alibaba Cloud account and all Resource Access Management (RAM) users under that account.
The API request data size is limited as follows:
- HTTP Request Header + Query ≤ 128 KB
- HTTP Request Body ≤ 512 KB
- HTTP Response ≤ 2048 KB

Application groups

API	Description
CreateMonitorGroup	Call the CreateMonitorGroup operation to create an application group.
CreateMonitorGroupInstances	Call the CreateMonitorGroupInstances operation to add specified resources to an application group.
CreateMonitorGroupByResourceGroupId	Call the CreateMonitorGroupByResourceGroupId operation to create an application group from a resource group.
CreateMonitorGroupNotifyPolicy	Call the CreateMonitorGroupNotifyPolicy operation to create a policy to pause alert notifications for an application group.
CreateGroupMonitoringAgentProcess	Call the CreateGroupMonitoringAgentProcess operation to create a process monitoring task for a group.
PutMonitorGroupDynamicRule	Call the PutMonitorGroupDynamicRule operation to create or modify a dynamic alert rule for an application group.
ModifyMonitorGroupInstances	Call the ModifyMonitorGroupInstances operation to modify the resources in an application group.
ModifyMonitorGroup	Call the ModifyMonitorGroup operation to modify an application group.
ModifyGroupMonitoringAgentProcess	Call the ModifyGroupMonitoringAgentProcess operation to modify a process monitoring task in an application group.
DescribeMonitorGroupDynamicRules	Call the DescribeMonitorGroupDynamicRules operation to query the list of dynamic rules for a specified application group.
DescribeMonitorGroupInstanceAttribute	Call the DescribeMonitorGroupInstanceAttribute operation to query the resource details of an application group.
DescribeMonitorGroupCategories	Call the DescribeMonitorGroupCategories operation to query the resource list and the resource count of each Alibaba Cloud service for a specified application group.
DescribeMonitorGroups	Call the DescribeMonitorGroups operation to query a list of application groups.
DescribeMonitorGroupInstances	Call the DescribeMonitorGroupInstances operation to query the list of resources contained in a specified application group.
DescribeGroupMonitoringAgentProcess	Call the DescribeGroupMonitoringAgentProcess operation to obtain a list of process monitoring tasks for a group.
DescribeMonitorGroupNotifyPolicyList	Call the DescribeMonitorGroupNotifyPolicyList operation to query the list of policies for pausing alert notifications for an application group.
DeleteMonitorGroupNotifyPolicy	Call the DeleteMonitorGroupNotifyPolicy operation to delete a policy that pauses alert notifications for a specified application group.
DeleteMonitorGroupInstances	Call the DeleteMonitorGroupInstances operation to delete resource instances from an application group.
DeleteMonitorGroupDynamicRule	Call the DeleteMonitorGroupDynamicRule operation to delete a dynamic rule from a specified application group.
DeleteMonitorGroup	Call the DeleteMonitorGroup operation to delete a specified application group.
DeleteGroupMonitoringAgentProcess	Call the DeleteGroupMonitoringAgentProcess operation to delete a process monitoring task for a group.
CreateGroupMetricRules	Call the CreateGroupMetricRules operation to create alert rules for an application group in a batch.
PutGroupMetricRule	Call the PutGroupMetricRule operation to create or modify an alert rule for an application group.
CreateHostAvailability	Call the CreateHostAvailability operation to create an availability monitoring task.
ModifyHostAvailability	Call the ModifyHostAvailability operation to modify an availability monitoring task.
DeleteHostAvailability	Call the DeleteHostAvailability operation to delete an availability monitoring task.
EnableHostAvailability	Call the EnableHostAvailability operation to enable a specified availability monitoring task.
DescribeHostAvailabilityList	Call the DescribeHostAvailabilityList operation to query a list of availability monitoring tasks.
DescribeUnhealthyHostAvailability	Call the DescribeUnhealthyHostAvailability operation to query a list of servers with abnormal detection results.
DisableHostAvailability	Call the DisableHostAvailability operation to disable a specified availability monitoring task.
AddTags	Call the AddTags operation to create tags for resources.
DescribeTagValueList	Call the DescribeTagValueList operation to query a list of tag values.
DescribeTagKeyList	Call the DescribeTagKeyList operation to query a list of tag keys.
RemoveTags	Call the RemoveTags operation to remove tags.
CreateDynamicTagGroup	Call the CreateDynamicTagGroup operation to create an application group by automatically synchronizing tags from an Alibaba Cloud service.
DescribeProductResourceTagKeyList	Call the DescribeProductResourceTagKeyList operation to obtain a list of all tag keys for cloud resources in a region.
DescribeDynamicTagRuleList	Call the DescribeDynamicTagRuleList operation to query the list of rules for DataQ - Smart Tag Service.
DeleteDynamicTagGroup	Call the DeleteDynamicTagGroup operation to delete a rule of DataQ - Smart Tag Service.

Host monitoring

API	Description
DeleteMonitoringAgentProcess	Call the DeleteMonitoringAgentProcess operation to delete a process monitoring task.
DescribeMonitoringAgentStatuses	Call the DescribeMonitoringAgentStatuses operation to query the running status of the CloudMonitor agent.
DescribeMonitoringAgentProcesses	Call the DescribeMonitoringAgentProcesses operation to query a list of process monitoring tasks.
DescribeMonitoringAgentAccessKey	Call the DescribeMonitoringAgentAccessKey operation to query the AccessKey ID and AccessKey secret required to install the CloudMonitor agent on a server that is not an Alibaba Cloud server.
UninstallMonitoringAgent	Call the UninstallMonitoringAgent operation to uninstall the CloudMonitor agent from a server that is not an Alibaba Cloud server.
InstallMonitoringAgent	Call the InstallMonitoringAgent operation to install the CloudMonitor agent on a specified ECS instance.
CreateMonitoringAgentProcess	Call the CreateMonitoringAgentProcess operation to create a process monitoring task.
DescribeMonitoringAgentHosts	Call the DescribeMonitoringAgentHosts operation to query a list of hosts on which the CloudMonitor agent is installed or not installed.
DescribeMonitoringAgentConfig	Call the DescribeMonitoringAgentConfig operation to query the configuration information of the CloudMonitor agent.
CreateMonitorAgentProcess	Call the CreateMonitorAgentProcess operation to create a process monitoring task.
ModifyHostInfo	Call the ModifyHostInfo operation to modify the display information of a server that is not an Alibaba Cloud server.
DescribeMonitoringConfig	Call the DescribeMonitoringConfig operation to query the global configurations of the CloudMonitor agent.
PutMonitoringConfig	Call the PutMonitoringConfig operation to set the global configurations of the CloudMonitor agent.

Event monitoring

API	Description
SendDryRunSystemEvent	Call the SendDryRunSystemEvent operation to test the system events of a resource.
DescribeSystemEventMetaList	Call the DescribeSystemEventMetaList operation to query the metadata of system events.
DescribeSystemEventCount	Call the DescribeSystemEventCount operation to query the number of events for each Alibaba Cloud service within a specified time period.
DescribeSystemEventAttribute	Call the DescribeSystemEventAttribute operation to query the details of a system event.
DescribeSystemEventHistogram	Call the DescribeSystemEventHistogram operation to query the distribution of system events over time (column chart).
DescribeCustomEventCount	Call the DescribeCustomEventCount operation to query the statistics of custom events.
DescribeCustomEventAttribute	Call the DescribeCustomEventAttribute operation to query the details of a custom event.
PutCustomEvent	Call the PutCustomEvent operation to report the monitoring data of a custom event.
DescribeCustomEventHistogram	Call the DescribeCustomEventHistogram operation to query the distribution of reported custom events over time.

Custom monitoring

API	Description
PutCustomMetric	Call the PutCustomMetric operation to report custom monitoring data.
PutCustomMetricRule	Call the PutCustomMetricRule operation to create an alert rule for custom monitoring.
DescribeCustomMetricList	Call the DescribeCustomMetricList operation to query reported custom monitoring data.
DeleteCustomMetric	Call the DeleteCustomMetric operation to delete reported custom monitoring data.

Log Monitoring

API	Description
DescribeLogMonitorList	Call the DescribeLogMonitorList operation to obtain a list of Log Monitoring tasks.
DescribeLogMonitorAttribute	Call the DescribeLogMonitorAttribute operation to obtain the details of a Log Monitoring task.
DeleteLogMonitor	Call the DeleteLogMonitor operation to delete a Log Monitoring task.
PutLogMonitor	Call the PutLogMonitor operation to create or modify a Log Monitoring task.

Network Analysis and Monitoring

API	Description
DisableSiteMonitors	Call the DisableSiteMonitors operation to disable one or more site monitoring tasks.
DescribeSiteMonitorQuota	Call the DescribeSiteMonitorQuota operation to query the quotas and versions of site monitoring.
DescribeSiteMonitorAttribute	Call the DescribeSiteMonitorAttribute operation to query the details of a site monitoring task.
DeleteSiteMonitors	Call the DeleteSiteMonitors operation to delete detection tasks for site monitoring.
DescribeSiteMonitorISPCityList	Call the DescribeSiteMonitorISPCityList operation to query the list of detection points for creating a task.
DescribeSiteMonitorData	Call the DescribeSiteMonitorData operation to query the fine-grained monitoring data of a task.
DescribeSiteMonitorStatistics	Call the DescribeSiteMonitorStatistics operation to query the average statistics of a specified site monitoring task.
CreateSiteMonitor	Call the CreateSiteMonitor operation to create a monitoring task for site monitoring.
BatchCreateInstantSiteMonitor	Call the BatchCreateInstantSiteMonitor operation to create site monitoring tasks in a batch.
ModifySiteMonitor	Call the ModifySiteMonitor operation to modify a site monitoring task.
EnableSiteMonitors	Call the EnableSiteMonitors operation to enable one or more site monitoring tasks.
DescribeSiteMonitorList	Call the DescribeSiteMonitorList operation to query a list of site monitoring tasks.
CreateInstantSiteMonitor	Call the CreateSiteMonitor operation to create a one-time detection task.
DescribeSiteMonitorLog	Call the DescribeSiteMonitorLog operation to query the detection logs of a one-time detection task.

Cloud service monitoring

API	Description
DescribeProjectMeta	Call the DescribeProjectMeta operation to query the list of metrics supported by Cloud Monitor for Alibaba Cloud services.
DescribeMetricLast	Call the DescribeMetricLast operation to query the latest monitoring data of a specified metric.
DescribeMetricMetaList	Call the DescribeMetricMetaList operation to query the descriptions of metrics provided by Cloud Monitor.
DescribeMetricList	Call the DescribeMetricList operation to query the monitoring data of a specified Alibaba Cloud service.
DescribeMetricData	Call the DescribeMetricData operation to query the monitoring data of an Alibaba Cloud service within a specified time period.
DescribeMetricTop	Call the DescribeMetricTop operation to query the sorted monitoring data of a specified Alibaba Cloud service.
DescribeMonitorResourceQuotaAttribute	Call the DescribeMonitorResourceQuotaAttribute operation to query the quotas of Cloud Monitor resources.

Alert service

API	Description
DescribeAlertHistoryList	Call the DescribeAlertHistoryList operation to query the details of alert history.
DescribeAlertLogCount	Call the DescribeAlertLogCount operation to collect statistics on alert history.
DescribeAlertLogHistogram	Call the DescribeAlertLogHistogram operation to query a list of histograms for alert history.
DescribeAlertLogList	Call the DescribeAlertLogList operation to query alert history.
ApplyMetricRuleTemplate	Call the ApplyMetricRuleTemplate operation to apply an alert template to an application group and generate alert rules.
DescribeMetricRuleTemplateAttribute	Call the DescribeMetricRuleTemplateAttribute operation to query the details of an alert template.
DeleteMetricRuleTemplate	Call the DeleteMetricRuleTemplate operation to delete an alert rule template.
ModifyMetricRuleTemplate	Call the ModifyMetricRuleTemplate operation to modify an alert template.
CreateMetricRuleTemplate	Call the CreateMetricRuleTemplate operation to create an alert template.
DescribeMetricRuleTemplateList	Call the DescribeMetricRuleTemplateList operation to query a list of alert templates.
PutResourceMetricRule	Call the PutResourceMetricRule operation to create a threshold-based alert rule for the performance metrics of a single resource.
PutResourceMetricRules	Call the PutResourceMetricRules operation to create multiple threshold-based alert rules for the metrics of multiple resources.
DeleteMetricRules	Call the DeleteMetricRules operation to delete one or more alert rules.
DescribeMetricRuleCount	Call the DescribeMetricRuleCount operation to obtain the number of alert rules in different states.
EnableMetricRules	Call the EnableMetricRules operation to enable one or more alert rules.
DescribeMetricRuleList	Call the DescribeMetricRuleList operation to query a list of alert rules.
DisableMetricRules	Call the DisableMetricRules operation to disable alert rules.
DescribeAlertingMetricRuleResources	Call the DescribeAlertingMetricRuleResources operation to query the resources that are in the alerting state under a specified alert rule.
PutMetricRuleTargets	Call the PutMetricRuleTargets operation to add or modify the targets of an alert rule.
DescribeMetricRuleTargets	Call the DescribeMetricRuleTargets operation to query the targets associated with an alert rule.
DeleteMetricRuleTargets	Call the DeleteMetricRuleTargets operation to delete the targets of an alert rule.
CreateMetricRuleResources	Call the CreateMetricRuleResources operation to associate a resource with an alert rule.
DeleteMetricRuleResources	Call the DeleteMetricRuleResources operation to disassociate a resource from an alert rule.
DescribeEventRuleAttribute	Call the DescribeEventRuleAttribute operation to query the details of a specified alert rule.
PutEventRuleTargets	Call the PutEventRuleTargets operation to add or modify the sending targets of a rule.
DeleteEventRuleTargets	Call the DeleteEventRuleTargets operation to delete the notification targets of an event-triggered alert rule.
EnableEventRules	Call the EnableEventRules operation to enable one or more event-triggered alert rules.
DescribeEventRuleList	Call the DescribeEventRuleList operation to query a list of event-triggered alert rules.
DeleteEventRules	Call the DeleteEventRules operation to delete event-triggered alert rules.
DisableEventRules	Call the DisableEventRule operation to disable one or more event-triggered alert rules.
PutEventRule	Call the PutEventRule operation to create or modify an alert rule for an event.
DescribeEventRuleTargetList	Call the DescribeEventRuleTargetList operation to query the alert targets of a specified event-triggered alert rule.
PutCustomEventRule	Call the PutCustomEventRule operation to create an alert rule for a custom event.
PutContactGroup	Call the PutContactGroup operation to create or modify an alert contact group.
DescribeContactList	Call the DescribeContactList operation to query a list of alert contacts.
DeleteContact	Call the DeleteContact operation to delete an alert contact.
PutContact	Call the PutContact operation to create or modify the information of an alert contact.
DescribeContactGroupList	Call the DescribeContactGroupList operation to query a list of alert contact groups.
DeleteContactGroup	Call the DeleteContactGroup operation to delete an alert contact group.
DescribeContactListByContactGroup	Call the DescribeContactListByContactGroup operation to query the list of alert contacts in an alert contact group.
DescribeProductsOfActiveMetricRule	Call the DescribeProductsOfActiveMetricRule operation to query the list of Alibaba Cloud services for which one-click alert rules are enabled.
EnableActiveMetricRule	Call the EnableActiveMetricRule operation to enable one-click alert rules.
DescribeActiveMetricRuleList	Call the DescribeActiveMetricRuleList operation to query the list details of one-click alert rules.
DisableActiveMetricRule	Call the DisableActiveMetricRule operation to disable one-click alert rules.

Hybrid Cloud Monitoring

API	Description
PutHybridMonitorMetricData	Call the PutHybridMonitorMetricData operation to report specified monitoring data to a namespace in Hybrid Cloud Monitoring.
CreateHybridMonitorTask	Call the CreateHybridMonitorTask operation to create a data ingestion task for an Alibaba Cloud product or a metric for SLS logs.
ModifyHybridMonitorTask	Call the ModifyHybridMonitorTask operation to modify a metric for SLS logs.
DeleteHybridMonitorTask	Call the DeleteHybridMonitorTask operation to delete a data ingestion task.
DescribeHybridMonitorTaskList	Call the DescribeHybridMonitorTaskList operation to query a list of data ingestion tasks.
CreateHybridMonitorNamespace	Call the CreateHybridMonitorNamespace operation to create a namespace.
ModifyHybridMonitorNamespace	Call the ModifyHybridMonitorNamespace operation to modify a namespace.
DeleteHybridMonitorNamespace	Call the DeleteHybridMonitorNamespace operation to delete a namespace.
DescribeHybridMonitorNamespaceList	Call the DescribeHybridMonitorNamespaceList operation to query a list of namespaces.
CreateHybridMonitorSLSGroup	Call the CreateHybridMonitorSLSGroup operation to create a Logstore group for the metrics of SLS logs.
ModifyHybridMonitorSLSGroup	Call the ModifyHybridMonitorSLSGroup operation to modify a Logstore group.
DeleteHybridMonitorSLSGroup	Call the DeleteHybridMonitorSLSGroup operation to delete a Logstore group.
DescribeHybridMonitorSLSGroup	Call the DescribeHybridMonitorSLSGroup operation to query a list of Logstore groups.
DescribeHybridMonitorDataList	Call the DescribeHybridMonitorDataList operation to query the monitoring data in a specified namespace.
Cursor	Call the Cursor operation to define the scope of monitoring data to export and return a cursor value for the initial call of the BatchExport operation.
BatchExport	Call the BatchExport operation to export the monitoring data defined in the Cursor operation.