listLogAlarm
更新时间：2024-09-11
描述
查看符合查询条件的告警任务。
请求
- 请求语法
GET /v1/alarm?alarmID={}&alarmName={}&project={}&logStoreName={}&destType={}&status={}&orderBy={}&order={}&pageNo={}&pageSize={} HTTP/1.1
Host: bls-log.{region}.baidubce.com
Authorization: authorization string- 请求头域
除公共请求头域外，无其它特殊头域。
- 请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| alarmName | String | no | query | 告警策略名称， 如果填写则进行模糊查询 |
| alarmID | String | no | query | 告警策略ID，如果填写则进行模糊查询 |
| project | String | no | query | 日志组名称，如果填写则对日志组进行精确匹配，并返回对应告警策略列表 |
| logStoreName | String | no | query | 日志集名称，如果填写则对日志集模糊匹配，并返回对应告警策略列表 |
| status | String | no | query | 按告警任务状态过滤，可选：运行中（Running）、运行中（有异常）（Abnormal）、未运行（Paused） |
| orderBy | String | no | query | 排列顺序，目前仅支持按照（createDateTime）进行排序，默认排序列为（createDateTime) |
| order | String | no | query | 可选 asc/desc，默认为降序 |
| pageNo | Int | no | query | 页码，从默认值1开始 |
| pageSize | int | no | query | 分页大小, 范围 [10, 100]， 默认为10 |
响应
- 响应头域
除公共响应头域外，无其它特殊头域。
- 响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| alarmResult | LIST[Alarm] | 告警列表 |
| count | int | 返回告警策略数目 |
Alarm结构：
| 参数名称 | 类型 | 描述 |
|---|---|---|
| id | String | 告警策略ID |
| alarmName | String | 告警策略名称 |
| status | String | 告警策略运行状态 |
| createDateTime | String | 创建时间 |
| project | String | 告警策略监控的日志组名称 |
| logStoreName | String | 告警策略监控的日志集名称 |
| alarmConfig | alarmConfig | 告警配置 |
| tags | LIST[Tag] | 标签 |
AlarmConfig结构：
| 参数名称 | 类型 | 描述 |
|---|---|---|
| alarmQuery | String | 查询语句 |
| alarmTimeRange | Int | 查询语句的时间范围，单位为分钟 |
| frequency | Int | 推送指标周期，单位为分钟 |
| metric | Metric | 推送指标信息 |
Metric结构：
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| metricName | String | yes | body | 推送指标名称，3-50 个字符，包含字母、数字、- 和 _ |
| dimensions | LIST[Dimension] | no | body | 维度信息 |
Dimension结构：
| 参数名称 | 类型 | 描述 |
|---|---|---|
| name | string | 维度名称，最多50个字符，包含字母、数字、- 和 _ |
Tag结构：
| 参数名称 | 类型 | 描述 |
|---|---|---|
| tagKey | string | 标签键名称 |
| tagValue | string | 标签值 |
示例
- 请求示例
GET /v1/alarm 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",
"status":"Paused",
"orderBy":"createDateTime",
"order":"desc",
"pageNo":1,
"pageSize":50
}- 响应示例
HTTP/1.1 200
Content-Type: application/json; charset=utf-8
{
"count": 1,
"alarmResult": [{
"id": "a-123",
"alarmName": "alarm1",
"status": "Paused",
"createDateTime": "2023-07-18 11:34:54 +0000 UTC",
"project": "default",
"logStoreName": "storeAlarm",
"alarmConfig": {
"alarmQuery": "select count(error) as errCount, error group by error",
"alarmTimeRange": 10,
"frequency": 10,
"metric": {
"metricName": "errCount",
"dimensions": [
"name": "error",
}]
}
},
"tags": [{
"tagKey": "key",
"tagValue": "value"
}]
}]
}