全部产品
Search
文档中心

:API概览

更新时间:May 31, 2023

本文列出了云监控所有可调用的API及相关描述。

说明
  • 单个API的调用次数限制:20次/秒。一个阿里云账号及该账号下的RAM用户共用20次/秒。

  • API请求数据大小限制如下:

    • Http Request Header+Query≤128KB

    • HttpRequestBody≤512KB

    • HttpResponse≤2048KB

应用分组

API

描述

CreateMonitorGroup

调用CreateMonitorGroup接口创建应用分组。

CreateMonitorGroupInstances

调用CreateMonitorGroupInstances接口添加指定资源到指定应用分组。

CreateMonitorGroupByResourceGroupId

调用CreateMonitorGroupByResourceGroupId接口通过资源组创建应用分组。

CreateMonitorGroupNotifyPolicy

调用CreateMonitorGroupNotifyPolicy接口创建暂停应用分组报警通知的策略。

CreateGroupMonitoringAgentProcess

调用CreateGroupMonitoringAgentProcess接口创建组进程监控。

PutMonitorGroupDynamicRule

调用PutMonitorGroupDynamicRule接口为应用分组创建或修改动态报警规则。

ModifyMonitorGroupInstances

调用ModifyMonitorGroupInstances接口修改应用分组中的资源。

ModifyMonitorGroup

调用ModifyMonitorGroup接口修改应用分组。

ModifyGroupMonitoringAgentProcess

调用ModifyGroupMonitoringAgentProcess接口修改应用分组内的进程监控。

DescribeMonitorGroupDynamicRules

调用DescribeMonitorGroupDynamicRules接口查询指定应用分组的动态规则列表。

DescribeMonitorGroupInstanceAttribute

调用DescribeMonitorGroupInstanceAttribute接口查询应用分组的资源详情。

DescribeMonitorGroupCategories

调用DescribeMonitorGroupCategories接口查询指定应用分组的资源列表和每个云服务的资源数量。

DescribeMonitorGroups

调用DescribeMonitorGroups接口查询应用分组列表。

DescribeMonitorGroupInstances

调用DescribeMonitorGroupInstances接口查询指定应用分组内包含的资源列表。

DescribeGroupMonitoringAgentProcess

调用DescribeGroupMonitoringAgentProcess接口获取组进程监控任务列表。

DescribeMonitorGroupNotifyPolicyList

调用DescribeMonitorGroupNotifyPolicyList接口查询应用分组的报警通知暂停策略列表。

DeleteMonitorGroupNotifyPolicy

调用DeleteMonitorGroupNotifyPolicy接口删除暂停指定应用分组报警通知策略。

DeleteMonitorGroupInstances

调用DeleteMonitorGroupInstances接口删除应用分组内的资源实例。

DeleteMonitorGroupDynamicRule

调用DeleteMonitorGroupDynamicRule接口删除指定应用分组的动态规则。

DeleteMonitorGroup

调用DeleteMonitorGroup接口删除指定的应用分组。

DeleteGroupMonitoringAgentProcess

调用DeleteGroupMonitoringAgentProcess接口删除组进程监控任务。

CreateGroupMetricRules

调用CreateGroupMetricRules接口批量为应用分组创建报警规则。

PutGroupMetricRule

调用PutGroupMetricRule接口创建或修改应用分组的报警规则。

CreateHostAvailability

调用CreateHostAvailability接口创建可用性监控任务。

ModifyHostAvailability

调用ModifyHostAvailability接口修改可用性监控任务。

DeleteHostAvailability

调用DeleteHostAvailability接口删除可用性监控任务。

EnableHostAvailability

调用EnableHostAvailability接口启用指定可用性监控任务。

DescribeHostAvailabilityList

调用DescribeHostAvailabilityList接口查询可用性监控任务列表。

DescribeUnhealthyHostAvailability

调用DescribeUnhealthyHostAvailability接口查询探测结果异常的服务器列表。

DisableHostAvailability

调用DisableHostAvailability接口禁用指定可用性监控任务。

AddTags

调用AddTags接口为资源创建标签。

DescribeTagValueList

调用DescribeTagValueList接口查询标签值列表。

DescribeTagKeyList

