文档首页/ 云监控服务 CES/ API参考/ API/ 告警/ 告警规则管理/ 启停告警规则 - UpdateAlarmAction
更新时间:2026-06-11 GMT+08:00

启停告警规则 - UpdateAlarmAction

功能介绍

启动或停止一条告警规则。

告警规则V1接口只支持配置单资源单策略规则,建议使用批量启停告警规则与前端功能配套使用。

调试

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

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    ces:alarms:putAction

    Write

    alarm *

    • g:ResourceTag/<tag-key>

    • g:EnterpriseProjectId

    ces:alarms:put

    -

URI

PUT /V1.0/{project_id}/alarms/{alarm_id}/action

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及。

取值范围:

长度为[1,64]个字符。

默认取值:

不涉及。

alarm_id

String

参数解释

告警规则ID,

约束限制

不涉及。

取值范围

以al开头,后跟22位由字母或数字组成的字符串。长度为24个字符。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

参数解释:

发送的实体的MIME类型。

约束限制:

不涉及。

取值范围:

长度为[1,64]个字符。

默认取值:

默认使用 application/json; charset=UTF-8,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。

X-Auth-Token

String

参数解释:

用户Token。

约束限制:

不涉及。

取值范围:

长度为[1,16384]个字符。

默认取值:

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

alarm_enabled

Boolean

参数解释

告警是否启用

约束限制

不涉及

取值范围

  • true:开启告警

  • false:关闭告警

默认取值

不涉及

响应参数

状态码:204

No Content

状态码:400

表4 响应Body参数

参数

参数类型

描述

-

String

请求错误。

状态码:401

表5 响应Body参数

参数

参数类型

描述

-

String

未提供认证信息,或认证信息错误。

状态码:403

表6 响应Body参数

参数

参数类型

描述

-

String

请求页面被禁止访问。

状态码:408

表7 响应Body参数

参数

参数类型

描述

-

String

请求超出了服务器的等待时间。

状态码:429

表8 响应Body参数

参数

参数类型

描述

-

String

请求过多。

状态码:500

表9 响应Body参数

参数

参数类型

描述

-

String

请求未完成,服务异常。

状态码:503

表10 响应Body参数

参数

参数类型

描述

-

String

系统暂时不可用,请求受限。

请求示例

{
  "alarm_enabled" : true
}

响应示例

状态码

状态码

描述

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

408

Request Timeout

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

错误码

请参见错误码