All Products
Search
Document Center

:List of operations by function

Last Updated:May 31, 2023

The following tables describe the API operations that are available for use in CloudMonitor.

Note
  • Each API operation can be called up to 20 times per second. Each Alibaba Cloud account and the RAM users within the account share the quota.

  • The size of an API request and response must conform to the following limits:

    • HTTP request header + Query ≤ 128 KB

    • HTTP request body ≤ 512 KB

    • HTTP response ≤ 2,048 KB

Application groups

API

Description

CreateMonitorGroup

Creates an application group.

CreateMonitorGroupInstances

Adds resources to an application group.

CreateMonitorGroupByResourceGroupId

Creates an application group by using a resource group.

CreateMonitorGroupNotifyPolicy

Creates a policy to pause alert notifications for an application group.

CreateGroupMonitoringAgentProcess

Creates a process monitoring task for an application group.

PutMonitorGroupDynamicRule

Creates or modifies an alert rule to dynamically add instances that meet the rule to an application group.

ModifyMonitorGroupInstances

Changes the resources that are added to an application group.

ModifyMonitorGroup

Modifies an application group.

ModifyGroupMonitoringAgentProcess

Modifies a process monitoring task for an application group.

DescribeMonitorGroupDynamicRules

Queries the dynamic rules of an application group.

DescribeMonitorGroupInstanceAttribute

Queries the details of the resources in an application group.

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.

DescribeMonitorGroups

Queries application groups.

DescribeMonitorGroupInstances

Queries the resources in an application group.

DescribeGroupMonitoringAgentProcess

Queries the process monitoring tasks for an application group.

DescribeMonitorGroupNotifyPolicyList

Queries policies that are used to pause alert notifications for an application group.

DeleteMonitorGroupNotifyPolicy

Deletes a policy that is used to pause alert notifications for an application group.

DeleteMonitorGroupInstances

Removes instances from an application group.

DeleteMonitorGroupDynamicRule

Deletes a rule that is used to dynamically add the instances of a service to an application group.

DeleteMonitorGroup

Deletes an application group.

DeleteGroupMonitoringAgentProcess

Deletes a process monitoring task for an application group.

CreateGroupMetricRules

Creates alert rules for an application group.

PutGroupMetricRule

Creates or modifies an alert rule for an application group.

CreateHostAvailability

Creates an availability monitoring task.

ModifyHostAvailability

Modifies an availability monitoring task.

DeleteHostAvailability

Deletes availability monitoring tasks.

EnableHostAvailability

Enables availability monitoring tasks.

DescribeHostAvailabilityList

Queries availability monitoring tasks.

DescribeUnhealthyHostAvailability

Queries unhealthy instances.

DisableHostAvailability

Disables availability monitoring tasks.

AddTags

Creates tags for resources.

DescribeTagValueList

Queries tag values.

DescribeTagKeyList

Queries tag keys.

RemoveTags

Deletes tags.

CreateDynamicTagGroup

Creates a tag rule based on which instances of cloud services can be automatically added to an application group.

DescribeProductResourceTagKeyList

Queries the keys of all tags that are attached to cloud resources in a region.

DescribeDynamicTagRuleList

Queries tag rules.

DeleteDynamicTagGroup

Deletes a tag rule.

Host monitoring

API

Description

DeleteMonitoringAgentProcess

Disables monitoring on a process.

DescribeMonitoringAgentStatuses

Queries the status of the CloudMonitor agent.

DescribeMonitoringAgentProcesses

Queries monitored processes.

DescribeMonitoringAgentAccessKey

Queries the AccessKey ID and AccessKey secret that are required to install the CloudMonitor agent on a host that is not an Elastic Compute Service (ECS) instance.

UninstallMonitoringAgent

Uninstalls the CloudMonitor agent from a host that is not provided by Alibaba Cloud.

InstallMonitoringAgent

Installs the CloudMonitor agent on an ECS instance.

CreateMonitoringAgentProcess