调用DescribeTagKeyList接口查询标签键列表。

RemoveTags

调用RemoveTags接口删除标签。

CreateDynamicTagGroup

调用CreateDynamicTagGroup接口使用云服务的标签自动同步创建应用分组。

DescribeProductResourceTagKeyList

调用DescribeProductResourceTagKeyList接口获取对应地域下云资源的所有标签键列表。

DescribeDynamicTagRuleList

调用DescribeDynamicTagRuleList接口查询智能标签的规则列表。

DeleteDynamicTagGroup

调用DeleteDynamicTagGroup接口删除智能标签规则。

主机监控

API

描述

DeleteMonitoringAgentProcess

调用DeleteMonitoringAgentProcess接口删除进程监控。

DescribeMonitoringAgentStatuses

调用DescribeMonitoringAgentStatuses接口查询云监控插件运行状态。

DescribeMonitoringAgentProcesses

调用DescribeMonitoringAgentProcesses接口查询进程监控列表。

DescribeMonitoringAgentAccessKey

调用DescribeMonitoringAgentAccessKey接口查询非阿里云主机安装云监控插件时所需要的AccessKey ID和AccessKey Secret。

UninstallMonitoringAgent

调用UninstallMonitoringAgent接口卸载非阿里云主机的云监控插件。

InstallMonitoringAgent

调用InstallMonitoringAgent接口对指定ECS实例安装云监控插件。

CreateMonitoringAgentProcess

调用CreateMonitoringAgentProcess接口创建进程监控。

DescribeMonitoringAgentHosts

调用DescribeMonitoringAgentHosts接口查询所有已安装和未安装云监控插件的主机列表。

DescribeMonitoringAgentConfig

调用DescribeMonitoringAgentConfig接口查询云监控插件的配置信息。

CreateMonitorAgentProcess

调用CreateMonitorAgentProcess接口创建进程监控。

ModifyHostInfo

调用ModifyHostInfo接口修改非阿里云的主机显示信息。

DescribeMonitoringConfig

调用DescribeMonitoringConfig接口查询云监控插件的全局配置。

PutMonitoringConfig

调用PutMonitoringConfig接口设置云监控插件的全局配置。

事件监控

API

描述

SendDryRunSystemEvent

调用SendDryRunSystemEvent接口调试资源的系统事件。

DescribeSystemEventMetaList

调用DescribeSystemEventMetaList接口查询系统事件的Meta信息。

DescribeSystemEventCount

调用DescribeSystemEventCount接口查询各个云服务指定时间段内事件的数量。

DescribeSystemEventAttribute

调用DescribeSystemEventAttribute接口查询系统事件详情。

DescribeSystemEventHistogram

调用DescribeSystemEventHistogram接口查询系统事件的时段数量分布图(柱状图)。

DescribeCustomEventCount

调用DescribeCustomEventCount接口查询自定义事件的统计结果。

DescribeCustomEventAttribute

调用DescribeCustomEventAttribute接口查询自定义事件的详情。

PutCustomEvent

调用PutCustomEvent接口上报自定义事件的监控数据。

DescribeCustomEventHistogram

调用DescribeCustomEventHistogram接口查询自定义上报事件的分时段数量分布图。

自定义监控

API

描述

PutCustomMetric

调用PutCustomMetric接口上报自定义监控数据。

PutCustomMetricRule

调用PutCustomMetricRule接口创建自定义监控报警规则。

DescribeCustomMetricList

调用DescribeCustomMetricList接口查询上报的自定义监控数据。

DeleteCustomMetric

调用DeleteCustomMetric接口删除上报的自定义监控数据。

日志监控

API

描述

DescribeLogMonitorList

调用DescribeLogMonitorList接口获取日志监控列表。

DescribeLogMonitorAttribute

调用DescribeLogMonitorAttribute接口获取日志监控详情。

DeleteLogMonitor

调用DeleteLogMonitor接口删除日志监控。

PutLogMonitor

调用PutLogMonitor接口创建或修改日志监控。

网络分析与监控

API

描述

DisableSiteMonitors

调用DisableSiteMonitors接口禁用一个或多个站点监控任务。

DescribeSiteMonitorQuota

