API overview-Cloud Monitor(CMS)-阿里云帮助中心

API standards and multilingual preset SDKs

The OpenAPI of this product (Cms/2019-01-01) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.

Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.

Custom signature scenarios

If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.

Account and security preparation

Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.

Application groups

API	Title	Description
Application group management	Application group management
CreateMonitorGroup	Create an application group	Creates an application group.
ModifyMonitorGroup	ModifyMonitorGroup	You can call the ModifyMonitorGroup operation to modify an application group.
DeleteMonitorGroup	Delete a specified application group	Deletes a specified application group.
DescribeMonitorGroups	List application groups	Queries the application groups.
CreateMonitorGroupInstances	Add specified resources to a specified application group	Adds specified resources to a specified application group.
ModifyMonitorGroupInstances	ModifyMonitorGroupInstances	The ModifyMonitorGroupInstances operation modifies the resources in an application group.
DescribeMonitorGroupInstances	DescribeMonitorGroupInstances	Queries the resources in an application group.
DescribeMonitorGroupDynamicRules	DescribeMonitorGroupDynamicRules	Queries the dynamic rules of an application group.
DescribeMonitorGroupInstanceAttribute	DescribeMonitorGroupInstanceAttribute	Queries the resources in an application group.
DeleteMonitorGroupDynamicRule	DeleteMonitorGroupDynamicRule	Deletes a rule that is used to dynamically add the instances of a service to an application group.
DeleteMonitorGroupInstances	Delete resource instances from an application group	Deletes resource instances from an application group.
DescribeMonitorGroupCategories	DescribeMonitorGroupCategories	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.
PutMonitorGroupDynamicRule	Create or modify an application group that dynamically matches instances by name	Creates or modifies an application group that dynamically matches instances by name. All instances that meet the matching rules are automatically added to the application group.
CreateGroupMonitoringAgentProcess	Create group process monitoring	Creates a group process monitoring task.
ModifyGroupMonitoringAgentProcess	Modify process monitoring in an application group	Modifies process monitoring in an application group.
DeleteGroupMonitoringAgentProcess	Delete a group process monitoring task	Deletes a group process monitoring task by calling the DeleteGroupMonitoringAgentProcess operation.
DescribeGroupMonitoringAgentProcess	DescribeGroupMonitoringAgentProcess	Queries the process monitoring tasks for an application group.
CreateMonitorGroupNotifyPolicy	Create a pause alert notification policy for an application group	Calls the CreateMonitorGroupNotifyPolicy operation to create a pause alert notification policy for an application group.
DeleteMonitorGroupNotifyPolicy	Delete the pause alert notification policy of an application group	Calls the DeleteMonitorGroupNotifyPolicy operation to delete the pause alert notification policy for a specified application group.
DescribeMonitorGroupNotifyPolicyList	Query alert notification pause policies for an application group	Queries the list of alert notification pause policies for an application group.
Tags	Tags
AddTags	Attach tags to a specified application group	Attaches tags to a specified application group.
CreateDynamicTagGroup	Create an application group automatically based on tags	Automatically creates an application group based on tags.
DeleteDynamicTagGroup	DeleteDynamicTagGroup	Deletes a tag rule.
DescribeTagValueList	DescribeTagValueList	Queries the tag values for a specified tag key.
DescribeTagKeyList	Query tag key list	Calls the DescribeTagKeyList operation to query a list of tag keys.
DescribeProductResourceTagKeyList	DescribeProductResourceTagKeyList	Call the DescribeProductResourceTagKeyList operation to query all tag keys of cloud resources in a specified region.
DescribeDynamicTagRuleList	DescribeDynamicTagRuleList	Call the DescribeDynamicTagRuleList operation to query the rules for dynamic tags.
RemoveTags	RemoveTags	The RemoveTags operation removes one or more tags.
Availability monitoring	Availability monitoring
CreateHostAvailability	Create an availability monitoring task	Creates an availability monitoring task.
DeleteHostAvailability	Delete a host availability monitoring task	Deletes a host availability monitoring task.
EnableHostAvailability	Enable a specified availability monitoring task	Enables a specified availability monitoring task.
DisableHostAvailability	DisableHostAvailability	Disables one or more specified availability monitoring jobs.
ModifyHostAvailability	Modify an availability monitoring task	Modifies an availability monitoring task.
DescribeUnhealthyHostAvailability	Query servers with abnormal detection results	Queries the list of servers with abnormal detection results.
DescribeHostAvailabilityList	Query availability monitoring tasks	Queries the list of availability monitoring tasks.

