文档中心

更新告警规则状态

最近更新时间：2024.01.31 15:20:03

首次发布时间：2023.07.28 15:16:37

本接口支持修改指定告警规则的开启状态。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
超时时间：超时时间约 5 秒。

请求说明

请求方式：POST
请求地址：https://imagex.volcengineapi.com/Action=UpdateImageMonitorRuleStatus&Version=2018-08-01

说明

veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共参数。

参数	类型	是否必选	示例值	描述
Content-Type	String	是	`application/json`	请求头字段

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`UpdateImageMonitorRuleStatus`	接口名称。当前 API 的版本为 `UpdateImageMonitorRuleStatus`。
Version	String	是	`2018-08-01`	接口版本。当前 API 的版本为 `2018-08-01`。

Body

参数类型是否必选示例值描述

RuleId String 是 h192a1****8i01 待更新的告警规则 ID，您可以调用 GetImageMonitorRules获取所需的告警规则 ID。

参数	类型	是否必选	示例值	描述
RuleId	String	是	`h192a1****8i01`	待更新的告警规则 ID，您可以调用 GetImageMonitorRules获取所需的告警规则 ID。
Enabled	Bool	是	`false`	是否开启告警监测，取值如下所示： `true`：开启 `false`：不开启

Enabled

Bool

是

false

是否开启告警监测，取值如下所示：

true：开启
false：不开启

返回参数

无

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=UpdateImageMonitorRuleStatus&Version=2018-08-01
{
	"RuleId": "18230***19270",
	"Enabled": false
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023061615574388A72E74B3D53A0B790E",
        "Action": "UpdateImageMonitorRuleStatus",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
    }
}

错误码

访问公共错误码以及通用错误码获取详细信息。