更新时间:2025-08-28 GMT+08:00

启停告警规则

功能介绍

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

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

调试

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

URI

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

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    参数解释:

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

    约束限制:

    不涉及。

    取值范围:

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

    默认取值:

    不涉及。

    alarm_id

    参数解释:

    告警规则的ID。

    约束限制:

    不涉及。

    取值范围:

    以al开头,后跟22个数字或字母。 字符长度为24。

    默认取值:

    不涉及。

  • 样例
    PUT https://{云监控的endpoint}/V1.0/{project_id}/alarms/al1441967036681YkazZ0deN/action

请求消息

  • 请求参数
    表2 请求参数

    名称

    是否必选

    参数类型

    说明

    alarm_enabled

    Boolean

    参数解释:

    是否开启告警规则。

    约束限制:

    不涉及。

    取值范围:

    布尔值。true:开启,false:关闭。

    默认取值:

    不涉及。

  • 请求样例
    {
        "alarm_enabled":true
    }

响应消息

无消息体

返回值

  • 正常

    204

  • 异常

    返回值

    说明

    400 Bad Request

    请求错误。

    401 Unauthorized

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

    403 Forbidden

    请求页面被禁止访问。

    408 Request Timeout

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

    429 Too Many Requests

    当前请求过多。

    500 Internal Server Error

    请求未完成,服务异常。

    503 Service Unavailable

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

错误码

请参考返回错误码说明