Host monitoring

API	Title	Description
InstallMonitoringAgent	Install the cloudMonitor agent on specified Alibaba Cloud hosts	Installs the CloudMonitor agent on specified Alibaba Cloud hosts.
DescribeMonitoringAgentHosts	DescribeMonitoringAgentHosts	You can call the DescribeMonitoringAgentHosts operation to query a list of all hosts, regardless of whether the CloudMonitor agent is installed.
DescribeMonitoringAgentAccessKey	DescribeMonitoringAgentAccessKey	Queries the AccessKey ID and AccessKey secret that are required to install the CloudMonitor agent on a third-party host.
DescribeMonitoringAgentConfig	DescribeMonitoringAgentConfig	Queries the configurations of the CloudMonitor agent.
DescribeMonitoringAgentStatuses	Query the running status of the CloudMonitor agent	Queries the running status of the CloudMonitor agent by calling the DescribeMonitoringAgentStatuses operation.
ModifyHostInfo	Modify the display information of a non-Alibaba Cloud host	Calls the ModifyHostInfo operation to modify the display information of a non-Alibaba Cloud host.
DescribeMonitoringConfig	DescribeMonitoringConfig	Queries the global configurations of the CloudMonitor agent.
PutMonitoringConfig	Set the global configurations of the cloudMonitor agent	Sets the global configurations of the CloudMonitor agent.
UninstallMonitoringAgent	UninstallMonitoringAgent	Uninstalls the CloudMonitor agent from a third-party host.
CreateMonitoringAgentProcess	CreateMonitoringAgentProcess	Creates a task to monitor a process.
CreateMonitorAgentProcess	CreateMonitorAgentProcess	Creates a task to monitor a process.
DescribeMonitoringAgentProcesses	DescribeMonitoringAgentProcesses	Call the DescribeMonitoringAgentProcesses operation to query the list of processes for a specified resource.
DeleteMonitoringAgentProcess	Delete process monitoring from a specified host	Calls the DeleteMonitoringAgentProcess operation to delete the specified process monitoring from a specified host.

Event center

API	Title	Description
System events	System events
DescribeSystemEventHistogram	DescribeSystemEventHistogram	Queries the number of times a system event occurred during each interval within a period of time.
DescribeSystemEventMetaList	Query meta information of system events	Queries the meta information of system events by calling the DescribeSystemEventMetaList operation.
DescribeSystemEventAttribute	Query system event details	Queries the details of system events.
DescribeSystemEventCount	Query the number of events for each Alibaba Cloud service under the current account	Queries the number of events that occurred for each Alibaba Cloud service under the current account.
DescribeMonitorResourceQuotaAttribute	Query cloudMonitor resource quotas	Queries the quotas of various CloudMonitor resources.
SendDryRunSystemEvent	SendDryRunSystemEvent	Debugs a system event of an Alibaba Cloud service.
Custom events	Custom events
DescribeCustomEventCount	DescribeCustomEventCount	Queries the number of times that a custom event occurred within a period of time.
DescribeCustomEventHistogram	DescribeCustomEventHistogram	Queries the number of times that a custom event occurred during each interval within a period of time.
DescribeCustomEventAttribute	Query the details of custom events	Queries the details of custom events.
PutCustomEvent	Report monitoring data for custom events	Reports monitoring data for custom events.

Custom monitoring

