导出告警数据¶
通过以下步骤导出告警数据
根据应用key、时间查询最多31天历史告警信息
GET /rest/api/v1/alert/historymonth
请求参数¶
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| appKey | string | 必须 | 应用ID |
| startTime | string | 必须 | 开始时间 示例:2022-6-6 |
| endTime | string | 必须 | 结束时间 示例:2022-6-6 |
示例¶
请求cURl:
curl --location --request GET 'https://caweb.aiops.com/api/alert/rest/api/v1/alert/historymonth?appKey=ef167b3153804cadbe8926f3ee2164b4&startTime=2022-6-6&endTime=2022-6-21' \ --user 'email@example.com:<access_token>' \ --header 'Accept: application/json'
提示
• 示例邮箱应替换为用户注册所用邮箱
• access_token应替换为您手动获取的access_token
• 如需对请求进行加密处理:请将
--user 'email@example.com:access_token' \
--header 'Accept: application/json'
替换为:
--header 'Authorization: Basic Z2FveWluaW5nOTk5NUAxNjMuY29tOmt1WWl6bmljZ3oxN0JBVjk=' \
--header 'Content-Type: application/json'
• 替换步骤请参考加密步骤
返回参数¶
| 参数 | 类型 | 说明 |
|---|---|---|
| result | string | 返回结果:success成功 、false 失败 |
| message | string | 返回消息 |
| data | 返回数据集 | |
| totalCount | int | 数据量 |
| code | int | 响应码 |
data结果集¶
| 参数 | 类型 | 说明 |
|---|---|---|
| ALARM_NAME | string | 告警标题 |
| STATUS | string | 告警状态(ACTIVE 待处理/CLOSED 关闭/ACK认领) |
| PRIORITY | int | 告警级别(1提醒/2警告/3严重) |
| ALARM_CONTENT | string | 告警内容 |
| CREATE_TIME | long | 告警创建时间 |
| UPDATE_TIME | long | 告警更新时间 |
| CLOSE_TIME | long | 告警关闭时间 |
| SOURCE | string | 告警来源 |
| APP | string | 应用ID |
| ACK_TIME | long | 认领时间 |
| ACK_USER | string | 认领人ID |
| CLOSE_USER | string | 关闭人ID |
| CLOSE_COMMENTS | string | 关闭注释 |
| HOST | string | 主机 |
| SERVICE | string | 服务 |
| APPLICATION | string | 应用 |
| DETAILS | string | 详情 |
| ID | int | 告警编号 |
| ACK_USER_NAME | string | 认领人名称 |
| TAG | string | 自定义标签 |
| LABELS | 对象数组 | 针对prometheus自定义labels的内容 |
| ENTITY_NAME | string | 告警对象 |
| jira | string | 是否提交了JIRA(false 否;true 是) |
响应报文¶
{
"result":"success",
"message":null,
"data":{
"alarms":[
{
"APP":"c620c3c738084154809179627881dc23",
"ID": 74507500,
"CLOSE_COMMENTS":"超时自动关闭",
"DETAILS":"",
"APPLICATION":"",
"ACK_TIME":null,
"ALARM_CONTENT":"CNBE44-F06-M-7205-WAC02CNBE44-F06-M-AP02-59DC",
"PRIORITY":3,
"ACK_USER":null,
"ACK_USER_NAME": "睿小象",
"UPDATE_TIME":1635302970506,
"CONTEXTS":"",
"STATUS":"CLOSED",
"HOST":null,
"SOURCE":"zabbix",
"CLOSE_TIME":1635304200040,
"SERVICE":"CNBE44-F06-M-AP02-59DC:Channel Busy Rate",
"CREATE_TIME":1635302968395,
"CLOSE_USER":"System",
"ALARM_NAME":"High Channel Utilization 123",
"TAG": "",
"LABELS": [
{
"name": "账号ID",
"value": "",
"key": "$['Message']['account']"
},
{
"name": "通知类型",
"value": "",
"key": "$['Message']['detail-type']"
},
{
"name": "案例 ID",
"value": "",
"key": "$['Message']['detail']['display-id']"
},
{
"name": "变更类型",
"value": "",
"key": "$['Message']['detail']['event-name']"
}
],
"ENTITY_NAME": "手动触发",
"jira": "false"
}
]
},
"totalCount":77,
"code":200
}
错误响应码¶
| 错误码 | 说明 |
|---|---|
| 200 | 成功 |
| 400 | 失败,传入的参数有问题 |
| 401 | 认证失败,用户名密码错误 |