文档

API概览

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

告警管理(新版)

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。
ChangeResourceGroupARMS资源转组修改资源所属资源组。
TagResources创建标签资源关系用于给ARMS资源实例打标签。
UntagResources删除标签资源关系用于删除ARMS资源实例标签。