Creates a task to monitor a process.

DescribeMonitoringAgentHosts

Queries all hosts within the current Alibaba Cloud account, including hosts on which the CloudMonitor agent is installed and uninstalled.

DescribeMonitoringAgentConfig

Queries the configurations of the CloudMonitor agent.

CreateMonitorAgentProcess

Creates a task to monitor a process.

ModifyHostInfo

Modifies the information about a host that is not provided by Alibaba Cloud.

DescribeMonitoringConfig

Queries the global configurations of the CloudMonitor agent.

PutMonitoringConfig

Configures global settings for the CloudMonitor agent.

Event monitoring

API

Description

SendDryRunSystemEvent

Debugs a system event of an Alibaba Cloud resource.

DescribeSystemEventMetaList

Queries the meta information about system events.

DescribeSystemEventCount

Queries the number of times that a system event occurred within a period of time.

DescribeSystemEventAttribute

Queries the details of a system event.

DescribeSystemEventHistogram

Queries the number of times that a system event occurred during each interval within a period of time.

DescribeCustomEventCount

Queries the number of times that a custom event occurred within a period of time.

DescribeCustomEventAttribute

Queries the details of a custom event.

PutCustomEvent

Reports custom events.

DescribeCustomEventHistogram

Queries the number of times that a custom event occurred during each interval within a period of time.

Custom monitoring

API

Description

PutCustomMetric

Reports monitoring data.

PutCustomMetricRule

Creates a custom alert rule.

DescribeCustomMetricList

Queries the reported monitoring data.

DeleteCustomMetric

Deletes the reported monitoring data of a metric.

Log monitoring

API

Description

DescribeLogMonitorList

Queries log monitoring metrics.

DescribeLogMonitorAttribute

Queries the details of a log monitoring metric.

DeleteLogMonitor

Deletes a log monitoring metric.

PutLogMonitor

Creates or modifies a log monitoring metric.

Network Analysis and Monitoring

API

Description

DisableSiteMonitors

Disables site monitoring tasks.

DescribeSiteMonitorQuota

Queries the quotas and version of site monitoring.

DescribeSiteMonitorAttribute

Queries the details of a site monitoring task.

DeleteSiteMonitors

Deletes site monitoring tasks.

DescribeSiteMonitorISPCityList

Queries the detection points that are available for creating site monitoring tasks.

DescribeSiteMonitorData

Queries the fine-grained monitoring data of a site monitoring task.

DescribeSiteMonitorStatistics

Queries the statistics of a site monitoring task within a period of time.

CreateSiteMonitor

Creates a site monitoring task.

BatchCreateInstantSiteMonitor

Creates site monitoring tasks.

ModifySiteMonitor

Modifies a site monitoring task.

EnableSiteMonitors

Enables site monitoring tasks.

DescribeSiteMonitorList

Queries site monitoring tasks.

Cloud service monitoring

API

Description

DescribeProjectMeta

Queries the metrics of the cloud services that are supported by CloudMonitor.

DescribeMetricLast

Queries the latest monitoring data of a metric.

DescribeMetricMetaList

Queries the descriptions of the metrics that are supported by CloudMonitor.

DescribeMetricList

Queries the monitoring data of a cloud service.

DescribeMetricData

Queries the monitoring data of a cloud service within a period of time.

DescribeMetricTop

Queries the sorted data of a metric for a cloud service.

DescribeMonitorResourceQuotaAttribute

Queries the resource quotas of CloudMonitor.

Alert service

API

Description

DescribeAlertHistoryList

Queries historical alerts.

DescribeAlertLogCount

Queries the statistics of alert logs.

DescribeAlertLogHistogram

Queries the number of alert logs that are generated during each interval within a period of time.

DescribeAlertLogList

Queries alert logs.

ApplyMetricRuleTemplate

Applies an alert template to an application group to generate an alert rule.

DescribeMetricRuleTemplateAttribute

Queries the details of an alert template.

DeleteMetricRuleTemplate

