You need to enable JavaScript to run this app.
导航

CreateAlarm

最近更新时间2024.01.25 17:43:10

首次发布时间2022.05.11 11:26:48

调用 CreateAlarm 接口创建告警策略。

使用说明

此接口的调用频率限制为 20 次/s,超出频率限制会报错 ExceedQPSLimit。

说明

一个手机号码每分钟最多收到1条告警短信,每天最多 50 条,且与火山引擎其他消息通知服务共用短信额度。

URI

请求方法
POST

URI

https://tls-{Region}.ivolces.com/CreateAlarm

传输协议

HTTPS

请求参数

参数
参数类型
是否必选
示例值
说明

AlarmName

String

必选

test-alarm

告警策略名称。

  • 同一个日志项目下,告警策略名称不可重复。
  • 只能包括小写字母、中文、数字、连字符(-)。
  • 必须以小写字母、中文、数字开头或结尾。
  • 长度为 3~63 字符。

ProjectId

String

必选

test

告警策略所属的日志项目 ID。

Status

Boolean

可选

true

是否开启告警策略。默认值为 true,即开启。

QueryRequest

Array of
QueryRequest

必选

/

检索分析语句,可配置 1~3 条。详细说明请参考QueryRequest

RequestCycle

RequestCycle

必选

/

查询或分析请求的执行周期。详细信息请参考 RequestCycle

Condition

String

必选

$1.errNum>0

告警触发条件。

Severity

String

可选

notice

告警通知的级别,即告警的严重程度。支持设置为 noticewarningcritical,严重程度递增。默认为 notice

TriggerPeriod

Integer

可选

2

持续周期。持续满足触发条件 TriggerPeriod 个周期后,再进行告警;最小值为 1,最大值为 10,默认为 1。

AlarmPeriod

Integer

可选

60

告警通知发送的周期。当告警持续触发次数达到指定限额(TriggerPeriod)时,日志服务会根据指定的周期发送告警通知。
此参数用于指定所有渠道的告警通知发送周期。单位为分钟。取值范围是10~1440。

说明

AlarmPeriod 和 AlarmPeriodDetail 不可同时为空,也不可同时指定,同时指定时以 AlarmPeriodDetail 设置为准。

AlarmPeriodDetail

AlarmPeriodSetting

可选

/

告警通知发送的周期。当告警持续触发次数达到指定限额(TriggerPeriod)时,日志服务会根据指定的周期发送告警通知。
此参数用于为各渠道分别设置发送周期,详细说明请参考 AlarmPeriodSetting

说明

AlarmPeriod 和 AlarmPeriodDetail 不可同时为空,也不可同时指定,同时指定时以 AlarmPeriodDetail 设置为准。

AlarmNotifyGroup

Array of String

必选

/

告警对应的通知组列表。

UserDefineMsg

String

可选

告警通知

自定义告警通知内容。

响应参数

参数
参数类型
示例值
说明

AlarmId

String

fc********

告警策略ID。

示例

请求示例

POST https://tls-{Region}.ivolces.com/CreateAlarm HTTP/1.1
Content-Type: application/json
...
{
    "AlarmNotifyGroup": [
        "113*********"
    ],
     "AlarmPeriodDetail":{
        "SMS":10,
        "Phone":10,
        "Email":2,
        "GeneralWebhook":3
    },
    "Condition": "$1.errNum>0",
    "Name": "test",
    "ProjectId": "ebf**********",
    "QueryRequest": [
        {
            "EndTimeOffset": 0,
            "Number": 1,
            "Query": "Failed | select count(*) as errNum",
            "StartTimeOffset": -15,
            "TopicId": "864*********"
        }
    ],
    "RequestCycle": {
        "Time": 10,
        "Type": "Period"
    },
    "TriggerPeriod": 1,
    "UserDefineMsg": "test"
}

响应示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
    "AlarmId":"fc6**********"
}

错误码

错误码(Code)
HTTP 状态码
错误信息(Message)
说明

InvalidArgument

400

Invalid argument key %s, value %s, please check argument.

参数不合法。

ExceedAlarmPolicyProjectQuota

400

Exceed project's alarm policy quota.

超过日志项目的告警策略配额。

ExceedAlarmPolicyTopicQuota

400

Exceed topic's alarm policy quota, topicId: %s.

超过日志主题的告警策略配额。

AlarmAlreadyExist

409

Alarm xxx already exist

告警策略已存在。

InternalServerError

500

We encountered an unexpected server error . Please try again later.

服务器内部错误。

更多信息,请参考通用错误码