文档

API概览

更新时间:
本产品(云监控/2019-01-01)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

应用分组

API标题API概述
管理应用分组管理应用分组
CreateMonitorGroup创建应用分组调用CreateMonitorGroup接口创建应用分组。
ModifyMonitorGroup修改应用分组调用ModifyMonitorGroup接口修改应用分组。
DeleteMonitorGroup删除指定的应用分组调用DeleteMonitorGroup接口删除指定的应用分组。
DescribeMonitorGroups查询应用分组列表调用DescribeMonitorGroups接口查询应用分组列表。
CreateMonitorGroupInstances添加指定资源到指定应用分组调用CreateMonitorGroupInstances接口添加指定资源到指定应用分组。
ModifyMonitorGroupInstances修改应用分组中的资源调用ModifyMonitorGroupInstances接口修改应用分组中的资源。
DescribeMonitorGroupInstances查询指定应用分组内包含的资源列表调用DescribeMonitorGroupInstances接口查询指定应用分组内包含的资源列表。
DescribeMonitorGroupDynamicRules查询指定应用分组的动态规则列表调用DescribeMonitorGroupDynamicRules接口查询指定应用分组的动态规则列表。
DescribeMonitorGroupInstanceAttribute查询应用分组的资源详情调用DescribeMonitorGroupInstanceAttribute接口查询应用分组的资源详情。
DeleteMonitorGroupDynamicRule删除指定应用分组的动态规则调用DeleteMonitorGroupDynamicRule接口删除指定应用分组的动态规则。
DeleteMonitorGroupInstances删除应用分组内的资源实例调用DeleteMonitorGroupInstances接口删除应用分组内的资源实例。
DescribeMonitorGroupCategories查询指定应用分组的资源列表和每个云服务的资源数量调用DescribeMonitorGroupCategories接口查询指定应用分组的资源列表和每个云服务的资源数量。
PutMonitorGroupDynamicRule创建或修改按照实例名称动态匹配的应用分组调用PutMonitorGroupDynamicRule接口创建或修改按照实例名称动态匹配的应用分组,满足匹配规则的所有实例自动添加到该应用分组中。
CreateGroupMonitoringAgentProcess创建组进程监控调用CreateGroupMonitoringAgentProcess接口创建组进程监控。
ModifyGroupMonitoringAgentProcess修改应用分组内的进程监控调用ModifyGroupMonitoringAgentProcess接口修改应用分组内的进程监控。
DeleteGroupMonitoringAgentProcess删除组进程监控任务调用DeleteGroupMonitoringAgentProcess接口删除组进程监控任务。
DescribeGroupMonitoringAgentProcess获取组进程监控任务列表调用DescribeGroupMonitoringAgentProcess接口获取组进程监控任务列表。
CreateMonitorGroupNotifyPolicy为应用分组创建暂停报警通知策略调用CreateMonitorGroupNotifyPolicy接口为应用分组创建暂停报警通知策略。
DeleteMonitorGroupNotifyPolicy删除暂停指定应用分组报警通知策略调用DeleteMonitorGroupNotifyPolicy接口删除暂停指定应用分组报警通知策略。
DescribeMonitorGroupNotifyPolicyList查询应用分组的报警通知暂停策略列表调用DescribeMonitorGroupNotifyPolicyList接口查询应用分组的报警通知暂停策略列表。
标签标签
AddTags为指定应用分组绑定标签调用AddTags接口为指定应用分组绑定标签。
CreateDynamicTagGroup通过标签自动创建应用分组调用CreateDynamicTagGroup接口通过标签自动创建应用分组。
DeleteDynamicTagGroup删除智能标签规则调用DeleteDynamicTagGroup接口删除智能标签规则。
DescribeTagValueList查询指定标签键对应的标签值列表调用DescribeTagValueList接口查询指定标签键对应的标签值列表。
DescribeTagKeyList查询标签键列表调用DescribeTagKeyList接口查询标签键列表。
DescribeProductResourceTagKeyList获取对应地域下云资源的所有标签键列表调用DescribeProductResourceTagKeyList接口获取对应地域下云资源的所有标签键列表。
DescribeDynamicTagRuleList查询智能标签的规则列表调用DescribeDynamicTagRuleList接口查询智能标签的规则列表。
RemoveTags删除标签调用RemoveTags接口删除标签。
可用性监控可用性监控
CreateHostAvailability创建可用性监控任务调用CreateHostAvailability接口创建可用性监控任务。
DeleteHostAvailability删除可用性监控任务调用DeleteHostAvailability接口删除可用性监控任务。
EnableHostAvailability启用指定可用性监控任务调用EnableHostAvailability接口启用指定可用性监控任务。
DisableHostAvailability禁用指定可用性监控任务调用DisableHostAvailability接口禁用指定可用性监控任务。
ModifyHostAvailability修改可用性监控任务调用ModifyHostAvailability接口修改可用性监控任务。
DescribeUnhealthyHostAvailability查询探测结果异常的服务器列表调用DescribeUnhealthyHostAvailability接口查询探测结果异常的服务器列表。
DescribeHostAvailabilityList查询可用性监控任务列表调用DescribeHostAvailabilityList接口查询可用性监控任务列表。