Deletes an alert template.

ModifyMetricRuleTemplate

Modifies an alert template.

CreateMetricRuleTemplate

Creates an alert template.

DescribeMetricRuleTemplateList

Queries alert templates.

PutResourceMetricRule

Creates an alert rule for a performance metric of a resource.

PutResourceMetricRules

Creates multiple alert rules for the metrics of multiple resources.

DeleteMetricRules

Deletes alert rules.

DescribeMetricRuleCount

Queries the number of alert rules in each state.

EnableMetricRules

Enables alert rules.

DescribeMetricRuleList

Queries alert rules.

DisableMetricRules

Disables alert rules.

DescribeAlertingMetricRuleResources

Queries the resources for which active alerts are triggered based on an alert rule.

PutMetricRuleTargets

Adds or modifies the resources that are associated with an alert rule.

DescribeMetricRuleTargets

Queries the resources that are associated with an alert rule.

DeleteMetricRuleTargets

Deletes the resources that are associated with an alert rule.

CreateMetricRuleResources

Associates resources with an alert rule.

DeleteMetricRuleResources

Disassociates resources from an alert rule.

DescribeEventRuleAttribute

Queries the details of an alert rule.

PutEventRuleTargets

Adds or modifies the recipients to which alert notifications are sent based on an event-triggered alert rule.

DeleteEventRuleTargets

Deletes the recipients to which alert notifications are sent based on an event-triggered alert rule.

EnableEventRules

Enables event-triggered alert rules.

DescribeEventRuleList

Queries event-triggered alert rules.

DeleteEventRules

Deletes event-triggered alert rules.

DisableEventRules

Disables event-triggered alert rules.

PutEventRule

Creates or modifies an event-triggered alert rule.

DescribeEventRuleTargetList

Queries the resources that are associated with an event-triggered alert rule.

PutCustomEventRule

Creates an alert rule for a custom event.

PutContactGroup

Creates or modifies an alert contact group.

DescribeContactList

Queries alert contacts.

DeleteContact

Deletes an alert contact.

PutContact

Creates or modifies an alert contact.

DescribeContactGroupList

Queries alert contact groups.

DeleteContactGroup

Deletes an alert contact group.

DescribeContactListByContactGroup

Queries the alert contacts in an alert contact group.

DescribeProductsOfActiveMetricRule

Queries the cloud services for which the initiative alert feature is enabled.

EnableActiveMetricRule

Enables the initiative alert feature for a cloud service.

DescribeActiveMetricRuleList

Queries the details of initiative alert rules.

DisableActiveMetricRule

Disables the initiative alert feature for a cloud service.

Hybrid Cloud Monitoring

API

Description

PutHybridMonitorMetricData

Imports the monitoring data of a metric to a namespace of Hybrid Cloud Monitoring.

CreateHybridMonitorTask

Creates a metric import task for an Alibaba Cloud service or creates a metric for logs imported from Log Service.

ModifyHybridMonitorTask

Modifies a metric for the logs that are imported from Log Service.

DeleteHybridMonitorTask

Deletes a metric import task for Alibaba Cloud services or a metric for the logs that are imported from Log Service.

DescribeHybridMonitorTaskList

Queries metric import tasks.

CreateHybridMonitorNamespace

Creates a namespace.

ModifyHybridMonitorNamespace

Modifies a namespace.

DeleteHybridMonitorNamespace

Deletes a namespace.

DescribeHybridMonitorNamespaceList

Queries namespaces and the details of the related metric import tasks.

CreateHybridMonitorSLSGroup

Creates a Logstore group for the metrics of Log Service logs.

ModifyHybridMonitorSLSGroup

Modifies a Logstore group.

DeleteHybridMonitorSLSGroup

Deletes a Logstore group.

DescribeHybridMonitorSLSGroup

Queries Logstore groups.

DescribeHybridMonitorDataList

Queries the monitoring data in a namespace.

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

Exports the monitoring data that is defined in the Cursor operation.