API	Title	Description
PutCustomMetric	Report custom monitoring data	Calls the PutCustomMetric operation to report custom monitoring data.
PutCustomMetricRule	Create a custom monitoring alert rule	Creates an alert rule for custom monitoring.
DescribeCustomMetricList	DescribeCustomMetricList	Queries the reported monitoring data.
DeleteCustomMetric	DeleteCustomMetric	Deletes the reported monitoring data of a metric.

Log monitoring

API	Title	Description
PutLogMonitor	Create or modify a log monitoring metric	Creates or modifies a log monitoring metric by calling the PutLogMonitor operation.
DeleteLogMonitor	DeleteLogMonitor	Deletes a log monitoring metric.
DescribeLogMonitorList	DescribeLogMonitorList	Queries log monitoring metrics.
DescribeLogMonitorAttribute	DescribeLogMonitorAttribute	Queries a Log Monitoring task.

Site monitoring

API	Title	Description
CreateMonitorGroupByResourceGroupId	Create an application group by using a resource group	Creates an application group by using a resource group.
CreateSiteMonitor	Create a site monitoring task	Creates a site monitoring task.
CreateInstantSiteMonitor	Create a one-time detection task	Creates a one-time detection task.
BatchCreateInstantSiteMonitor	Create multiple site monitoring tasks	Creates multiple site monitoring tasks in a batch.
DeleteSiteMonitors	Delete site monitoring tasks	Deletes site monitoring tasks.
DisableSiteMonitors	Disable one or more site monitoring tasks	Disables one or more site monitoring tasks by calling the DisableSiteMonitors operation.
ModifySiteMonitor	Modify a site monitoring task	Modifies a site monitoring task.
EnableSiteMonitors	EnableSiteMonitors	Enables site monitoring tasks.
DescribeSiteMonitorQuota	Queries the quota and version of site monitoring	Calls the DescribeSiteMonitorQuota operation to query the quota and version of site monitoring.
DescribeSiteMonitorAttribute	Query the details of a site monitoring task	Queries the details of a site monitoring task.
DescribeSiteMonitorISPCityList	Query details of all carrier detection points	Queries the details of all carrier detection points by calling the DescribeSiteMonitorISPCityList operation.
DescribeSiteMonitorData	DescribeSiteMonitorData	Queries the fine-grained monitoring data of a site monitoring task.
DescribeSiteMonitorStatistics	Queries the average statistics of a specified metric in a specified site monitoring task.	Queries the average statistics of a specified metric in a specified site monitoring task by calling the DescribeSiteMonitorStatistics operation.
DescribeSiteMonitorList	Query site monitoring tasks	Queries the list of site monitoring tasks by calling the DescribeSiteMonitorList operation.
DescribeSiteMonitorLog	DescribeSiteMonitorLog	Call the DescribeSiteMonitorLog operation to query the detection logs for a one-time detection task.

Cloud service monitoring

API	Title	Description
DescribeMetricLast	Query the latest monitoring data of a specified metric	Queries the latest monitoring data of a specified metric.
DescribeMetricList	DescribeMetricList	The DescribeMetricList operation queries the monitoring data of a specific metric for a cloud service.
DescribeMetricData	DescribeMetricData	Queries the monitoring data of a metric for a cloud service.
DescribeMetricMetaList	DescribeMetricMetaList	Queries metrics that are supported in CloudMonitor.
DescribeProjectMeta	Queries the list of cloud services that support time series monitoring metrics in CloudMonitor	Calls the DescribeProjectMeta operation to query the list of cloud services that support time series monitoring metrics in CloudMonitor.
DescribeMetricTop	DescribeMetricTop	Queries the latest monitoring data of a metric for a cloud service. The data can be sorted by a specified order.

Alert service

