API概览

通过使用云监控所提供的接口，您可以完整地使用云监控的所有功能。例如查询指标列表、创建告警规则等。

表1 接口说明
类型	子类型	API	说明
API V1	API版本号管理	查询API所有版本	查询云监控支持的API所有版本号。
	API版本号管理	查询API指定版本号	查询云监控API指定版本号。
	指标管理	查询指标列表（ListMetrics）	查询系统当前可监控指标的列表。
	告警规则管理	查询告警规则列表（ListAlarms）	查询系统当前告警规则列表。
		查询单条告警规则信息（ShowAlarm）	根据告警ID查询告警规则信息。
		启停告警规则（UpdateAlarmAction）	根据告警ID启动或停止一条告警规则。
		删除告警规则（DeleteAlarm）	根据告警ID删除一条告警规则。
		创建告警规则（CreateAlarm）	为系统当前的指标创建一条告警规则。
		创建自定义告警模板（CreateAlarmTemplate）	创建自定义告警模板来添加一个或者多个指标的告警规则。
		删除自定义告警模板（DeleteAlarmTemplate）	删除自定义告警模板。
		查询告警历史（ListAlarmHistories）	根据告警ID查询告警历史。
		查询自定义告警模板列表（ListAlarmTemplates）	查询自定义告警模板列表。
		更新自定义告警模板（UpdateAlarmTemplate）	更新自定义告警模板。
		修改告警规则（UpdateAlarm）	修改告警规则。
	监控数据管理	查询监控数据（ShowMetricData）	查询指定时间范围指定指标的指定粒度的监控数据。
		添加监控数据（CreateMetricData）	添加一条或多条指标监控数据。
		批量查询监控数据（BatchListMetricData）	批量查询指定时间范围内指定指标的指定粒度的监控数据，目前最多支持10指标的批量查询。
		查询主机配置数据（ShowEventData）	查询指定时间范围指定事件类型的主机配置数据，可以通过参数指定需要查询的数据维度。
	配额管理	查询配额（ShowQuotas）	查询告警规则配额。
	资源分组管理	查询资源分组下的资源（ShowResourceGroup）	查询资源分组下的资源。
		创建资源分组（CreateResourceGroup）	创建资源分组。
		更新资源分组（ShowResourceGroup）	更新资源分组。
		删除资源分组（DeleteResourceGroup）	删除资源分组。
		查询所有资源分组（ListResourceGroup）	查询所创建的所有资源分组。
	事件监控	上报事件（CreateEvents）	通过该接口上报自定义事件。
		查询事件监控列表（ListEvents）	查询事件列表，包括系统事件和自定义事件。
		查询某一事件监控详情（ListEventDetail）	根据事件监控名称，查询该事件发生的详细信息。
