API 概覽 - Application Real-Time Monitoring Service

API標準及多語言預置SDK

本產品（ARMS/2019-08-08）的OpenAPI採用RPC簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK，開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜，需花費 5個工作日左右。因此建議加入我們的服務DingTalk群（147535001692），在專家指導下進行簽名對接。

在使用API前，您需要準備好身份帳號及存取金鑰（AccessKey），才能有效通過用戶端工具（SDK、CLI等）訪問API。細節請參見擷取AccessKey。

自訂簽名情境

若您的業務情境有特殊需求，需通過自簽名方式對接 API，建議優先諮詢我們的支援人員團隊（服務DingTalk群：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资源实例标签。