API概览 - 应用实时监控服务ARMS

API标准及多语言预置SDK

本产品（ARMS/2019-08-08）的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。

在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。

自定义签名场景

若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。

账号与安全准备

阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。

告警管理（新版）

API	标题	API概述
CreateIntegration	创建告警集成	创建告警集成。
UpdateIntegration	修改集成相关信息	修改集成相关信息。
DeleteIntegrations	删除指定告警集成	删除指定告警集成。
ListIntegration	查看集成列表详情	查看集成列表详情。
CreateOrUpdateAlertRule	创建或修改告警规则	创建或修改告警规则。
DeleteAlertRule	删除告警规则	删除告警规则。
ListAlertEvents	查询告警事件历史	查询告警事件历史。
GetAlertRules	获取已经创建的告警规则	查询已经创建的告警规则。
CreateOrUpdateContact	创建或修改联系人	创建或者修改告警联系人。
SendTTSVerifyLink	告警联系人发送手机号码验证	为告警联系人发送手机号码验证短信。
DeleteContact	删除告警联系人	删除告警联系人。
DescribeContacts	查询告警联系人列表	查询告警联系人列表。
CreateOrUpdateContactGroup	创建或修改告警联系人组	创建或修改告警联系人组。
DeleteContactGroup	删除告警联系人组	删除告警联系人组。
DescribeContactGroups	查询告警联系人分组信息	查询告警联系人分组信息。
CreateOrUpdateIMRobot	创建或更新IM机器人	创建或更新IM机器人。
DeleteIMRobot	删除IM机器人	删除IM机器人。
DescribeIMRobots	查询IM机器人列表	查询IM机器人列表。
CreateOrUpdateWebhookContact	创建或修改Webhook告警联系人	创建或修改Webhook告警联系人。
DeleteWebhookContact	删除Webhook告警联系人	删除Webhook告警联系人。
DescribeWebhookContacts	查询Webhook告警联系人列表	查询Webhook告警联系人列表。
CreateOrUpdateEventBridgeIntegration	创建或修改EventBridge通知集成	创建或修改EventBridge通知集成。
DeleteEventBridgeIntegration	删除EventBridge通知集成	删除EventBridge通知集成。
ListEventBridgeIntegrations	查询EventBridge通知集成信息	查询EventBridge通知集成信息。
CreateOrUpdateNotificationPolicy	新增及修改通知策略	创建或更新通知策略。
DeleteNotificationPolicy	删除通知策略	根据通知策略ID删除通知策略。
ListNotificationPolicies	查询通知策略信息	通过指定条件查询通知策略信息。
CreateOrUpdateSilencePolicy	新增及修改静默策略	创建或修改静默策略。
DeleteSilencePolicy	删除静默策略	调用DeleteSilencePolicy接口根据静默策略ID删除静默策略。
ListEscalationPolicies	查询升级策略信息	调用ListEscalationPolicies接口查询升级策略信息。
ListOnCallSchedules	查询排班策略	调用ListOnCallSchedules接口查询排班策略信息。
GetOnCallSchedulesDetail	查询排班策略信息	调用GetOnCallSchedulesDetail接口查询排班策略信息。
ListSilencePolicies	静默策略列表信息	调用ListSilencePolicies接口查询静默策略列表信息。
ListAlerts	查询告警发送历史	告警发送历史接口。
BlockAlarmNotification	屏蔽告警通知	屏蔽告警通知，屏蔽后告警在指定的时间范围内不再发生通知。
ChangeAlarmSeverity	修改告警等级	修改告警等级。
CloseAlarm	关闭告警	关闭告警，请确保告警恢复后再关闭告警。如果告警一直处于触发状态，关闭告警后又会产生新的告警。
ClaimAlarm	认领告警	认领告警，配合升级策略使用。在告警协同处理时可以，认领后表示该告警正在处理中。

访问控制

API	标题	API概述
OpenArmsServiceSecondVersion	开通ARMS	开通ARMS下指定子产品的后付费功能。
OpenXtraceDefaultSLR	开通可观测链路 OpenTelemetry 版服务关联角色	开通可观测链路 OpenTelemetry 版服务关联角色AliyunServiceRoleForXtrace。
OpenArmsDefaultSLR	开通ARMS服务关联角色	开通ARMS服务关联角色AliyunServiceRoleForARMS。
ChangeResourceGroup	ARMS资源转组	修改资源所属资源组。
TagResources	创建标签资源关系	用于给ARMS资源实例打标签。
UntagResources	删除标签资源关系	用于删除ARMS资源实例标签。