调用DescribeSiteMonitorQuota接口查询站点监控的配额以及版本。

DescribeSiteMonitorAttribute

调用DescribeSiteMonitorAttribute接口查询站点监控详细信息。

DeleteSiteMonitors

调用DeleteSiteMonitors接口删除站点监控的探测任务。

DescribeSiteMonitorISPCityList

调用DescribeSiteMonitorISPCityList接口查询创建任务的探测点列表。

DescribeSiteMonitorData

调用DescribeSiteMonitorData接口查询任务的细粒度监控数据。

DescribeSiteMonitorStatistics

调用DescribeSiteMonitorStatistics接口查询指定站点监控任务的平均统计数据。

CreateSiteMonitor

调用CreateSiteMonitor接口创建站点监控的监控任务。

BatchCreateInstantSiteMonitor

调用BatchCreateInstantSiteMonitor接口批量创建站点监控任务。

ModifySiteMonitor

调用ModifySiteMonitor接口修改站点监控任务。

EnableSiteMonitors

调用EnableSiteMonitors接口启用一个或多个站点监控任务。

DescribeSiteMonitorList

调用DescribeSiteMonitorList接口查询站点监控任务列表。

云产品监控

API

描述

DescribeProjectMeta

调用DescribeProjectMeta接口查询云监控支持云服务的监控项列表。

DescribeMetricLast

调用DescribeMetricLast接口查询指定监控项的最新监控数据。

DescribeMetricMetaList

调用DescribeMetricMetaList接口查询云监控开放的监控项描述。

DescribeMetricList

调用DescribeMetricList接口查询指定云服务的监控数据。

DescribeMetricData

调用DescribeMetricData接口查询指定时间段内云服务的监控数据。

DescribeMetricTop

调用DescribeMetricTop接口查询排序后的指定云服务的监控数据。

DescribeMonitorResourceQuotaAttribute

调用DescribeMonitorResourceQuotaAttribute接口查询云监控各个资源的配额。

报警服务

API

描述

DescribeAlertHistoryList

调用DescribeAlertHistoryList接口查询报警历史详情。

DescribeAlertLogCount

调用DescribeAlertLogCount接口统计报警历史。

DescribeAlertLogHistogram

调用DescribeAlertLogHistogram接口查询报警历史的直方图列表。

DescribeAlertLogList

调用DescribeAlertLogList接口查询报警历史。

ApplyMetricRuleTemplate

调用ApplyMetricRuleTemplate接口将报警模板应用到应用分组并生成报警规则。

DescribeMetricRuleTemplateAttribute

调用DescribeMetricRuleTemplateAttribute接口查询报警模板详情。

DeleteMetricRuleTemplate

调用DeleteMetricRuleTemplate接口删除报警规则模板。

ModifyMetricRuleTemplate

调用ModifyMetricRuleTemplate接口修改报警模板。

CreateMetricRuleTemplate

调用CreateMetricRuleTemplate接口创建报警模板。

DescribeMetricRuleTemplateList

调用DescribeMetricRuleTemplateList接口查询报警模板列表。

PutResourceMetricRule

调用PutResourceMetricRule接口对单个资源的性能指标设置阈值报警规则。

PutResourceMetricRules

调用PutResourceMetricRules接口为多个资源的监控项设置多个阈值报警规则。

DeleteMetricRules

调用DeleteMetricRules接口删除一个或多个报警规则。

DescribeMetricRuleCount

调用DescribeMetricRuleCount接口获取各种状态报警规则的数量。

EnableMetricRules

调用EnableMetricRules接口启用一个或多个报警规则。

DescribeMetricRuleList

调用DescribeMetricRuleList接口查询报警规则列表。

DisableMetricRules

调用DisableMetricRules接口禁用报警规则。

DescribeAlertingMetricRuleResources

调用DescribeAlertingMetricRuleResources接口查询指定报警规则下报警的资源。

PutMetricRuleTargets

调用PutMetricRuleTargets接口添加或者修改报警规则的目标。

DescribeMetricRuleTargets

调用DescribeMetricRuleTargets接口查询报警规则关联目标。

DeleteMetricRuleTargets

调用DeleteMetricRuleTargets接口删除一个报警规则的目标。

