文档首页/ 云监控服务 CES/ API参考/ API/ 告警/ 一键告警/ 批量修改一键告警关联告警规则的启用状态
更新时间:2025-08-26 GMT+08:00
分享

批量修改一键告警关联告警规则的启用状态

功能介绍

批量修改一键告警关联告警规则的启用状态

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

PUT /v2/{project_id}/one-click-alarms/{one_click_alarm_id}/alarm-rules/action

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

租户ID。用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取方式请参见“获取项目ID”。

约束限制:

不涉及。

取值范围:

字符串的长度必须在 1 到 64个字符之间。

默认取值:

不涉及。

one_click_alarm_id

String

参数解释

一键告警ID。

约束限制

不涉及。

取值范围

只能为字母或者数字,字符长度为[1,64]

默认取值

不涉及。

正则匹配:^([a-z]|[A-Z]|[0-9]){1,64}$

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

参数解释:

发送的实体的MIME类型。

约束限制:

不涉及。

取值范围:

最小字符数量为1,最大为64。

默认取值:

默认使用application/json; charset=UTF-8。

默认取值:

application/json; charset=UTF-8

X-Auth-Token

String

参数解释:

用户Token。

约束限制:

不涉及。

取值范围:

最小字符数量为1,最大为16384。

默认取值:

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

alarm_ids

Array of strings

参数解释

需要批量启停的告警规则的ID列表。

约束限制

告警规则的ID的数量最多为100个,最少1个。

alarm_enabled

Boolean

参数解释

是否开启告警规则。

约束限制

不涉及。

取值范围

布尔值。

  • true:开启。

  • false:关闭。

默认取值

true

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

alarm_ids

Array of strings

参数解释

成功启停的告警规则ID列表。

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

状态码:401

表6 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

状态码:403

表7 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

状态码:404

表8 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

状态码:500

表9 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

请求示例

{
  "alarm_ids" : [ "al123232232341232132" ],
  "alarm_enabled" : true
}

响应示例

状态码:200

启停告警规则成功

{
  "alarm_ids" : [ "al123232232341232132" ]
}

状态码

状态码

描述

200

启停告警规则成功

400

参数校验失败

401

未认证

403

认证鉴权失败

404

资源不存在

500

系统内部错误

错误码

请参见错误码

相关文档