API概览

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

云产品时序指标类监控数据

API	描述
DeleteExporterOutput	删除监控数据导出配置。
DeleteExporterRule	删除数据导出规则。
DescribeExporterOutputList	查询监控数据导出列表。
DescribeExporterRuleList	查询数据导出规则列表。
DescribeMetricLast	查询指定监控对象的最新监控数据。
PutExporterOutput	创建或修改一个监控数据导出配置。
DescribeMetricMetaList	查询云监控开放的时序类指标监控项描述。
PutExporterRule	创建或者修改数据导出规则。
DescribeMetricList	查询指定时间段内的云产品时序指标监控数据。
DescribeMetricData	查询指定时间段内的云产品时序指标监控数据。
DescribeProjectMeta	查询云监控支持的时序类监控项产品列表。

时序指标报警规则

API	描述
DescribeProductsOfActiveMetricRule	查询开通一键报警规则的产品列表。
EnableActiveMetricRule	启用一键报警规则。
DescribeActiveMetricRuleList	查询一键报警规则的列表详情。
PutResourceMetricRule	对单个资源的性能指标设置阈值报警规则。
DescribeMetricRuleList	查询报警规则列表。
DeleteMetricRules	删除一个或者多个报警规则。
DisableMetricRules	禁用一个或多个报警规则。
DescribeMetricRuleCount	分类取得报警规则的数量。
CreateGroupMetricRules	批量创建应用分组报警规则。
DisableActiveMetricRule	禁用一键报警规则。
EnableMetricRules	启用一个或多个报警规则。
DescribeAlertHistoryList	查询报警历史详情。
PutGroupMetricRule	创建或者修改组报警规则。
DescribeAlertingMetricRuleResources	查询一个报警规则下正在报警的资源。
PutMetricRuleTargets	添加或者修改报警规则的目标。
DescribeMetricRuleTargets	查询报警规则关联目标。
DeleteMetricRuleTargets	删除一个报警规则的目标。
CreateMetricRuleResources	创建一个报警规则关联的资源。
DeleteMetricRuleResources	删除报警规则关联的资源。

主机监控

API	描述
DeleteMonitoringAgentProcess	删除进程监控。
DescribeMonitoringAgentStatuses	查询云监控插件运行状态。
DescribeMonitoringAgentProcesses	查询进程监控列表。
DescribeMonitoringAgentAccessKey	查询非阿里云ECS主机安装云监控插件时所需要的AccessKey ID和AccessKey Secret。
UninstallMonitoringAgent	卸载非阿里云主机监控插件。
InstallMonitoringAgent	对指定ECS安装云监控插件。不适用于非阿里云ECS的服务器。
CreateMonitoringAgentProcess	创建进程监控。
DescribeMonitoringAgentHosts	查询所有的已安装和未安装云监控插件的主机列表。
DescribeMonitoringAgentConfig	查询云监控插件的配置信息。
CreateMonitorAgentProcess	创建进程监控。
ModifyHostInfo	修改非阿里云的主机显示信息。

报警联系人组

API	描述
DescribeContactListByContactGroup	查询一个报警联系人组下的报警联系人列表。
DeleteContactGroup	删除报警联系人组。
DescribeContactGroupList	查询报警联系人组列表。
PutContact	创建或者修改报警联系人信息。
DeleteContact	删除报警联系人。
DescribeContactList	查询报警联系人列表。
PutContactGroup	创建或者修改报警联系人组。

可用性监控

API	描述
CreateHostAvailability	创建可用性监控任务。
DeleteHostAvailability	删除可用性监控任务。
EnableHostAvailability	启用可用性监控任务。
ModifyHostAvailability	修改可用性监控任务。
DescribeHostAvailabilityList	查询可用性监控任务列表。
DescribeUnhealthyHostAvailability	查询探测结果异常的服务器列表。
DisableHostAvailability	禁用一个可用性监控任务。

全局配置

API	描述
DescribeMonitoringConfig	查询云监控插件全局配置。
PutMonitoringConfig	设置云监控插件全局配置，例如开始自动安装插件以及一键报警等。

云产品事件类监控数据

API	描述
SendDryRunSystemEvent	触发一个用于调试的系统事件，用于调试事件下游配置的触发逻辑是否符合预期。
DescribeSystemEventMetaList	查询系统事件的Meta信息。
DescribeSystemEventCount	查询各个产品指定时间段内事件的数量。
DescribeSystemEventAttribute	查询系统事件详情。
DescribeSystemEventHistogram	查询系统事件的时段数量分布图（柱状图）。