CreateMetricRuleResources

调用CreateMetricRuleResources接口创建一个报警规则关联的资源。

DeleteMetricRuleResources

调用DeleteMetricRuleResources接口删除报警规则关联的资源。

DescribeEventRuleAttribute

调用DescribeEventRuleAttribute接口查询指定报警规则的详情。

PutEventRuleTargets

调用PutEventRuleTargets接口添加或修改规则的发送目标。

DeleteEventRuleTargets

调用DeleteEventRuleTargets接口删除事件报警通知目标。

EnableEventRules

调用EnableEventRules接口启用一个或者多个事件监控报警规则。

DescribeEventRuleList

调用DescribeEventRuleList接口查询事件报警规则列表。

DeleteEventRules

调用DeleteEventRules接口删除事件报警规则。

DisableEventRules

调用DisableEventRule接口禁用一个或多个事件报警规则。

PutEventRule

调用PutEventRule接口创建或修改事件的报警规则。

DescribeEventRuleTargetList

调用DescribeEventRuleTargetList接口查询指定事件报警规则的报警目标。

PutCustomEventRule

调用PutCustomEventRule接口创建自定义事件报警规则。

PutContactGroup

调用PutContactGroup接口创建或修改报警联系组。

DescribeContactList

调用DescribeContactList接口查询报警联系人列表。

DeleteContact

调用DeleteContact接口删除报警联系人。

PutContact

调用PutContact接口创建或修改报警联系人信息。

DescribeContactGroupList

调用DescribeContactGroupList接口查询报警联系组列表。

DeleteContactGroup

调用DeleteContactGroup接口删除报警联系人组。

DescribeContactListByContactGroup

调用DescribeContactListByContactGroup接口查询报警联系组中的报警联系人列表。

DescribeProductsOfActiveMetricRule

调用DescribeProductsOfActiveMetricRule接口查询开通一键报警规则的云服务列表。

EnableActiveMetricRule

调用EnableActiveMetricRule接口启用一键报警规则。

DescribeActiveMetricRuleList

调用DescribeActiveMetricRuleList接口查询一键报警规则的列表详情。

DisableActiveMetricRule

调用DisableActiveMetricRule接口禁用一键报警规则。

企业云监控

API

描述

PutHybridMonitorMetricData

调用PutHybridMonitorMetricData接口将指定监控数据上报至企业云监控的指定指标仓库中。

CreateHybridMonitorTask

调用CreateHybridMonitorTask接口创建阿里云产品的数据接入任务或SLS日志的监控项。

ModifyHybridMonitorTask

调用ModifyHybridMonitorTask接口修改SLS日志的监控项。

DeleteHybridMonitorTask

调用DeleteHybridMonitorTask接口删除数据接入任务。

DescribeHybridMonitorTaskList

调用DescribeHybridMonitorTaskList接口查询数据接入任务列表。

CreateHybridMonitorNamespace

调用CreateHybridMonitorNamespace接口创建指标仓库。

ModifyHybridMonitorNamespace

调用ModifyHybridMonitorNamespace接口修改指标仓库。

DeleteHybridMonitorNamespace

调用DeleteHybridMonitorNamespace接口删除指标仓库。

DescribeHybridMonitorNamespaceList

调用DescribeHybridMonitorNamespaceList接口查询指标仓库列表。

CreateHybridMonitorSLSGroup

调用CreateHybridMonitorSLSGroup接口为SLS日志的监控项创建Logstore组。

ModifyHybridMonitorSLSGroup

调用ModifyHybridMonitorSLSGroup接口修改Logstore组。

DeleteHybridMonitorSLSGroup

调用DeleteHybridMonitorSLSGroup接口删除Logstore组。

DescribeHybridMonitorSLSGroup

调用DescribeHybridMonitorSLSGroup接口查询Logstore组列表。

DescribeHybridMonitorDataList

调用DescribeHybridMonitorDataList接口查询指定指标仓库中的监控数据。

Cursor

调用Cursor接口定义导出监控数据的范围,并返回用于初始调用BatchExport接口的Cursor值。

BatchExport

调用BatchExport接口导出在Cursor接口中定义的监控数据。