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

ModifyAlarm

最近更新时间2023.11.13 16:31:28

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

调用 ModifyAlarm 接口修改告警策略。

使用说明

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

URI

请求方法
PUT

URI

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

传输协议

HTTPS

请求参数

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

AlarmId

String

必选

al****

告警策略 ID。

AlarmName

string

可选

test-alarm

告警策略名称。

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

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

可选

告警通知

自定义告警通知内容。

响应参数


示例

请求示例

PUT https://tls-{Region}.ivolces.com/ModifyAlarm HTTP/1.1
Content-Type: application/json
...
{
    "AlarmId": "7626228d-b813-42f4-86e5-84d6c3******",
    "AlarmNotifyGroup": ["9f5db662-2aa4-42b5-ae82-9c0593******"],
     "AlarmPeriodDetail":{
        "SMS":10,
        "Phone":10,
        "Email":2,
        "GeneralWebhook":3
    },
    "Condition": "$1.errNum>0",
    "AlarmName": "test",
    "QueryRequest": [
        {
            "EndTimeOffset": 0,
            "Number": 1,
            "Query": "Failed | select count(*) as errNum",
            "StartTimeOffset": -120,
            "TopicId": "29374d88-52ea-4184-9ce0-0250b3******"
        }
    ],
    "RequestCycle": {
        "Time": 60,
        "Type": "Period"
    },
    "TriggerPeriod": 1,
    "UserDefineMsg": "test"
}

响应示例

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

错误码

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

InvalidArgument

400

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

参数不合法。

AlarmQuotaExceed

400

Alarm Quota Exceed.

超过告警策略限额。

AlarmNotExist

404

Alarm xxx does not exist

告警策略不存在。

InternalServerError

500

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

服务器内部错误。

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