主机监控

API标题API概述
InstallMonitoringAgent为指定阿里云主机安装云监控插件调用InstallMonitoringAgent接口为指定阿里云主机安装云监控插件。
DescribeMonitoringAgentHosts查询所有已安装和未安装云监控插件的主机列表调用DescribeMonitoringAgentHosts接口查询所有已安装和未安装云监控插件的主机列表。
DescribeMonitoringAgentAccessKey查询非阿里云主机安装云监控插件时所需要的AccessKey和AccessSecret调用DescribeMonitoringAgentAccessKey接口查询非阿里云主机安装云监控插件时所需要的AccessKey和AccessSecret。
DescribeMonitoringAgentConfig查询云监控插件的配置信息调用DescribeMonitoringAgentConfig接口查询云监控插件的配置信息。
DescribeMonitoringAgentStatuses查询云监控插件运行状态调用DescribeMonitoringAgentStatuses接口查询云监控插件运行状态。
ModifyHostInfo修改非阿里云的主机显示信息调用ModifyHostInfo接口修改非阿里云的主机显示信息。
DescribeMonitoringConfig查询云监控插件的全局配置调用DescribeMonitoringConfig接口查询云监控插件的全局配置。
PutMonitoringConfig设置云监控插件的全局配置调用PutMonitoringConfig接口设置云监控插件的全局配置。
UninstallMonitoringAgent卸载非阿里云主机的云监控插件调用UninstallMonitoringAgent接口卸载非阿里云主机的云监控插件。
CreateMonitoringAgentProcess创建进程监控调用CreateMonitoringAgentProcess接口创建进程监控。
CreateMonitorAgentProcess创建进程监控调用CreateMonitorAgentProcess接口创建进程监控。
DescribeMonitoringAgentProcesses查询指定资源的进程数列表调用DescribeMonitoringAgentProcesses接口查询指定资源的进程数列表。
DeleteMonitoringAgentProcess删除指定主机中的指定进程监控调用DeleteMonitoringAgentProcess接口删除指定主机中的指定进程监控。

事件中心

API标题API概述
系统事件系统事件
DescribeSystemEventHistogram查询系统事件的时段数量分布图(柱状图)调用DescribeSystemEventHistogram接口查询系统事件的时段数量分布图(柱状图)。
DescribeSystemEventMetaList查询系统事件的Meta信息调用DescribeSystemEventMetaList接口查询系统事件的Meta信息。
DescribeSystemEventAttribute查询系统事件详情调用DescribeSystemEventAttribute接口查询系统事件详情。
DescribeSystemEventCount查询当前账号下各云服务发生事件的数量调用DescribeSystemEventCount接口查询当前账号下各云服务发生事件的数量。
DescribeMonitorResourceQuotaAttribute查询云监控各个资源的配额调用DescribeMonitorResourceQuotaAttribute接口查询云监控各个资源的配额。
SendDryRunSystemEvent调试云资源的系统事件调用SendDryRunSystemEvent接口调试云资源的系统事件。
自定义事件自定义事件
DescribeCustomEventCount查询自定义事件的统计结果调用DescribeCustomEventCount接口查询自定义事件的统计结果。
DescribeCustomEventHistogram查询自定义上报事件的分时段数量分布图调用DescribeCustomEventHistogram接口查询自定义上报事件的分时段数量分布图。
DescribeCustomEventAttribute查询自定义事件的详情调用DescribeCustomEventAttribute接口查询自定义事件的详情。
PutCustomEvent上报自定义事件的监控数据调用PutCustomEvent接口上报自定义事件的监控数据。

自定义监控

