文档中心

新建告警规则

最近更新时间：2024.03.19 20:35:15

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

本接口支持在账号下创建一条告警规则。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
超时时间：超时时间约 5 秒。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

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

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

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

Query

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

Body

参数	类型	是否必选	示例值	描述
MonitorRule	Object of MonitorRule	是	`-`	告警规则

MonitorRule

参数	类型	是否必选	示例值	描述
Name	String	是	`test`	自定义告警规则名称
Phase	String	是	`upload`	监控阶段，取值如下所示： `upload`：图片上传-上传 1.0 `uploadv2`：图片上传-上传 2.0 `cdn`：图片加载-下行网络监控 `client`：图片加载-客户端传状态监控 `sensible`：图片加载-感知指标监控 `exceed`：图片加载-大图指标
Appid	String	是	`82**41`	监控的应用 ID，您可以通过调用获取应用列表的方式获取所需的 AppID。
OS	String	否	`Android`	监控平台，取值如下所示： `iOS` `Android` `WEB`
Frequency	Integer	是	`5`	监控频率，单位为分钟。取值如下所示： `5` `10` `20` `30` `40` `50`
Filter	Object of Filter	否	`-`	维度过滤条件，具体参数请见 Filter。用于指定需要告警提示的维度配置。
GroupBy	String	否	`AppVer`	拆分维度，由公共拆分维度和自定义拆分维度组合而成。
Cond	Object of Cond	是	`-`	监测规则。
Level	String	是	`warn`	告警级别，取值如下所示： `warn`：警告 `error`：错误 `fatal`：致命
Enabled	Boolean	是	`true`	创建后是否立即开启告警，取值如下所示： `true`：开启 `false`：关闭
Notification	Object of Notification	是	`-`	告警通知配置。

Filter

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

参数	类型	是否必选	示例值	描述
LogicOp	String	是	`or`	过滤条件之间的逻辑关系，取值如下所示： `and`：和 `or`：或
DimFilter	Array of DimFilter	是	`-`	过滤条件

LogicOp

String

是

or

过滤条件之间的逻辑关系，取值如下所示：

and：和
or：或

DimFilter Array of DimFilter 是 - 过滤条件

Cond

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

参数	类型	是否必选	示例值	描述
LogicOp	String	是	`and`	多条监控规则之间的逻辑关系，取值如下所示： `and`：且。表示有多条监控规则时，需满足所有监控规则才会触发告警通知。 `or`：或。表示有多条监控规则时，满足其中一条监控规则就会触发告警通知。
ItemCond	Object of ItemCond	是	`-`	监控规则配置

LogicOp

String

是

and

多条监控规则之间的逻辑关系，取值如下所示：

and：且。表示有多条监控规则时，需满足所有监控规则才会触发告警通知。
or：或。表示有多条监控规则时，满足其中一条监控规则就会触发告警通知。

ItemCond Object of ItemCond 是 - 监控规则配置

Notification

参数	类型	是否必选	示例值	描述
Mode	Array of String	是	`http_callback`	通知方式，仅支持取值 `http_callback`，表示回调。
CallbackUrl	String	否	`http://test.com`	回调地址，`Mode` 包含 `http_callback`时，为必填。
SilentDur	Integer	是	`30`	沉默周期，单位为分钟。告警发生后，若未恢复正常，则会间隔一个沉默周期后再次重复发送一次告警通知。取值如下所示： `0` `30` `60` `360`
Title	String	是	`【veImageX图片服务】报警通知`	告警通知标题
Content	String	是	告警名称：$报警名称$ 告警级别：$报警级别$ 告警App：$报警App$ 告警平台：$报警平台$ 告警时间：$报警时间$ 告警内容：$报警内容$	通知内容模板，模板中变量格式为 $Name$ 。Name 取值如下所示： `报警名称` `报警级别` `报警App` `报警平台` `报警时间` `报警内容`

DimFilter

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

Dim String 是 ImageType 维度名称，由公共过滤维度和自定义过滤维度组合而成。

Vals Array of String 是 png 维度取值，您可以通过调用获取自定义维度值来获取。