时序指标报警模板

API	描述
DescribeMetricRuleTemplateList	查询报警模板列表。
ApplyMetricRuleTemplate	将报警模板应用到分组，生成报警规则。
DescribeMetricRuleTemplateAttribute	查询报警模板的详情。
CreateMetricRuleTemplate	创建报警规则模板。
ModifyMetricRuleTemplate	修改报警模板。
DeleteMetricRuleTemplate	删除报警规则模板。

事件报警规则

API	描述
DescribeEventRuleAttribute	查询指定规则的详情。
PutEventRuleTargets	添加或者修改规则的发送目标。
DeleteEventRuleTargets	删除事件报警通知目标。
EnableEventRules	启用一个或者多个事件监控报警规则。
DescribeEventRuleList	查询事件报警的列表。
DeleteEventRules	删除事件报警规则。
DisableEventRules	禁用一个或者多个事件报警规则。
PutEventRule	创建或修改事件的报警规则。
DescribeEventRuleTargetList	查询指定事件报警规则的报警目标。

自定义监控

API	描述
PutCustomMetric	上报自定义监控数据。
DescribeCustomMetricList	查询上报的自定义监控数据。
DeleteCustomMetric	删除自定义监控上报数据。

自定义事件

API	描述
DescribeCustomEventCount	查询自定义事件的统计结果。
DescribeCustomEventAttribute	查询自定义事件的详情。
PutCustomEvent	上报自定义事件的监控数据。
DescribeCustomEventHistogram	查询自定义上报事件的分时段数量分布图。

应用分组

API	描述
DeleteMonitorGroupInstances	删除应用分组内的资源实例。
PutMonitorGroupDynamicRule	创建或者修改一个应用分组的动态规则，满足规则描述的资源会自动添加到应用分组中。
DeleteMonitorGroupDynamicRule	删除指定应用分组的动态规则。
ModifyMonitorGroupInstances	修改应用分组中的资源。
DescribeMonitorGroupDynamicRules	查询应用分组动态规则的列表。
CreateMonitorGroupNotifyPolicy	创建暂停应用分组报警通知的策略。
DescribeMonitorGroupInstanceAttribute	查询应用分组的资源实例详情。
DescribeMonitorGroupCategories	查询指定应用分组的产品资源列表和每个产品的资源数量。
CreateMonitorGroup	创建一个应用分组。
CreateMonitorGroupInstances	添加资源到应用分组。
DeleteMonitorGroupNotifyPolicy	删除指定应用分组的报警通知暂停策略。
ModifyMonitorGroup	修改应用分组。
DescribeMonitorGroupNotifyPolicyList	查询应用分组的报警通知暂停策略列表。
DescribeMonitorGroupInstances	查询指定应用分组内包含的资源列表。
DeleteMonitorGroup	删除指定的应用分组。
DescribeMonitorGroups	查询应用分组列表。
CreateGroupMonitoringAgentProcess	创建组进程监控。
DescribeGroupMonitoringAgentProcess	获取组进程监控任务列表。
ModifyGroupMonitoringAgentProcess	修改组进程监控。
DeleteGroupMonitoringAgentProcess	删除组进程监控任务。

站点监控

API	描述
DescribeSiteMonitorData	查询任务的细粒度监控数据。
DisableSiteMonitors	禁用一个或者多个站点监控探测任务。
DescribeSiteMonitorQuota	查询站点监控的配额以及版本。
DescribeSiteMonitorAttribute	查询站点监控详细信息。
DeleteSiteMonitors	删除站点监控的探测任务。
DescribeSiteMonitorISPCityList	查询可用于创建任务的探测点列表。
DescribeSiteMonitorStatistics	查询指定任务一段时间内的平均统计数据。
CreateSiteMonitor	创建站点监控的探测任务。
EnableSiteMonitors	启用一个或者多个站点监控探测任务。
ModifySiteMonitor	修改站点监控探测任务。
DescribeSiteMonitorList	查询站点监控任务列表。

标签

API	描述
AddTags	为资源创建标签。
DescribeTagValueList	查询标签值列表。
DescribeTagKeyList	查询标签键列表。
RemoveTags	删除标签。

日志监控

API	描述
DescribeLogMonitorList	获取日志监控列表。
DescribeLogMonitorAttribute	获取日志监控详情。
DeleteLogMonitor	删除日志监控。
PutLogMonitor	创建或修改日志监控。