API标题API概述
PutCustomMetric上报自定义监控数据调用PutCustomMetric接口上报自定义监控数据。
PutCustomMetricRule创建自定义监控报警规则调用PutCustomMetricRule接口创建自定义监控报警规则。
DescribeCustomMetricList查询上报的自定义监控数据调用DescribeCustomMetricList接口查询上报的自定义监控数据。
DeleteCustomMetric删除自定义监控上报数据调用DeleteCustomMetric接口删除自定义监控上报数据。

日志监控

API标题API概述
PutLogMonitor创建或修改日志监控调用PutLogMonitor接口创建或修改日志监控。
DeleteLogMonitor删除日志监控调用DeleteLogMonitor接口删除日志监控。
DescribeLogMonitorList获取日志监控列表调用DescribeLogMonitorList接口获取日志监控列表。
DescribeLogMonitorAttribute获取日志监控详情调用DescribeLogMonitorAttribute接口获取日志监控详情。

站点监控

API标题API概述
CreateMonitorGroupByResourceGroupId通过资源组创建应用分组调用CreateMonitorGroupByResourceGroupId接口通过资源组创建应用分组。
CreateSiteMonitor创建站点监控任务调用CreateSiteMonitor接口创建站点监控任务。
CreateInstantSiteMonitor创建一次性探测任务调用CreateSiteMonitor接口创建一次性探测任务。
BatchCreateInstantSiteMonitor批量创建站点监控任务调用BatchCreateInstantSiteMonitor接口批量创建站点监控任务。
DeleteSiteMonitors删除站点监控的探测任务调用DeleteSiteMonitors接口删除站点监控的探测任务。
DisableSiteMonitors禁用一个或多个站点监控任务调用DisableSiteMonitors接口禁用一个或多个站点监控任务。
ModifySiteMonitor修改站点监控任务调用ModifySiteMonitor接口修改站点监控任务。
EnableSiteMonitors启用一个或多个站点监控任务调用EnableSiteMonitors接口启用一个或多个站点监控任务。
DescribeSiteMonitorQuota查询站点监控的配额以及版本调用DescribeSiteMonitorQuota接口查询站点监控的配额以及版本。
DescribeSiteMonitorAttribute查询站点监控任务的详细信息调用DescribeSiteMonitorAttribute接口查询站点监控任务的详细信息。
DescribeSiteMonitorISPCityList查询所有运营商探测点详情调用DescribeSiteMonitorISPCityList接口查询所有运营商探测点详情。
DescribeSiteMonitorData查询任务的细粒度监控数据调用DescribeSiteMonitorData接口查询任务的细粒度监控数据。
DescribeSiteMonitorStatistics查询指定站点监控任务中指定监控项的平均统计数据调用DescribeSiteMonitorStatistics接口查询指定站点监控任务中指定监控项的平均统计数据。
DescribeSiteMonitorList查询站点监控任务列表调用DescribeSiteMonitorList接口查询站点监控任务列表。
DescribeSiteMonitorLog查询一次性探测任务的探测日志调用DescribeSiteMonitorLog接口查询一次性探测任务的探测日志。

云产品监控

API标题API概述
DescribeMetricLast查询指定监控项的最新监控数据调用DescribeMetricLast接口查询指定监控项的最新监控数据。
DescribeMetricList查询指定云产品的指定监控项的监控数据调用DescribeMetricList接口查询指定云产品的指定监控项的监控数据。
DescribeMetricData查询指定云产品的某个监控项的监控数据调用DescribeMetricData接口查询指定云产品的某个监控项的监控数据。
DescribeMetricMetaList查询云监控开放的监控项详情调用DescribeMetricMetaList接口查询云监控开放的监控项详情。
DescribeProjectMeta查询云监控支持的时序类监控项产品列表调用DescribeProjectMeta接口查询云监控支持的时序类监控项产品列表。
DescribeMetricTop查询排序后的最新监控数据调用DescribeMetricTop接口先查询指定云产品的指定监控项的最新监控数据,再查询该监控项排序后的监控数据。

报警服务