API V2	告警规则	创建告警规则（CreateAlarmRules）	创建告警规则。
		批量删除告警规则（BatchDeleteAlarmRules）	批量删除告警规则。
		批量启停告警规则（BatchEnableAlarmRules）	批量启停告警规则。
		查询告警规则列表（ListAlarmRules）	查询告警规则列表
	告警资源	批量增加告警规则资源（AddAlarmRuleResources）	批量增加告警规则资源(资源分组类型的告警规则不支持)。
		批量删除告警规则资源（DeleteAlarmRuleResources）	批量删除告警规则资源（资源分组类型的告警规则不支持）。
		查询告警规则资源列表（ListAlarmRuleResources）	根据告警规则ID查询告警规则资源列表。
	告警策略	修改告警规则策略(全量修改)（UpdateAlarmRulePolicies）	修改告警规则策略(全量修改)。
	告警策略	查询告警规则策略列表（ListAlarmRulePolicies）	根据告警规则ID查询策略列表。
	告警通知	修改告警规则告警通知信息（UpdateAlarmNotifications）	修改告警规则告警通知信息。
	告警记录	查询告警记录列表（ListAlarmHistories）	查询告警记录列表。
	告警模板	创建自定义告警模板（CreateAlarmTemplate）	创建自定义告警模板。
		批量删除自定义告警模板（BatchDeleteAlarmTemplates）	批量删除自定义告警模板。
		修改自定义告警模板（UpdateAlarmTemplate）	修改自定义告警模板。
		查询告警模板列表（ListAlarmTemplates）	查询告警模板列表。
		查询告警模板详情（ShowAlarmTemplate）	查询告警模板详情。
	告警模板关联告警规则	查询告警模板关联的告警规则列表（ListAlarmTemplateAssociationAlarms）	查询告警模板关联的告警规则列表。
	资源分组	创建资源分组（CreateResourceGroup）	创建资源分组。
		批量删除资源分组（BatchDeleteResourceGroups）	批量删除资源分组。
		修改资源分组（UpdateResourceGroup）	修改资源分组。
		查询指定资源分组详情（ShowResourceGroup）	查询指定资源分组详情。
		查询资源分组列表（ListResourceGroups）	查询资源分组列表。
		资源分组异步关联自定义告警模板（UpdateResourceGroupAssociationAlarmTemplate）	提交资源分组批量关联自定义告警模板异步任务，由异步任务覆盖性创建告警规则。
	资源分组关联资源	自定义资源分组批量增加关联资源（BatchCreateResources）	给自定义资源分组，即类型为手动添加的资源分组，批量增加关联资源。
		自定义资源分组批量删除关联资源（BatchDeleteResources）	给自定义资源分组，即类型为手动添加的资源分组，批量删除关联资源。
		查询资源分组下指定服务类别特定维度的资源列表（ListResourceGroupsServicesResources）	查询资源分组下指定服务类别特定维度的资源列表。
	一键告警	创建一键告警（CreateOneClickAlarm）	创建一键告警。
		查询一键告警列表（ListOneClickAlarms）	查询一键告警列表。
		查询一键告警关联告警规则列表（ListOneClickAlarmRules）	查询一键告警关联告警规则列表。
		批量修改一键告警关联告警规则的启用状态（BatchUpdateOneClickAlarmsEnabledState）	批量修改一键告警关联告警规则的启用状态。
		批量删除一键告警（BatchDeleteOneClickAlarms）	批量删除一键告警。
		批量修改开启状态的一键告警关联告警规则的告警通知（UpdateOneClickAlarmNotifications）	批量修改开启状态的一键告警关联告警规则的告警通知。
		批量修改一键告警关联告警规则策略的启用状态（BatchUpdateOneClickAlarmPoliciesEnabledState）	批量修改一键告警关联告警规则策略的启用状态。
	告警通知屏蔽	批量设置告警通知屏蔽规则（BatchUpdateNotificationMasks）	批量设置告警通知屏蔽规则。
		批量修改告警通知屏蔽规则的屏蔽时间（BatchUpdateNotificationMaskTime）	批量修改告警通知屏蔽规则的屏蔽时间。
		修改告警通知屏蔽规则（UpdateNotificationMasks）	修改告警通知屏蔽规则。
		批量删除告警通知屏蔽规则（BatchDeleteNotificationMasks）	批量删除告警通知屏蔽规则。
		查询告警通知屏蔽列表（ListNotificationMasks）	查询告警通知屏蔽列表。
		查询告警通知屏蔽资源列表（ListNotificationMaskResources）	查询告警通知屏蔽资源列表。
	监控看板	创建/复制监控看板（CreateOneDashboard）	创建/复制监控看板。
		查询监控看板列表（ListDashboardInfos）	查询监控看板列表。
		修改监控看板（UpdateDashboard）	修改监控看板。
		批量删除监控看板（DeleteDashboards）	批量删除监控看板。
	监控视图	创建/复制/批量创建监控视图到指定的监控看板（CreateDashboardWidgets）	创建/复制/批量创建监控视图到指定的监控看板。
		查询指定监控看板下的监控视图列表（ListDashboardWidgets）	查询指定监控看板下的监控视图列表。
		查询指定监控视图信息（ShowWidget）	查询指定监控视图信息。
		删除指定监控视图（DeleteOneWidget）	删除指定监控视图。
		批量更新监控视图（BatchUpdateWidgets）	批量更新监控视图.
	资源标签管理	查询CES指定项目指定资源类型标签列表（ListCesTargetProjectTags）	查询CES指定项目指定资源类型标签列表
	指标管理	查询主机监控维度指标信息（ListAgentDimensionInfo）	根据ECS/BMS资源ID查询磁盘、挂载点、进程、显卡、RAID控制器维度指标信息。
API V3	插件状态查询	插件状态查询（ListAgentStatus）	插件状态查询，包括uniagent状态以及插件状态。
	Agent任务相关接口	查询Agent任务列表（ListAgentInvocations）	查询Agent任务列表。
	Agent任务相关接口	批量创建Agent任务（BatchCreateAgentInvocations）	批量创建Agent任务。

上一篇：使用前必读

下一篇：如何调用API

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

盘古Doer提问云社区提问

API概览

相关文档

意见反馈

文档内容是否对您有帮助？