API	Title	Description
Alert history	Alert history
DescribeAlertLogCount	Query alert history statistics	Queries the statistics of alert history.
DescribeAlertLogList	Queries the alert history	Queries the alert history by calling the DescribeAlertLogList operation.
DescribeAlertLogHistogram	Query the histogram list of alert history	Queries the histogram list of alert history.
One-click alerting	One-click alerting
DescribeProductsOfActiveMetricRule	DescribeProductsOfActiveMetricRule	Queries the cloud services for which the initiative alert feature is enabled.
DescribeActiveMetricRuleList	DescribeActiveMetricRuleList	Queries initiative alert rules.
EnableActiveMetricRule	Enable one-click alert rules	Enables one-click alert rules.
DisableActiveMetricRule	DisableActiveMetricRule	Disables the initiative alert feature for a cloud service.
Alert templates	Alert templates
CreateMetricRuleTemplate	Create an alert template	Creates an alert template.
DeleteMetricRuleTemplate	Delete an alert rule template	Deletes an alert rule template.
ModifyMetricRuleTemplate	ModifyMetricRuleTemplate	Modifies an alert template.
DescribeMetricRuleTemplateAttribute	Query alert template details	Queries the details of an alert template by calling the DescribeMetricRuleTemplateAttribute operation.
DescribeMetricRuleTemplateList	List alert templates	Queries the list of alert templates.
ApplyMetricRuleTemplate	Apply an alert template to an application group	Applies an alert template to an application group to generate alert rules.
Threshold alert rules	Threshold alert rules
DescribeMetricRuleList	Query all rules in the alert rule list	Query all rules in the alert rule list.
CreateGroupMetricRules	Create alert rules in batches for a specified application group	Creates alert rules in batches for a specified application group.
CreateMetricRuleResources	Create a resource associated with an alert rule	Calls the CreateMetricRuleResources operation to create a resource associated with an alert rule.
DeleteMetricRuleTargets	DeleteMetricRuleTargets	Delete the push channels of an alert rule.
DeleteMetricRules	Delete one or more alert rules	Deletes one or more alert rules.
DeleteMetricRuleResources	DeleteMetricRuleResources	Disassociates resources from an alert rule.
EnableMetricRules	Enable one or more alert rules	Enables one or more alert rules.
DisableMetricRules	Disable alert rules	Disables alert rules.
DescribeMetricRuleTargets	Query notification channels of a specified alert rule	Queries the notification channels of a specified alert rule by calling the DescribeMetricRuleTargets operation.
DescribeMetricRuleCount	DescribeMetricRuleCount	Queries the number of alert rules in each state.
DescribeAlertingMetricRuleResources	Query resources with active alerts for a specified alert rule	Queries the list of resources that are triggering alerts for a specified alert rule.
PutMetricRuleTargets	Add or modify push channels for a specified alert rule	Adds or modifies push channels for a specified alert rule by calling the PutMetricRuleTargets operation.
PutResourceMetricRule	Set a threshold-based alert rule for a specified metric of a specified resource	Sets an alert rule.
PutResourceMetricRules	Set multiple threshold alert rules for a specified metric of a specified resource	Sets multiple threshold alert rules for a specified metric of a specified resource.
PutGroupMetricRule	Create or modify an alert rule in a specified application group	Creates or modifies an alert rule in a specified application group.
Event-triggered alert rules	Event-triggered alert rules
DeleteEventRuleTargets	DeleteEventRuleTargets	Deletes the push channels of an event-triggered alert rule.
DeleteEventRules	Delete event-triggered alert rules	Deletes event-triggered alert rules.
EnableEventRules	Enable one or more event monitoring alert rules	Enables one or more event monitoring alert rules.
DisableEventRules	Disable one or more event-triggered alert rules	Disables one or more event-triggered alert rules.
DescribeEventRuleAttribute	Query the details of a specified event-triggered alert rule	Queries the details of a specified event-triggered alert rule by calling the DescribeEventRuleAttribute operation.
DescribeEventRuleList	List event-triggered alert rules	Queries event-triggered alert rules.
DescribeEventRuleTargetList	Query the notification channels of a specified event-triggered alert rule	Queries the list of event-triggered alert rules.
PutEventRuleTargets	Add or modify notification channels of an alert rule	Adds or modifies the notification channels of an event-triggered alert rule by calling the PutEventRuleTargets operation.
PutEventRule	Create or modify an event-triggered alert rule	Creates or modifies an event-triggered alert rule by calling the PutEventRule operation.
PutCustomEventRule	Create an alert rule for a custom event	Calls the PutCustomEventRule operation to create an alert rule for a custom event.
Alert blacklist	Alert blacklist
CreateMetricRuleBlackList	Create an alert blacklist policy	Creates an alert blacklist policy.
ModifyMetricRuleBlackList	Modify an alert blacklist policy	Modifies an alert blacklist policy.
DeleteMetricRuleBlackList	Delete alert blacklist policies	Calls the DeleteMetricRuleBlackList operation to delete alert blacklist policies.
DescribeMetricRuleBlackList	Query alert blacklist policies	Queries the list of alert blacklist policies.
EnableMetricRuleBlackList	EnableMetricRuleBlackList	Enables or disables multiple blacklist policies at a time.
Alert contacts	Alert contacts
DeleteContactGroup	Delete an alert contact group	Deletes an alert contact group.
DeleteContact	Delete an alert contact	Deletes an alert contact.
DescribeContactListByContactGroup	Query alert contacts in an alert contact group	Queries the alert contacts in an alert contact group.
DescribeContactGroupList	Query alert contact groups	Queries the list of alert contact groups by calling the DescribeContactGroupList operation.
DescribeContactList	Query alert contacts	Calls the DescribeContactList operation to query a list of alert contacts.
PutContact	Create or modify alert contact information	Calls the PutContact operation to create or modify alert contact information.
PutContactGroup	Create or modify an alert contact group	Creates or modifies an alert contact group by calling the PutContactGroup operation.