API标题API概述
报警历史报警历史
DescribeAlertLogCount统计报警历史调用DescribeAlertLogCount接口统计报警历史。
DescribeAlertLogList查询报警历史调用DescribeAlertLogList接口查询报警历史。
DescribeAlertLogHistogram查询报警历史的直方图列表调用DescribeAlertLogHistogram接口查询报警历史的直方图列表。
一键报警一键报警
DescribeProductsOfActiveMetricRule查询开通一键报警规则的云服务列表调用DescribeProductsOfActiveMetricRule接口查询开通一键报警规则的云服务列表。
DescribeActiveMetricRuleList查询一键报警规则的列表详情调用DescribeActiveMetricRuleList接口查询一键报警规则的列表详情。
EnableActiveMetricRule启用一键报警规则调用EnableActiveMetricRule接口启用一键报警规则。
DisableActiveMetricRule禁用一键报警规则调用DisableActiveMetricRule接口禁用一键报警规则。
报警模板报警模板
CreateMetricRuleTemplate创建报警模板调用CreateMetricRuleTemplate接口创建报警模板。
DeleteMetricRuleTemplate删除报警规则模板调用DeleteMetricRuleTemplate接口删除报警规则模板。
ModifyMetricRuleTemplate修改报警模板调用ModifyMetricRuleTemplate接口修改报警模板。
DescribeMetricRuleTemplateAttribute查询报警模板详情调用DescribeMetricRuleTemplateAttribute接口查询报警模板详情。
DescribeMetricRuleTemplateList查询报警模板列表调用DescribeMetricRuleTemplateList接口查询报警模板列表。
ApplyMetricRuleTemplate应用报警模板至应用分组调用ApplyMetricRuleTemplate接口将报警模板应用到应用分组并生成报警规则。
阈值报警规则阈值报警规则
DescribeMetricRuleList查询报警规则列表中的所有规则调用DescribeMetricRuleList接口查询报警规则列表中的所有规则。
CreateGroupMetricRules批量为指定应用分组创建报警规则调用CreateGroupMetricRules接口批量为指定应用分组创建报警规则。
CreateMetricRuleResources创建一个报警规则关联的资源调用CreateMetricRuleResources接口创建一个报警规则关联的资源。
DeleteMetricRuleTargets删除报警规则的推送渠道调用DeleteMetricRuleTargets接口删除一个报警规则的推送渠道。
DeleteMetricRules删除一个或多个报警规则调用DeleteMetricRules接口删除一个或多个报警规则。
DeleteMetricRuleResources删除报警规则关联的资源调用DeleteMetricRuleResources接口删除报警规则关联的资源。
EnableMetricRules启用一个或多个报警规则调用EnableMetricRules接口启用一个或多个报警规则。
DisableMetricRules禁用报警规则调用DisableMetricRules接口禁用报警规则。
DescribeMetricRuleTargets查询指定报警规则的推送渠道调用DescribeMetricRuleTargets接口查询指定报警规则的推送渠道。
DescribeMetricRuleCount获取各种状态报警规则的数量调用DescribeMetricRuleCount接口获取各种状态报警规则的数量。
DescribeAlertingMetricRuleResources查询指定报警规则中正在发生报警的资源列表调用DescribeAlertingMetricRuleResources接口查询指定报警规则中正在发生报警的资源列表。
PutMetricRuleTargets为指定报警规则添加或修改推送渠道调用PutMetricRuleTargets接口为指定报警规则添加或修改推送渠道。
PutResourceMetricRule为指定资源的指定监控项设置一条阈值报警规则调用PutResourceMetricRule接口为指定资源的指定监控项设置一条阈值报警规则。
PutResourceMetricRules为指定资源的指定监控项设置多条阈值报警规则调用PutResourceMetricRules接口为指定资源的指定监控项设置多条阈值报警规则。
PutGroupMetricRule创建或修改指定应用分组中的报警规则调用PutGroupMetricRule接口创建或修改指定应用分组中的报警规则。
事件报警规则事件报警规则
DeleteEventRuleTargets删除事件报警的推送渠道调用DeleteEventRuleTargets接口删除事件报警的推送渠道。
DeleteEventRules删除事件报警规则调用DeleteEventRules接口删除事件报警规则。
EnableEventRules启用一个或者多个事件监控报警规则调用EnableEventRules接口启用一个或者多个事件监控报警规则。
DisableEventRules调用DisableEventRule接口禁用一个或多个事件报警规则调用DisableEventRule接口禁用一个或多个事件报警规则。
DescribeEventRuleAttribute查询指定事件报警规则的详情调用DescribeEventRuleAttribute接口查询指定事件报警规则的详情。
DescribeEventRuleList查询事件报警规则列表调用DescribeEventRuleList接口查询事件报警规则列表。
DescribeEventRuleTargetList查询指定事件报警规则的推送渠道调用DescribeEventRuleTargetList接口查询指定事件报警规则的推送渠道。
PutEventRuleTargets添加或修改规则的推送渠道调用PutEventRuleTargets接口添加或修改规则的推送渠道。
PutEventRule创建或修改事件的报警规则调用PutEventRule接口创建或修改事件的报警规则。
PutCustomEventRule创建自定义事件报警规则调用PutCustomEventRule接口创建自定义事件报警规则。
报警黑名单报警黑名单
CreateMetricRuleBlackList创建报警黑名单策略调用CreateMetricRuleBlackList接口创建报警黑名单策略。
ModifyMetricRuleBlackList修改报警黑名单策略调用ModifyMetricRuleBlackList接口修改报警黑名单策略。
DeleteMetricRuleBlackList删除报警黑名单策略调用DeleteMetricRuleBlackList接口删除报警黑名单策略。
DescribeMetricRuleBlackList查询报警黑名单策略列表调用DescribeMetricRuleBlackList接口查询报警黑名单策略列表。
EnableMetricRuleBlackList启用或禁用报警黑名单策略调用EnableMetricRuleBlackList接口启用或禁用报警黑名单策略。
报警联系人报警联系人
DeleteContactGroup删除报警联系人组调用DeleteContactGroup接口删除报警联系人组。
DeleteContact删除报警联系人调用DeleteContact接口删除报警联系人。
DescribeContactListByContactGroup查询报警联系组中的报警联系人列表调用DescribeContactListByContactGroup接口查询报警联系组中的报警联系人列表。
DescribeContactGroupList查询报警联系组列表调用DescribeContactGroupList接口查询报警联系组列表。
DescribeContactList查询报警联系人列表调用DescribeContactList接口查询报警联系人列表。
PutContact创建或修改报警联系人信息调用PutContact接口创建或修改报警联系人信息。
PutContactGroup创建或修改报警联系组调用PutContactGroup接口创建或修改报警联系组。

