批量清除告警 - ClearAlarm
功能介绍
批量清除告警。用户可根据告警影响以及执行任务后告警的上报情况，手动选择告警进行清除。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
coc:alarm:clear
Write
-
-
-
-
URI
POST /v1/alarm-mgmt/alarms/cancel
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
remarks | 否 | String | 参数解释： 告警备注。 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
alarm_ids | 是 | String | 参数解释： 告警ID列表。 约束限制： 请选择告警管理中汇聚告警中的告警ID。 取值范围： 不涉及 默认取值： 不涉及 |
is_service_interrupt | 否 | Boolean | 参数解释： 是否中断。 约束限制： 不涉及 取值范围：
默认取值： false |
start_time | 否 | Long | 参数解释： 故障发生时间。 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
fault_recovery_time | 否 | Long | 参数解释： 故障恢复时间。 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
响应参数
状态码：200
参数 | 参数类型 | 描述 |
|---|---|---|
data | Array of strings | 参数解释： 清除的告警ID列表。 约束限制： 不涉及 默认取值： 不涉及 |
请求示例
清除告警id列表为‘ALM2025071215495805XCFf001’，ALM2025071215495805XCFf002'，业务不中断，备注为‘演示’的告警。
GET https://{Endpoint}/v1/alarm-mgmt/alarms/cancel
{
"alarm_ids" : "ALM2025071215495805XCFf001,ALM2025071215495805XCFf002",
"is_service_interrupt" : false,
"remarks" : "演示"
} 响应示例
状态码：200
正确响应
{
"data" : [ "ALM2025071215495805XCFf001", "ALM2025071215495805XCFf002" ]
} 状态码
状态码 | 描述 |
|---|---|
200 | 正确响应 |
错误码
请参见错误码。