Hybrid Cloud monitoring

API	Title	Description
CreateHybridMonitorNamespace	Create a metric namespace	Creates a metric namespace.
ModifyHybridMonitorNamespace	Modify a metric store	Calls the ModifyHybridMonitorNamespace operation to modify a metric store.
DeleteHybridMonitorNamespace	DeleteHybridMonitorNamespace	Deletes a namespace.
DescribeHybridMonitorNamespaceList	DescribeHybridMonitorNamespaceList	Queries a list of namespaces and the details of their data sources.
CreateHybridMonitorTask	Create a monitoring task	Creates a monitoring task for Alibaba Cloud services or Simple Log Service (SLS) logs.
ModifyHybridMonitorTask	Modify a metric for SLS logs	Modifies a metric for Simple Log Service (SLS) logs.
DeleteHybridMonitorTask	DeleteHybridMonitorTask	Deletes a metric import task for Alibaba Cloud services or a metric for the logs that are imported from Log Service.
DescribeHybridMonitorTaskList	DescribeHybridMonitorTaskList	Queries metric import tasks.
PutHybridMonitorMetricData	Reports monitoring data to a metric namespace	Reports the specified monitoring data to a specified metric namespace of Enterprise CloudMonitor by calling the PutHybridMonitorMetricData operation.
DescribeHybridMonitorDataList	DescribeHybridMonitorDataList	Queries the monitoring data in a namespace.
CreateHybridMonitorSLSGroup	Create a logstore group for SLS log metrics	Creates a Logstore group for Hybrid Cloud Monitoring.
ModifyHybridMonitorSLSGroup	Modify a logstore group	Modifies a Logstore group by calling the ModifyHybridMonitorSLSGroup operation.
DeleteHybridMonitorSLSGroup	DeleteHybridMonitorSLSGroup	Deletes a Logstore group.
DescribeHybridMonitorSLSGroup	Query logstore group list	Queries the list of Logstore groups by calling the DescribeHybridMonitorSLSGroup operation.
Cursor	Define the scope of monitoring data to export	Defines the scope of monitoring data to be exported and returns a cursor value for the initial call to the BatchExport operation.
BatchExport	Export monitoring data defined in cursor	Exports the monitoring data defined in the Cursor operation.

Others

API	Title	Description
DescribeSyntheticProbeList	Query detection points	Queries the list of detection points.