企业云监控

API标题API概述
CreateHybridMonitorNamespace创建指标仓库调用CreateHybridMonitorNamespace接口创建指标仓库。
ModifyHybridMonitorNamespace修改指标仓库调用ModifyHybridMonitorNamespace接口修改指标仓库。
DeleteHybridMonitorNamespace删除指标仓库调用DeleteHybridMonitorNamespace接口删除指标仓库。
DescribeHybridMonitorNamespaceList查询指标仓库列表调用DescribeHybridMonitorNamespaceList接口查询指标仓库列表,及其接入数据详情。
CreateHybridMonitorTask创建监控任务调用CreateHybridMonitorTask接口创建阿里云产品的数据接入任务或SLS日志的监控项。
ModifyHybridMonitorTask修改监控任务调用ModifyHybridMonitorTask接口修改SLS日志的监控项。
DeleteHybridMonitorTask删除监控任务调用DeleteHybridMonitorTask接口删除阿里云产品的数据接入任务或SLS日志的监控项。
DescribeHybridMonitorTaskList查询数据接入任务列表调用DescribeHybridMonitorTaskList接口查询数据接入任务列表。
PutHybridMonitorMetricData上报监控数据至指标仓库调用PutHybridMonitorMetricData接口将指定监控数据上报至企业云监控的指定指标仓库中。
DescribeHybridMonitorDataList查询指定指标仓库中的监控数据调用DescribeHybridMonitorDataList接口查询指定指标仓库中的监控数据。
CreateHybridMonitorSLSGroup为SLS日志的监控项创建Logstore组调用CreateHybridMonitorSLSGroup接口为SLS日志的监控项创建Logstore组。
ModifyHybridMonitorSLSGroup修改Logstore组调用ModifyHybridMonitorSLSGroup接口修改Logstore组。
DeleteHybridMonitorSLSGroup删除Logstore组调用DeleteHybridMonitorSLSGroup接口删除Logstore组。
DescribeHybridMonitorSLSGroup查询Logstore组列表调用DescribeHybridMonitorSLSGroup接口查询Logstore组列表。
Cursor定义导出监控数据的范围调用Cursor接口定义导出监控数据的范围,并返回用于初始调用BatchExport接口的Cursor值。
BatchExport导出在Cursor中定义的监控数据调用BatchExport接口导出在Cursor接口中定义的监控数据。
  • 本页导读 (1)
文档反馈