参数	类型	是否必选	示例值	描述
Dim	String	是	`ImageType`	维度名称，由公共过滤维度和自定义过滤维度组合而成。
Vals	Array of String	是	`png`	维度取值，您可以通过调用获取自定义维度值来获取。
Not	Boolean	否	`false`	纬度值是否取反，取值如下所示： `true`：指定维度的实际值不得满足 `Vals` 所有指定值 `false`：（默认）维度值等于 `Vals` 中之一即可

Not

Boolean

否

false

纬度值是否取反，取值如下所示：

true：指定维度的实际值不得满足 Vals 所有指定值
false：（默认）维度值等于 Vals 中之一即可

ItemCond

参数	类型	是否必选	示例值	描述
Item	String	是	`cdn_srate`	指标名称，取值参考 veImageX 告警指标定义。
Func	String	是	`avg`	指标取值函数，取值如下所示： `max`：最大值 `min`：最小值 `avg`：平均值 `pct25`：25峰值 `pct50`：50峰值 `pct90`：90峰值 `pct99`：99峰值 `sum`：总和说明各指标支持的函数参考 veImageX 告警指标定义。
Op	String	是	`LE`	指标比较方法，取值如下所示： `LE`：小于等于 `GE`：大于等于 `INC`：环比上升大于等于 `INC_LE`：环比上升小于等于 `DEC`：环比下降小于等于 `DEC_GE`：环比下降大于等于 `HOH_INC`：与上小时同比上升大于等于 `HOH_INC_LE`：与上小时同比上升小于等于 `HOH_DEC`：与上小时同比下降小于等于 `HOH_DEC_GE`：与上小时同比下降大于等于 `DOD_INC`：与昨天同比上升大于等于 `DOD_INC_LE`：与昨天同比上升小于等于 `DOD_DEC`：与昨天同比下降小于等于 `DOD_DEC_GE`：与昨天同比下降大于等于
Threshold	Float	是	`50`	指标比较阈值，需要与 `CntThreshold` 同时被满足才会触发告警。
CntThreshold	Integer	否	`200`	样本量阈值。被监控指标超过该值时触发告警。
AggrInterval	Integer	是	`5`	聚合周期，单位为分钟。被监控指标在该指定周期内满足指标比较阈值且上报量满足样本量阈值时，才会触发告警。取值如下所示： `5` `10`
RepeatCnt	Integer	是	`3`	持续周期，当监控指标在聚合周期内，连续`RepeatCnt`次满足指标比较阈值且上报量满足样本量阈值时，才会触发告警。取值如下所示： `1` `3` `5`

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数	类型	示例值	描述
RuleId	String	`R1ae373c0-0686-***-bf6f-84d529c55881`	告警规则 ID

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=CreateImageMonitorRule&Version=2018-08-01
{
   "MonitorRule":{
      "Name":"test",
      "AlarmType":"load",
      "Phase":"client",
      "Level":"warn",
      "AppId":"10**25",
      "Frequency":5,
      "GroupBy":"Domain",
      "Filter":{
         "DimFilter":[
            {
               "Dim":"ImageType",
               "Not":false,
               "Vals":[
                  "HEIC"
               ]
            }
         ],
         "LogicOp":"and"
      },
      "Cond":{
         "ItemCond":[
            {
               "Item":"client_load_duration",
               "Func":"avg",
               "Op":"GE",
               "Threshold":5000,
               "CntThreshold":50,
               "AggrInterval":5,
               "RepeatCnt":1
            }
         ],
         "LogicOp":"and"
      },
      "Notification":{
         "CallbackUrl":"https://test.com",
         "SilentDur":30,
         "Content":"告警名称：$告警名称$\n告警级别：$告警级别$\n告警App：$告警App$\n告警平台：$告警平台$\n告警时间：$告警时间$\n告警内容：$告警内容$",
         "Mode":[
            "http_callback"
         ],
         "Title":"【veImageX图片服务】报警通知"
      },
      "Enabled":false
   }
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023061615574388A72E74B3D53A0B790E",
        "Action": "CreateImageMonitorRule",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
    	  "RuleId": "R1ae373c0-0686-***-bf6f-84d529c55881"
    }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码。

注意事项

请求说明

请求参数

Header

Query

Body

MonitorRule

Filter

Cond

Notification

DimFilter

ItemCond

返回参数

示例

请求示例

返回示例

错误码