This product(
Cms/2019-01-01) OpenAPI adopts RPC Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (78410016550) and sign under the guidance of experts. Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.
Application groups
| API | Title | Description |
|---|---|---|
| Manage application groups | Manage application groups | |
| CreateMonitorGroup | CreateMonitorGroup | Creates an application group. |
| ModifyMonitorGroup | ModifyMonitorGroup | |
| DeleteMonitorGroup | DeleteMonitorGroup | Deletes an application group. |
| DescribeMonitorGroups | DescribeMonitorGroups | Queries application groups. |
| CreateMonitorGroupInstances | CreateMonitorGroupInstances | Adds resources to an application group. |
| ModifyMonitorGroupInstances | ModifyMonitorGroupInstances | |
| DescribeMonitorGroupInstances | DescribeMonitorGroupInstances | Queries the resources in an application group. |
| DescribeMonitorGroupDynamicRules | DescribeMonitorGroupDynamicRules | Queries the dynamic rules of an application group. |
| DescribeMonitorGroupInstanceAttribute | DescribeMonitorGroupInstanceAttribute | Queries the details of the resources in an application group. |
| DeleteMonitorGroupDynamicRule | DeleteMonitorGroupDynamicRule | Deletes a rule that is used to dynamically add instances of a service that meet the rule to an application group. |
| DeleteMonitorGroupInstances | DeleteMonitorGroupInstances | Removes 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 | PutMonitorGroupDynamicRule | Creates or modifies an alert rule to dynamically add instances that meet the rule to an application group. |
| CreateGroupMonitoringAgentProcess | CreateGroupMonitoringAgentProcess | Creates a process monitoring task for an application group. |
| ModifyGroupMonitoringAgentProcess | ModifyGroupMonitoringAgentProcess | |
| DeleteGroupMonitoringAgentProcess | DeleteGroupMonitoringAgentProcess | Deletes a process monitoring task for an application group. |
| DescribeGroupMonitoringAgentProcess | DescribeGroupMonitoringAgentProcess | Queries the process monitoring tasks for an application group. |
| CreateMonitorGroupNotifyPolicy | CreateMonitorGroupNotifyPolicy | Creates a policy to pause alert notifications for an application group. |
| DeleteMonitorGroupNotifyPolicy | DeleteMonitorGroupNotifyPolicy | Deletes a policy that is used to pause alert notifications for an application group. |
| DescribeMonitorGroupNotifyPolicyList | DescribeMonitorGroupNotifyPolicyList | Queries the policies that are used to pause alert notifications for an application group. |
| Label | Label | |
| AddTags | AddTags | Adds tags to an application group. |
| CreateDynamicTagGroup | CreateDynamicTagGroup | Creates an application group based on the tags of cloud resources. |
| DeleteDynamicTagGroup | DeleteDynamicTagGroup | Deletes a tag rule. |
| DescribeTagValueList | DescribeTagValueList | |
| DescribeTagKeyList | DescribeTagKeyList | |
| DescribeProductResourceTagKeyList | DescribeProductResourceTagKeyList | |
| DescribeDynamicTagRuleList | DescribeDynamicTagRuleList | Queries tag rules. |
| RemoveTags | RemoveTags | Deletes tags. |
| Availability monitoring | Availability monitoring | |
| CreateHostAvailability | CreateHostAvailability | Creates an availability monitoring task. |
| DeleteHostAvailability | DeleteHostAvailability | Deletes one or more availability monitoring tasks. |
| EnableHostAvailability | EnableHostAvailability | |
| DisableHostAvailability | DisableHostAvailability | |
| ModifyHostAvailability | ModifyHostAvailability | Modifies an availability monitoring task. |
| DescribeUnhealthyHostAvailability | DescribeUnhealthyHostAvailability | |
| DescribeHostAvailabilityList | DescribeHostAvailabilityList | Queries availability monitoring tasks. |
Host monitoring
| API | Title | Description |
|---|---|---|
| InstallMonitoringAgent | InstallMonitoringAgent | |
| DescribeMonitoringAgentHosts | DescribeMonitoringAgentHosts | Queries all hosts within the current Alibaba Cloud account, including hosts on which the CloudMonitor agent is installed and uninstalled. |
| DescribeMonitoringAgentAccessKey | DescribeMonitoringAgentAccessKey | Queries the AccessKey ID and AccessKey secret that are required to install the CloudMonitor agent on a third-party host. |
| DescribeMonitoringAgentConfig | DescribeMonitoringAgentConfig | |
| DescribeMonitoringAgentStatuses | DescribeMonitoringAgentStatuses | Queries the status of the CloudMonitor agent. |
| ModifyHostInfo | ModifyHostInfo | |
| DescribeMonitoringConfig | DescribeMonitoringConfig | |
| PutMonitoringConfig | PutMonitoringConfig | Configures global settings for the CloudMonitor agent. |
| UninstallMonitoringAgent | UninstallMonitoringAgent | |
| CreateMonitoringAgentProcess | CreateMonitoringAgentProcess | Creates a task to monitor a specified process. |
| CreateMonitorAgentProcess | CreateMonitorAgentProcess | Creates a task to monitor a process. |
| DescribeMonitoringAgentProcesses | DescribeMonitoringAgentProcesses | |
| DeleteMonitoringAgentProcess | DeleteMonitoringAgentProcess | Disables monitoring on a process. |
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 | DescribeSystemEventMetaList | |
| 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. |
| DescribeMonitorResourceQuotaAttribute | DescribeMonitorResourceQuotaAttribute | Queries the resource quotas of CloudMonitor. |
| SendDryRunSystemEvent | SendDryRunSystemEvent | |
| Custom events | Custom events | |
| DescribeCustomEventCount | DescribeCustomEventCount | Queries the number of times that a custom event occurred in a specified time period. |
| DescribeCustomEventHistogram | DescribeCustomEventHistogram | Queries the number of times that a custom event occurred during each interval of a time period. |
| DescribeCustomEventAttribute | DescribeCustomEventAttribute | Queries the details of a custom event that occurred in a specified time period. |
| PutCustomEvent | PutCustomEvent | Reports custom events. |
Custom monitoring
| API | Title | Description |
|---|---|---|
| PutCustomMetric | PutCustomMetric | |
| PutCustomMetricRule | PutCustomMetricRule | |
| DescribeCustomMetricList | DescribeCustomMetricList | Queries the reported monitoring data. |
| DeleteCustomMetric | DeleteCustomMetric | Deletes the reported monitoring data of a metric. |
Log monitoring
| API | Title | Description |
|---|---|---|
| PutLogMonitor | PutLogMonitor | Creates or modifies a log monitoring metric. |
| DeleteLogMonitor | DeleteLogMonitor | Deletes a log monitoring metric. |
| DescribeLogMonitorList | DescribeLogMonitorList | Queries log monitoring metrics. |
| DescribeLogMonitorAttribute | DescribeLogMonitorAttribute | Queries the details of a log monitoring metric. |
Site monitoring
| API | Title | Description |
|---|---|---|
| CreateMonitorGroupByResourceGroupId | CreateMonitorGroupByResourceGroupId | Creates an application group by using a resource group. |
| CreateSiteMonitor | CreateSiteMonitor | Creates a site monitoring task. |
| CreateInstantSiteMonitor | CreateInstantSiteMonitor | Creates an instant test task. |
| BatchCreateInstantSiteMonitor | BatchCreateInstantSiteMonitor | Creates site monitoring tasks. |
| DeleteSiteMonitors | DeleteSiteMonitors | Deletes one or more site monitoring tasks. |
| DisableSiteMonitors | DisableSiteMonitors | Disables site monitoring tasks. |
| ModifySiteMonitor | ModifySiteMonitor | Modifies a site monitoring task. |
| EnableSiteMonitors | EnableSiteMonitors | Enables site monitoring tasks. |
| DescribeSiteMonitorQuota | DescribeSiteMonitorQuota | Queries the quotas and version of site monitoring. |
| DescribeSiteMonitorAttribute | DescribeSiteMonitorAttribute | Queries the details of a site monitoring task. |
| DescribeSiteMonitorISPCityList | DescribeSiteMonitorISPCityList | Queries the detection points that are provided by carriers. |
| DescribeSiteMonitorData | DescribeSiteMonitorData | Queries the fine-grained monitoring data of a site monitoring task. |
| DescribeSiteMonitorStatistics | DescribeSiteMonitorStatistics | Queries the statistics of a specified metric for a specified site monitoring task. |
| DescribeSiteMonitorList | DescribeSiteMonitorList | Queries site monitoring tasks. |
| DescribeSiteMonitorLog | DescribeSiteMonitorLog | Queries the logs of one or more instant test tasks. |
Cloud products
| API | Title | Description |
|---|---|---|
| DescribeMetricLast | DescribeMetricLast | Queries the latest monitoring data of a metric. |
| DescribeMetricList | DescribeMetricList | Queries the monitoring data of a metric for a specified cloud service. |
| DescribeMetricData | DescribeMetricData | Queries the monitoring data of a metric for a specified cloud service. |
| DescribeMetricMetaList | DescribeMetricMetaList | Queries the details of metrics that are supported in CloudMonitor. |
| DescribeProjectMeta | DescribeProjectMeta | Queries the information about monitored services 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 | DescribeAlertLogCount | Queries the statistics of alert logs. |
| DescribeAlertLogList | DescribeAlertLogList | Queries alert logs. |
| DescribeAlertLogHistogram | DescribeAlertLogHistogram | Queries the number of alert logs that are generated during each interval within a period of time. |
| Initiative alert list | Initiative alert list | |
| DescribeProductsOfActiveMetricRule | DescribeProductsOfActiveMetricRule | Queries the cloud services for which the initiative alert feature is enabled. |
| DescribeActiveMetricRuleList | DescribeActiveMetricRuleList | Queries the details of initiative alert rules. |
| EnableActiveMetricRule | EnableActiveMetricRule | |
| DisableActiveMetricRule | DisableActiveMetricRule | |
| Alert templates | Alert templates | |
| CreateMetricRuleTemplate | CreateMetricRuleTemplate | Creates an alert template. |
| DeleteMetricRuleTemplate | DeleteMetricRuleTemplate | Deletes an alert template. |
| ModifyMetricRuleTemplate | ModifyMetricRuleTemplate | Modifies an alert template. |
| DescribeMetricRuleTemplateAttribute | DescribeMetricRuleTemplateAttribute | Queries the details of an alert template. |
| DescribeMetricRuleTemplateList | DescribeMetricRuleTemplateList | Queries alert templates. |
| ApplyMetricRuleTemplate | ApplyMetricRuleTemplate | Applies an alert template to an application group to generate an alert rule. |
| Threshold-triggered alert rules | Threshold-triggered alert rules | |
| DescribeMetricRuleList | DescribeMetricRuleList | Queries alert rules. |
| CreateGroupMetricRules | CreateGroupMetricRules | Creates one or more alert rules for a specified application group. |
| CreateMetricRuleResources | CreateMetricRuleResources | Associates resources with an alert rule. |
| DeleteMetricRuleTargets | DeleteMetricRuleTargets | Delete the push channels of an alert rule. |
| DeleteMetricRules | DeleteMetricRules | Deletes alert rules. |
| DeleteMetricRuleResources | DeleteMetricRuleResources | Disassociates resources from an alert rule. |
| EnableMetricRules | EnableMetricRules | Enables one or more alert rules. |
| DisableMetricRules | DisableMetricRules | Disables alert rules. |
| DescribeMetricRuleTargets | DescribeMetricRuleTargets | Queries the resources that are associated with a specified alert rule. |
| DescribeMetricRuleCount | DescribeMetricRuleCount | Queries the number of alert rules in each state. |
| DescribeAlertingMetricRuleResources | DescribeAlertingMetricRuleResources | Queries the resources for which active alerts are triggered based on an alert rule. |
| PutMetricRuleTargets | PutMetricRuleTargets | Adds or modifies the push channels of an alert rule. |
| PutResourceMetricRule | PutResourceMetricRule | Configures an alert rule. |
| PutResourceMetricRules | PutResourceMetricRules | Creates multiple alert rules for the specified metric of a specified resource. |
| PutGroupMetricRule | PutGroupMetricRule | Creates or modifies an alert rule for an application group. |
| Event-triggered alert rules | Event-triggered alert rules | |
| DeleteEventRuleTargets | DeleteEventRuleTargets | Deletes the push channels of an event-triggered alert rule. |
| DeleteEventRules | DeleteEventRules | Deletes one or more event-triggered alert rules. |
| EnableEventRules | EnableEventRules | |
| DisableEventRules | DisableEventRules | |
| DescribeEventRuleAttribute | DescribeEventRuleAttribute | Queries the details of an event-triggered alert rule. |
| DescribeEventRuleList | DescribeEventRuleList | Queries event-triggered alert rules. |
| DescribeEventRuleTargetList | DescribeEventRuleTargetList | Queries event-triggered alert rules. |
| PutEventRuleTargets | PutEventRuleTargets | Adds or modifies the push channels of an event-triggered alert rule. |
| PutEventRule | PutEventRule | |
| PutCustomEventRule | PutCustomEventRule | |
| Alert blacklists | Alert blacklists | |
| CreateMetricRuleBlackList | CreateMetricRuleBlackList | Creates a blacklist policy. |
| ModifyMetricRuleBlackList | ModifyMetricRuleBlackList | Modifies a blacklist policy. |
| DeleteMetricRuleBlackList | DeleteMetricRuleBlackList | Deletes multiple blacklist policies at a time. |
| DescribeMetricRuleBlackList | DescribeMetricRuleBlackList | Queries blacklist policies. |
| EnableMetricRuleBlackList | EnableMetricRuleBlackList | Enables or disables multiple blacklist policies at a time. |
| Alert contacts | Alert contacts | |
| DeleteContactGroup | DeleteContactGroup | Deletes an alert group. |
| DeleteContact | DeleteContact | Deletes an alert contact. |
| DescribeContactListByContactGroup | DescribeContactListByContactGroup | Queries the alert contacts in an alert contact group. |
| DescribeContactGroupList | DescribeContactGroupList | Queries alert groups. |
| DescribeContactList | DescribeContactList | Queries alert contacts. |
| PutContact | PutContact | |
| PutContactGroup | PutContactGroup |
Hybrid cloud monitoring
| API | Title | Description |
|---|---|---|
| CreateHybridMonitorNamespace | CreateHybridMonitorNamespace | Creates a namespace. |
| ModifyHybridMonitorNamespace | ModifyHybridMonitorNamespace | Modifies a namespace. |
| DeleteHybridMonitorNamespace | DeleteHybridMonitorNamespace | Deletes a namespace. |
| DescribeHybridMonitorNamespaceList | DescribeHybridMonitorNamespaceList | Queries namespaces and the details of the related metric import tasks. |
| CreateHybridMonitorTask | CreateHybridMonitorTask | Creates a metric import task for an Alibaba Cloud service or creates a metric for logs imported from Simple Log Service. |
| ModifyHybridMonitorTask | ModifyHybridMonitorTask | Modifies a metric for the logs that are imported from Log Service. |
| 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 | PutHybridMonitorMetricData | Imports the monitoring data of a metric to a namespace of Hybrid Cloud Monitoring. |
| DescribeHybridMonitorDataList | DescribeHybridMonitorDataList | Queries the monitoring data in a namespace. |
| CreateHybridMonitorSLSGroup | CreateHybridMonitorSLSGroup | Creates a Logstore group of Hybrid Cloud Monitoring. |
| ModifyHybridMonitorSLSGroup | ModifyHybridMonitorSLSGroup | Modifies a Logstore group. |
| DeleteHybridMonitorSLSGroup | DeleteHybridMonitorSLSGroup | Deletes a Logstore group. |
| DescribeHybridMonitorSLSGroup | DescribeHybridMonitorSLSGroup | Queries Logstore groups. |
| 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. |
| BatchExport | BatchExport | Exports the monitoring data that is defined in the Cursor operation. |