API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (Cms/2019-01-01) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
API standard and SDKs
The OpenAPI specification for Cloud Monitor (Cms/2019-01-01) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages that handle low-level tasks such as request signing. These SDKs let you call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If the SDK does not support your specific needs, such as a customized signature, you can manually sign requests using the signature mechanism. Manual signing typically requires about 5 business days of development effort. For support, join the DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk.
To call APIs securely:
Create a RAM user with API access only.
Configure AccessKey pairs for the RAM user.
Implement the principle of least privilege (PoLP) through RAM policies.
Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
Cloud service metrics
| API | Description |
|---|---|
| DescribeProjectMeta | Queries the information about monitored services in CloudMonitor. |
| DescribeMetricMetaList | Queries the details of metrics supported in CloudMonitor. |
| DescribeMetricList | Queries monitoring data for a specific metric of a cloud service. |
| DescribeMetricData | Queries the monitoring data of a metric for a cloud service. |
| DescribeMetricLast | Queries the latest monitoring data of a metric. |
| DescribeMetricTop | Queries the latest monitoring data of a metric for a cloud service, sorted by a specified order. |
Custom metrics
| API | Description |
|---|---|
| PutCustomMetric | Reports monitoring data. |
| DeleteCustomMetric | Deletes the reported monitoring data of a metric. |
| DescribeCustomMetricList | Queries the reported monitoring data. |
Data export
| API | Description |
|---|---|
| Cursor | Defines the range of monitoring data to export. Returns the Cursor information required by the BatchExport operation. |
| BatchExport | Exports the monitoring data defined in the Cursor operation. |
| PutExporterRule | Creates or modifies a data export rule. |
| DeleteExporterRule | Deletes a data export rule. |
| DescribeExporterRuleList | Queries a list of data export rules. |
| PutExporterOutput | Creates or modifies a configuration set for exporting monitoring data. |
| DeleteExporterOutput | Deletes a configuration set that is used to export monitoring data. |
| DescribeExporterOutputList | Queries configuration sets that are used to export monitoring data. |
Alert service
Alert contacts and contact groups
| API | Description |
|---|---|
| PutContact | Creates or modifies an alert contact. |
| DeleteContact | Deletes an alert contact. |
| DescribeContactList | Queries alert contacts. |
| DescribeContactListByContactGroup | Queries the alert contacts in an alert contact group. |
| PutContactGroup | Creates or modifies an alert contact group. |
| DeleteContactGroup | Deletes an alert contact group. |
| DescribeContactGroupList | Queries a list of alarm contact groups. |
Alert templates
| API | Description |
|---|---|
| CreateMetricRuleTemplate | Creates an alert template. |
| ModifyMetricRuleTemplate | Modifies an alert template. |
| DeleteMetricRuleTemplate | Deletes an alert template. |
| DescribeMetricRuleTemplateAttribute | Queries the details of an alert template. |
| DescribeMetricRuleTemplateList | Queries alert templates. |
| ApplyMetricRuleTemplate | Applies an alert template to an application group to generate alert rules. |
Threshold-triggered alert rules
| API | Description |
|---|---|
| PutResourceMetricRule | Configures an alert rule. |
| PutResourceMetricRules | Creates multiple alert rules for the specified metric of a resource. |
| PutGroupMetricRule | Creates or modifies an alert rule in a specified application group. |
| CreateGroupMetricRules | Creates multiple alert rules for an application group. |
| PutCustomMetricRule | Creates a custom alert rule. |
| DeleteMetricRules | Deletes one or more alert rules. |
| EnableMetricRules | Enables alert rules. |
| DisableMetricRules | Disables alert rules. |
| DescribeMetricRuleList | Queries a list of alert rules. |
| DescribeMetricRuleCount | Queries the number of alert rules in each state. |
| DescribeActiveMetricRuleList | Queries the details of initiative alert rules. |
| DescribeProductsOfActiveMetricRule | Queries the cloud services for which the initiative alert feature is enabled. |
| EnableActiveMetricRule | Enables the initiative alert feature for a cloud service. |
| DisableActiveMetricRule | Disables the initiative alert feature for a cloud service. |
| DescribeAlertingMetricRuleResources | Queries the resources for which active alerts are triggered based on an alert rule. |
Alert rule resources and targets
| API | Description |
|---|---|
| CreateMetricRuleResources | Associates resources with an alert rule. |
| DeleteMetricRuleResources | Disassociates resources from an alert rule. |
| PutMetricRuleTargets | Adds or modifies the push channels of an alert rule. |
| DeleteMetricRuleTargets | Deletes the push channels of an alert rule. |
| DescribeMetricRuleTargets | Queries the resources associated with a specified alert rule. |
Event-triggered alert rules
| API | Description |
|---|---|
| PutEventRule | Creates or modifies an event-triggered alert rule. |
| PutCustomEventRule | Creates a custom event-triggered alert rule. |
| DeleteEventRules | Deletes one or more event-triggered alert rules. |
| EnableEventRules | Enables one or more event rules. |
| DisableEventRules | Disables one or more event-triggered alert rules. |
| DescribeEventRuleAttribute | Queries the details of a specified event-triggered alert rule. |
| DescribeEventRuleList | Queries event-triggered alert rules. |
| PutEventRuleTargets | Adds or modifies the push channels of an event-triggered alert rule. |
| DeleteEventRuleTargets | Deletes the push channels of an event-triggered alert rule. |
| DescribeEventRuleTargetList | Queries event-triggered alert rules. |
Alert blacklists
| API | Description |
|---|---|
| CreateMetricRuleBlackList | Creates a blacklist policy. |
| ModifyMetricRuleBlackList | Modifies a blacklist policy. |
| DeleteMetricRuleBlackList | Deletes multiple blacklist policies at a time. |
| EnableMetricRuleBlackList | Enables or disables multiple blacklist policies at a time. |
| DescribeMetricRuleBlackList | Queries blacklist policies. |
Alert history
| API | Description |
|---|---|
| DescribeAlertLogList | Queries the alert history. |
| DescribeAlertLogCount | Queries the statistics of alert logs. |
| DescribeAlertLogHistogram | Queries the number of alert logs generated during each interval within a time period. |
| DescribeAlertHistoryList | Queries historical alerts. |
Event monitoring
System events
| API | Description |
|---|---|
| DescribeSystemEventAttribute | Queries the details of a system event. |
| DescribeSystemEventCount | Queries the number of times a system event of a cloud service has occurred. |
| DescribeSystemEventHistogram | Queries the number of times a system event occurred during each interval within a time period. |
| DescribeSystemEventMetaList | Queries the meta information about system events. |
| SendDryRunSystemEvent | Debugs a system event of an Alibaba Cloud service. |
Custom events
| API | Description |
|---|---|
| PutCustomEvent | Reports custom events. |
| DescribeCustomEventAttribute | Queries the details of a custom event. |
| DescribeCustomEventCount | Queries the number of times a custom event occurred within a time period. |
| DescribeCustomEventHistogram | Queries the number of times a custom event occurred during each interval within a time period. |
Site monitoring
Manage site monitoring tasks
| API | Description |
|---|---|
| CreateSiteMonitor | Creates a site monitoring task. |
| ModifySiteMonitor | Modifies a site monitoring task. |
| DeleteSiteMonitors | Deletes one or more site monitoring tasks. |
| EnableSiteMonitors | Enables site monitoring tasks. |
| DisableSiteMonitors | Disables site monitoring tasks. |
| DescribeSiteMonitorAttribute | Queries the details of a site monitoring task. |
| DescribeSiteMonitorList | Queries site monitoring tasks. |
Site monitoring data and statistics
| API | Description |
|---|---|
| DescribeSiteMonitorData | Queries the fine-grained monitoring data of a site monitoring task. |
| DescribeSiteMonitorStatistics | Queries the statistics of a specified metric for a site monitoring task. |
| DescribeSiteMonitorQuota | Queries the quotas and version of site monitoring. |
| DescribeSiteMonitorISPCityList | Queries the detection points provided by carriers. |
Instant detection and synthetic monitoring
| API | Description |
|---|---|
| CreateInstantSiteMonitor | Creates a one-time detection task. |
| BatchCreateInstantSiteMonitor | Creates a batch of site monitoring tasks. |
| DescribeSiteMonitorLog | Queries the detection logs for a one-time detection task. |
| DescribeSyntheticProbeList | Queries a list of detection points. |
Host monitoring
Agent management
| API | Description |
|---|---|
| InstallMonitoringAgent | Installs the CloudMonitor agent on specified Alibaba Cloud hosts. |
| UninstallMonitoringAgent | Uninstalls the CloudMonitor agent from a third-party host. |
| DescribeMonitoringAgentHosts | Queries a list of all hosts, regardless of whether the CloudMonitor agent is installed. |
| DescribeMonitoringAgentStatuses | Queries the running status of the CloudMonitor agent. |
| DescribeMonitoringAgentAccessKey | Queries the AccessKey ID and AccessKey secret required to install the CloudMonitor agent on a third-party host. |
| DescribeMonitoringAgentConfig | Queries the configurations of the CloudMonitor agent. |
| ModifyHostInfo | Modifies the display information for a non-Alibaba Cloud host. |
Agent configuration
| API | Description |
|---|---|
| DescribeMonitoringConfig | Queries the global configurations of the CloudMonitor agent. |
| PutMonitoringConfig | Configures global settings for the CloudMonitor agent. |
Process monitoring
| API | Description |
|---|---|
| CreateMonitorAgentProcess | Creates a task to monitor a process. |
| CreateMonitoringAgentProcess | Creates a task to monitor a process. |
| DeleteMonitoringAgentProcess | Disables monitoring on a process. |
| DescribeMonitoringAgentProcesses | Queries the list of processes for a specified resource. |
Application groups
Manage application groups
| API | Description |
|---|---|
| CreateMonitorGroup | Creates an application group. |
| CreateMonitorGroupByResourceGroupId | Creates an application group by using a resource group. |
| ModifyMonitorGroup | Modifies an application group. |
| DeleteMonitorGroup | Deletes an application group. |
| DescribeMonitorGroups | Queries a list of application groups. |
| 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. |
Application group instances
| API | Description |
|---|---|
| CreateMonitorGroupInstances | Adds resources to an application group. |
| ModifyMonitorGroupInstances | Modifies the resources in an application group. |
| DeleteMonitorGroupInstances | Removes instances from an application group. |
| DescribeMonitorGroupInstances | Queries the resources in an application group. |
| DescribeMonitorGroupInstanceAttribute | Queries the details of the resources in an application group. |
Dynamic rules for application groups
| API | Description |
|---|---|
| PutMonitorGroupDynamicRule | Creates or modifies an alert rule to dynamically add instances that meet the rule to an application group. |
| DeleteMonitorGroupDynamicRule | Deletes a rule that dynamically adds service instances to an application group. |
| DescribeMonitorGroupDynamicRules | Queries the dynamic rules of an application group. |
Alert notification policies for application groups
| API | Description |
|---|---|
| CreateMonitorGroupNotifyPolicy | Creates a policy to pause alert notifications for an application group. |
| DeleteMonitorGroupNotifyPolicy | Deletes a policy that pauses alert notifications for an application group. |
| DescribeMonitorGroupNotifyPolicyList | Queries the policies that pause alert notifications for an application group. |
Process monitoring for application groups
| API | Description |
|---|---|
| CreateGroupMonitoringAgentProcess | Creates a process monitoring task for an application group. |
| ModifyGroupMonitoringAgentProcess | Modifies the process monitoring settings for an application group. |
| DeleteGroupMonitoringAgentProcess | Deletes a process monitoring task for an application group. |
| DescribeGroupMonitoringAgentProcess | Queries the process monitoring tasks for an application group. |
Tags
| API | Description |
|---|---|
| AddTags | Attaches tags to specified application groups. |
| RemoveTags | Removes one or more tags. |
| DescribeTagKeyList | Queries a list of tag keys. |
| DescribeTagValueList | Queries the tag values for a specified tag key. |
| DescribeProductResourceTagKeyList | Queries all tag keys of cloud resources in a specified region. |
| CreateDynamicTagGroup | Creates application groups automatically based on tags. |
| DeleteDynamicTagGroup | Deletes a tag rule. |
| DescribeDynamicTagRuleList | Queries the rules for dynamic tags. |
Availability monitoring
| API | Description |
|---|---|
| CreateHostAvailability | Creates an availability monitoring task. |
| ModifyHostAvailability | Modifies an availability monitoring task. |
| DeleteHostAvailability | Deletes one or more availability monitoring tasks. |
| EnableHostAvailability | Enables one or more availability monitoring tasks. |
| DisableHostAvailability | Disables one or more availability monitoring tasks. |
| DescribeHostAvailabilityList | Queries availability monitoring tasks. |
| DescribeUnhealthyHostAvailability | Queries a list of unhealthy servers. |
Log monitoring
| API | Description |
|---|---|
| PutLogMonitor | Creates or modifies a log monitoring metric. |
| DeleteLogMonitor | Deletes a log monitoring metric. |
| DescribeLogMonitorAttribute | Queries the details of a log monitoring task. |
| DescribeLogMonitorList | Queries log monitoring metrics. |
Hybrid Cloud Monitoring
Namespaces
| API | Description |
|---|---|
| CreateHybridMonitorNamespace | Creates a namespace. |
| ModifyHybridMonitorNamespace | Modifies a namespace. |
| DeleteHybridMonitorNamespace | Deletes a namespace. |
| DescribeHybridMonitorNamespaceList | Queries a list of namespaces and the details of their data sources. |
Metric import tasks
| API | Description |
|---|---|
| CreateHybridMonitorTask | Creates a data import task for a cloud service or a metric from Simple Log Service (SLS) logs. |
| ModifyHybridMonitorTask | Modifies a metric for the logs imported from Log Service. |
| DeleteHybridMonitorTask | Deletes a metric import task for cloud services or a metric for logs imported from Log Service. |
| DescribeHybridMonitorTaskList | Queries metric import tasks. |
| DescribeHybridMonitorDataList | Queries the monitoring data in a namespace. |
| PutHybridMonitorMetricData | Imports the monitoring data of a metric to a Hybrid Cloud Monitoring namespace. |
Logstore groups
| API | Description |
|---|---|
| CreateHybridMonitorSLSGroup | Creates a Logstore group for Hybrid Cloud Monitoring. |
| ModifyHybridMonitorSLSGroup | Modifies a Logstore group. |
| DeleteHybridMonitorSLSGroup | Deletes a Logstore group. |
| DescribeHybridMonitorSLSGroup | Queries Logstore groups. |
Other operations
| API | Description |
|---|---|
| DescribeMonitorResourceQuotaAttribute | Queries the resource quotas of CloudMonitor. |
| OpenCmsService | Activates the CMS pay-as-you-go service. |