updateLogAlarm
更新时间：2023-09-21
描述
- 修改告警任务相关配置，不支持修改logStoreName。
- 修改过程中，需要全量配置告警任务配置
请求
- 请求语法
PUT /v1/alarm HTTP/1.1
Host: bls-log.{region}.baidubce.com
Authorization: authorization string- 请求头域
除公共请求头域外，无其它特殊头域。
- 请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| alarmName | String | yes | body | 告警任务名称，最长80个字符，包含字母、数字、-和_ |
| alarmConfig | AlarmConfig | yes | body | 告警任务配置 |
AlarmConfig结构：
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| alarmQuery | String | yes | body | 查询语句 |
| alarmTimeRange | Int | yes | body | 查询语句的时间范围，单位为分钟，范围是1-1440 |
| frequency | Int | yes | body | 推送指标周期，单位为分钟，范围是1-1440，推荐与查询语句时间范围相同 |
| metric | Metric | yes | body | 推送指标信息 |
Metric结构：
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| metricName | String | yes | body | 推送指标名称，3-50 个字符，包含字母、数字、-和_ |
| dimensions | LIST[Dimension] | no | body | 维度信息 |
Dimension结构：
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| name | string | yes | body | 维度名称，最多50个字符，包含字母、数字、-和_ |
响应
- 响应头域
除公共响应头域外，无其它特殊头域。
- 响应参数
无
错误码
除了通用的错误码，还可能出现如下错误码：
| 错误码 | 错误消息 | 描述 | HTTP状态码 |
|---|---|---|---|
| LogStoreNotFound | LogStore [logStoreName] not exists | LogStore 不存在 | 404 |
| Invalid request parameter | 指标[metric]要由英文字符，数字，连接符，下划线组成，长度为3-50 | 指标名称不符合规范 | 400 |
注：错误消息中 [logStoreName] 部分会用具体的名称来替换
示例
- 请求示例
PUT /v1/alarm/{alarm-1-1-11} HTTP/1.1
Host: bls-log.bj.baidubce.com
Authorization:bce-auth-v1/18717522d39411e9b721df098b0b908c/2019-09-10T07:00:20Z/1800/content-type;host;x-bce-date;x-bce-request-id/6a7cb6c9ac7ec156c805e55e7d0bcfc443b47feee97cf099c1c0d93a0b4c8304
Content-Type: application/json; charset=utf-8
{
"alarmName": "alarm1",
"alarmConfig": {
"alarmQuery": "select count(error) as errCount, error group by error",
"alarmTimeRange": 10,
"frequency": 10,
"metric": {
"metricName": "errCount",
"dimensions": [
"name": "error",
}]
}
}
}- 响应示例
HTTP/1.1 201
Content-Type: application/json; charset=utf-8
200