All Products
Search

This Product

    Cloud Monitor:API overview

    Document Center

    Cloud Monitor:API overview

    Last Updated:Jan 22, 2026

    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.

    Application groups

    API

    Title

    Description
    Manage application groups Manage application groups
    ModifyMonitorGroup ModifyMonitorGroup You can call the ModifyMonitorGroup operation to modify an application group.
    DescribeMonitorGroups DescribeMonitorGroups You can call the DescribeMonitorGroups operation to query a list of application groups.
    ModifyMonitorGroupInstances ModifyMonitorGroupInstances The ModifyMonitorGroupInstances operation modifies the resources in an application group.
    ModifyGroupMonitoringAgentProcess ModifyGroupMonitoringAgentProcess You can call the ModifyGroupMonitoringAgentProcess operation to modify the process monitoring settings for an application group.
    Label Label
    AddTags AddTags The AddTags operation attaches tags to specified application groups.
    CreateDynamicTagGroup CreateDynamicTagGroup You can call the CreateDynamicTagGroup operation to automatically create application groups using tags.
    DescribeTagValueList DescribeTagValueList Queries the tag values for a specified tag key.
    DescribeTagKeyList DescribeTagKeyList Queries 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
    DeleteHostAvailability DeleteHostAvailability Deletes one or more availability monitoring jobs.
    EnableHostAvailability EnableHostAvailability You can call the EnableHostAvailability operation to enable one or more specified availability monitoring jobs.
    DisableHostAvailability DisableHostAvailability Disables one or more specified availability monitoring jobs.
    DescribeUnhealthyHostAvailability DescribeUnhealthyHostAvailability Call the DescribeUnhealthyHostAvailability operation to query a list of unhealthy servers.

    Host monitoring

    API

    Title

    Description
    InstallMonitoringAgent InstallMonitoringAgent Call the InstallMonitoringAgent operation to install 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.
    DescribeMonitoringAgentStatuses DescribeMonitoringAgentStatuses The DescribeMonitoringAgentStatuses operation queries the running status of the CloudMonitor agent.
    ModifyHostInfo ModifyHostInfo Call the ModifyHostInfo operation to modify the display information for a host that is not hosted on Alibaba Cloud.
    DescribeMonitoringAgentProcesses DescribeMonitoringAgentProcesses Call the DescribeMonitoringAgentProcesses operation to query the list of processes for a specified resource.

    Log monitoring

    API

    Title

    Description
    DescribeLogMonitorAttribute DescribeLogMonitorAttribute Queries the details of a Log Monitoring task.

    Site monitoring

    API

    Title

    Description
    CreateSiteMonitor CreateSiteMonitor Creates a site monitoring task.
    CreateInstantSiteMonitor CreateInstantSiteMonitor Call the CreateInstantSiteMonitor operation to create a one-time detection task.
    BatchCreateInstantSiteMonitor BatchCreateInstantSiteMonitor You can call the BatchCreateInstantSiteMonitor operation to create a batch of site monitoring tasks.
    DescribeSiteMonitorAttribute DescribeSiteMonitorAttribute You can call the DescribeSiteMonitorAttribute operation to query the details of a site monitoring task.
    DescribeSiteMonitorList DescribeSiteMonitorList Queries site monitoring tasks.
    DescribeSiteMonitorLog DescribeSiteMonitorLog Call the DescribeSiteMonitorLog operation to query the detection logs for a one-time detection task.

    Cloud products

    API

    Title

    Description
    DescribeMetricList DescribeMetricList Call the DescribeMetricList operation to query monitoring data for a specific metric of a cloud service.
    DescribeExporterRuleList DescribeExporterRuleList The DescribeExporterRuleList operation queries a list of data export rules.
    PutExporterRule PutExporterRule You can call the PutExporterRule operation to create or modify a data export rule.

    Alert service

    API

    Title

    Description
    Alert history Alert history
    DescribeAlertLogList DescribeAlertLogList The DescribeAlertLogList operation queries the alert history.
    Alert templates Alert templates
    DescribeMetricRuleTemplateAttribute DescribeMetricRuleTemplateAttribute Call the DescribeMetricRuleTemplateAttribute operation to query the details of an alert template.
    Threshold-triggered alert rules Threshold-triggered alert rules
    DescribeMetricRuleList DescribeMetricRuleList Queries a list of alert rules.
    CreateGroupMetricRules CreateGroupMetricRules Call the CreateGroupMetricRules operation to create multiple alert rules for an application group.
    DeleteMetricRules DeleteMetricRules The DeleteMetricRules operation deletes one or more alert rules.
    DisableMetricRules DisableMetricRules You can call the DisableMetricRules operation to disable alert rules.
    PutGroupMetricRule PutGroupMetricRule Call the PutGroupMetricRule operation to create or modify an alert rule in a specified application group.
    Event-triggered alert rules Event-triggered alert rules
    DeleteEventRules DeleteEventRules Deletes one or more event-triggered alert rules.
    EnableEventRules EnableEventRules The EnableEventRules operation enables one or more event rules.
    DisableEventRules DisableEventRules Disables one or more event-triggered alert rules.
    DescribeEventRuleAttribute DescribeEventRuleAttribute You can call the DescribeEventRuleAttribute operation to query the details of a specified event-triggered alert rule.
    PutEventRule PutEventRule Call the PutEventRule operation to create or modify an event-triggered alert rule.
    PutCustomEventRule PutCustomEventRule The PutCustomEventRule operation creates a custom event-triggered alert rule.
    Alert blacklists Alert blacklists
    DescribeMetricRuleBlackList DescribeMetricRuleBlackList You can call the DescribeMetricRuleBlackList operation to query blacklist policies.
    Alert contacts Alert contacts
    DescribeContactGroupList Query Alarm Contact Group List Call the DescribeContactGroupList interface to query the list of alarm contact groups.
    PutContactGroup PutContactGroup You can call the PutContactGroup operation to create or modify an alert contact group.

    Hybrid cloud monitoring

    API

    Title

    Description
    DescribeHybridMonitorNamespaceList DescribeHybridMonitorNamespaceList Queries a list of namespaces and the details of their data sources.
    CreateHybridMonitorTask CreateHybridMonitorTask Call the CreateHybridMonitorTask operation to create a data import task for an Alibaba Cloud service or a metric from Simple Log Service (SLS) logs.

    Others

    API

    Title

    Description
    DescribeSyntheticProbeList DescribeSyntheticProbeList Queries a list of detection points.
    ApplyMetricRuleTemplate ApplyMetricRuleTemplate Applies an alert template to an application group to generate an alert rule.
    BatchExport BatchExport Exports the monitoring data that is defined in the Cursor operation.
    CreateGroupMonitoringAgentProcess CreateGroupMonitoringAgentProcess Creates a process monitoring task for an application group.
    CreateHostAvailability CreateHostAvailability Creates an availability monitoring task.
    CreateHybridMonitorNamespace CreateHybridMonitorNamespace Creates a namespace.
    CreateHybridMonitorSLSGroup CreateHybridMonitorSLSGroup Creates a Logstore group of Hybrid Cloud Monitoring.
    CreateMetricRuleBlackList CreateMetricRuleBlackList Creates a blacklist policy.
    CreateMetricRuleResources CreateMetricRuleResources Associates resources with an alert rule.
    CreateMetricRuleTemplate CreateMetricRuleTemplate Creates an alert template.
    CreateMonitorAgentProcess CreateMonitorAgentProcess Creates a task to monitor a process.
    CreateMonitorGroup CreateMonitorGroup Creates an application group.
    CreateMonitorGroupByResourceGroupId CreateMonitorGroupByResourceGroupId Creates an application group by using a resource group.
    CreateMonitorGroupInstances CreateMonitorGroupInstances Adds resources to an application group.
    CreateMonitorGroupNotifyPolicy CreateMonitorGroupNotifyPolicy Creates a policy to pause alert notifications for an application group.
    CreateMonitoringAgentProcess CreateMonitoringAgentProcess Creates a task to monitor a process.
    Cursor Cursor 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.
    DeleteContact DeleteContact Deletes an alert contact.
    DeleteContactGroup DeleteContactGroup Deletes an alert contact group.
    DeleteCustomMetric DeleteCustomMetric Deletes the reported monitoring data of a metric.
    DeleteDynamicTagGroup DeleteDynamicTagGroup Deletes a tag rule.
    DeleteEventRuleTargets DeleteEventRuleTargets Deletes the push channels of an event-triggered alert rule.
    DeleteExporterOutput DeleteExporterOutput Deletes a configuration set that is used to export monitoring data.
    DeleteExporterRule DeleteExporterRule Deletes a data export rule.
    DeleteGroupMonitoringAgentProcess DeleteGroupMonitoringAgentProcess Deletes a process monitoring task for an application group.
    DeleteHybridMonitorNamespace DeleteHybridMonitorNamespace Deletes a namespace.
    DeleteHybridMonitorSLSGroup DeleteHybridMonitorSLSGroup Deletes a Logstore group.
    DeleteHybridMonitorTask DeleteHybridMonitorTask Deletes a metric import task for Alibaba Cloud services or a metric for the logs that are imported from Log Service.
    DeleteLogMonitor DeleteLogMonitor Deletes a log monitoring metric.
    DeleteMetricRuleBlackList DeleteMetricRuleBlackList Deletes multiple blacklist policies at a time.
    DeleteMetricRuleResources DeleteMetricRuleResources Disassociates resources from an alert rule.
    DeleteMetricRuleTargets DeleteMetricRuleTargets Delete the push channels of an alert rule.
    DeleteMetricRuleTemplate DeleteMetricRuleTemplate Deletes an alert template.
    DeleteMonitorGroup DeleteMonitorGroup Deletes an application group.
    DeleteMonitorGroupDynamicRule DeleteMonitorGroupDynamicRule Deletes a rule that is used to dynamically add the instances of a service to an application group.
    DeleteMonitorGroupInstances DeleteMonitorGroupInstances Removes instances from an application group.
    DeleteMonitorGroupNotifyPolicy DeleteMonitorGroupNotifyPolicy Deletes a policy that is used to pause alert notifications for an application group.
    DeleteMonitoringAgentProcess DeleteMonitoringAgentProcess Disables monitoring on a process.
    DeleteSiteMonitors DeleteSiteMonitors Deletes one or more site monitoring tasks.
    DescribeActiveMetricRuleList DescribeActiveMetricRuleList Queries the details of initiative alert rules.
    DescribeAlertHistoryList DescribeAlertHistoryList Queries historical alerts.
    DescribeAlertLogCount DescribeAlertLogCount Queries the statistics of alert logs.
    DescribeAlertLogHistogram DescribeAlertLogHistogram Queries the number of alert logs that are generated during each interval within a period of time.
    DescribeAlertingMetricRuleResources DescribeAlertingMetricRuleResources Queries the resources for which active alerts are triggered based on an alert rule.
    DescribeContactList DescribeContactList Queries alert contacts.
    DescribeContactListByContactGroup DescribeContactListByContactGroup Queries the alert contacts in an alert contact group.
    DescribeCustomEventAttribute DescribeCustomEventAttribute Queries the details of a custom event.
    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.
    DescribeCustomMetricList DescribeCustomMetricList Queries the reported monitoring data.
    DescribeEventRuleList DescribeEventRuleList Queries event-triggered alert rules.
    DescribeEventRuleTargetList DescribeEventRuleTargetList Queries event-triggered alert rules.
    DescribeExporterOutputList DescribeExporterOutputList Queries configuration sets that are used to export monitoring data.
    DescribeGroupMonitoringAgentProcess DescribeGroupMonitoringAgentProcess Queries the process monitoring tasks for an application group.
    DescribeHostAvailabilityList DescribeHostAvailabilityList Queries availability monitoring tasks.
    DescribeHybridMonitorDataList DescribeHybridMonitorDataList Queries the monitoring data in a namespace.
    DescribeHybridMonitorSLSGroup DescribeHybridMonitorSLSGroup Queries Logstore groups.
    DescribeHybridMonitorTaskList DescribeHybridMonitorTaskList Queries metric import tasks.
    DescribeLogMonitorList DescribeLogMonitorList Queries log monitoring metrics.
    DescribeMetricData DescribeMetricData Queries the monitoring data of a metric for a cloud service.
    DescribeMetricLast DescribeMetricLast Queries the latest monitoring data of a metric.
    DescribeMetricMetaList DescribeMetricMetaList Queries the details of metrics that are supported in CloudMonitor.
    DescribeMetricRuleCount DescribeMetricRuleCount Queries the number of alert rules in each state.
    DescribeMetricRuleTargets DescribeMetricRuleTargets Queries the resources that are associated with a specified alert rule.
    DescribeMetricRuleTemplateList DescribeMetricRuleTemplateList Queries alert templates.
    DescribeMetricTop DescribeMetricTop Queries the latest monitoring data of a metric for a cloud service. The data can be sorted by a specified order.
    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.
    DescribeMonitorGroupDynamicRules DescribeMonitorGroupDynamicRules Queries the dynamic rules of an application group.
    DescribeMonitorGroupInstanceAttribute DescribeMonitorGroupInstanceAttribute Queries the details of the resources in an application group.
    DescribeMonitorGroupInstances DescribeMonitorGroupInstances Queries the resources in an application group.
    DescribeMonitorGroupNotifyPolicyList DescribeMonitorGroupNotifyPolicyList Queries the policies that are used to pause alert notifications for an application group.
    DescribeMonitorResourceQuotaAttribute DescribeMonitorResourceQuotaAttribute Queries the resource quotas of CloudMonitor.
    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.
    DescribeMonitoringConfig DescribeMonitoringConfig Queries the global configurations of the CloudMonitor agent.
    DescribeProductsOfActiveMetricRule DescribeProductsOfActiveMetricRule Queries the cloud services for which the initiative alert feature is enabled.
    DescribeProjectMeta DescribeProjectMeta Queries the information about monitored services in CloudMonitor.
    DescribeSiteMonitorData DescribeSiteMonitorData Queries the fine-grained monitoring data of a site monitoring task.
    DescribeSiteMonitorISPCityList DescribeSiteMonitorISPCityList Queries the detection points that are provided by carriers.
    DescribeSiteMonitorQuota DescribeSiteMonitorQuota Queries the quotas and version of site monitoring.
    DescribeSiteMonitorStatistics DescribeSiteMonitorStatistics Queries the statistics of a specified metric for a specified site monitoring task.
    DescribeSystemEventAttribute DescribeSystemEventAttribute Queries the details of a system event.
    DescribeSystemEventCount DescribeSystemEventCount Queries the number of times that a system event of a cloud service has occurred.
    DescribeSystemEventHistogram DescribeSystemEventHistogram Queries the number of times a system event occurred during each interval within a period of time.
    DescribeSystemEventMetaList DescribeSystemEventMetaList Queries the meta information about system events.
    DisableActiveMetricRule DisableActiveMetricRule Disables the initiative alert feature for a cloud service.
    DisableSiteMonitors DisableSiteMonitors Disables site monitoring tasks.
    EnableActiveMetricRule EnableActiveMetricRule Enables the initiative alert feature for a cloud service.
    EnableMetricRuleBlackList EnableMetricRuleBlackList Enables or disables multiple blacklist policies at a time.
    EnableMetricRules EnableMetricRules Enables alert rules.
    EnableSiteMonitors EnableSiteMonitors Enables site monitoring tasks.
    ModifyHostAvailability ModifyHostAvailability Modifies an availability monitoring task.
    ModifyHybridMonitorNamespace ModifyHybridMonitorNamespace Modifies a namespace.
    ModifyHybridMonitorSLSGroup ModifyHybridMonitorSLSGroup Modifies a Logstore group.
    ModifyHybridMonitorTask ModifyHybridMonitorTask Modifies a metric for the logs that are imported from Log Service.
    ModifyMetricRuleBlackList ModifyMetricRuleBlackList Modifies a blacklist policy.
    ModifyMetricRuleTemplate ModifyMetricRuleTemplate Modifies an alert template.
    ModifySiteMonitor ModifySiteMonitor Modifies a site monitoring task.
    OpenCmsService Activate CMS pay-as-you-go service OpenCmsService
    PutContact PutContact Creates or modifies an alert contact.
    PutCustomEvent PutCustomEvent Reports custom events.
    PutCustomMetric PutCustomMetric Reports monitoring data.
    PutCustomMetricRule PutCustomMetricRule Creates a custom alert rule.
    PutEventRuleTargets PutEventRuleTargets Adds or modifies the push channels of an event-triggered alert rule.
    PutExporterOutput PutExporterOutput Creates or modifies a configuration set for exporting monitoring data.
    PutHybridMonitorMetricData PutHybridMonitorMetricData Imports the monitoring data of a metric to a namespace of Hybrid Cloud Monitoring.
    PutLogMonitor PutLogMonitor Creates or modifies a log monitoring metric.
    PutMetricRuleTargets PutMetricRuleTargets Adds or modifies the push channels of an alert rule.
    PutMonitorGroupDynamicRule PutMonitorGroupDynamicRule Creates or modifies an alert rule to dynamically add instances that meet the rule to an application group.
    PutMonitoringConfig PutMonitoringConfig Configures global settings for the CloudMonitor agent.
    PutResourceMetricRule PutResourceMetricRule Configures an alert rule.
    PutResourceMetricRules PutResourceMetricRules Creates multiple alert rules for the specified metric of a specified resource.
    SendDryRunSystemEvent SendDryRunSystemEvent Debugs a system event of an Alibaba Cloud service.
    UninstallMonitoringAgent UninstallMonitoringAgent Uninstalls the CloudMonitor agent from a third-party host.