告警事件
告警事件:导出告警历史
接口功能介绍
导出指定条件的告警历史,导出格式为csv文件。
接口约束
regionID(资源池)存在,searchKey(搜索关键词)满足参数说明范围。
URI
POST /v4/monitor/export-alert-history
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | ctyun资源池ID | 81f7728662dd11ec810800155d307d5b | |
status | 是 | Integer | 本参数表示状态。取值范围:0:正在告警。1:告警历史。根据以上范围取值。 | 0 | |
resourceGroupID | 否 | String | 资源分组ID。 | 3c9362cc-bd95-55c6-8b5f-66b4b712dcfb | |
searchKey | 否 | String | 本参数表示搜索关键词。取值范围:alarmRuleID:告警规则ID,精确查询。name:告警规则名称,模糊查询。根据以上范围取值。 | name | |
searchValue | 否 | String | 配合searchKey使用,对应的值 | test | |
service | 否 | Array of Strings | 本参数表示告警服务。取值范围:ecs:云主机。evs:云硬盘。pms:物理机。...详见“告警规则:获取告警服务列表”接口返回。 | ['ecs', 'evs'] | |
startTime | 否 | Integer | 查询状态为告警历史(参数status=1)时的起始时间戳, 默认值:24小时前时间戳,startTime和endTime需同时传或同时不传 | 1667815639 | |
endTime | 否 | Integer | 查询状态为告警历史(参数status=1)时的结束时间戳,默认值:当前时间戳, 配合startTime一起使用 | 1667817639 |
响应参数
根据请求参数导出监控数据为csv文件。
云产品监控的文件内容有:
资源类型, 告警资源, 发生时间, 持续时间, 结束时间,规则名称,通知方式, 通知对象
事件监控的文件内容有:
资源类型, 发生时间, 持续时间, 结束时间,规则名称,通知方式, 通知对象
自定义监控的文件内容有:
资源类型, 发生时间, 持续时间, 结束时间,规则名称,通知方式, 通知对象
注意:对于以上文件内容, 当查询状态为正在告警(status=0)时:无结束时间。
每条数据,按照上面内容横向排列,无数据则为空; 多条数据以栏(多个行)为单位竖向排列。
请求失败,返回参数参考查询告警历史接口。
请求示例
请求url
/v4/monitor/export-alert-history
请求头header
无
请求体body
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"status":1,
"service":[
"evs",
"ecs"
],
"searchKey": "alarmRuleID",
"searchValue": "41f64827f25f468595ffa3a5deb5d666",
"endTime":1698982651,
"startTime":1698896251
}
响应示例
csv文件内容:
资源类型,告警资源,发生时间,持续时间,结束时间,规则名称,通知方式,通知对象
站点监控,point_id:1/task_id:3250e602-a40c-4269-8c74-2e2831dbfea6/instancename:tcp,2024-02-23 09:07:49,14分钟11秒,2024-02-23 09:22:00,AA,,
云主机,uuid:0ea61f1a-3ad1-c0f8-c204-b74098c78264/instancename:ecm-a79c,2024-02-23 08:59:27,52分钟33秒,2024-02-26 09:52:00,告警模板导入-规则5云主机9,邮件,AA
云主机,uuid:0ea61f1a-3ad1-c0f8-c204-b74098c78264/instancename:ecm-a79c,2024-02-23 08:59:27,52分钟33秒,2024-02-26 09:52:00,告警模板导入-规则5云主机9,邮件,AA
云主机,uuid:0ea61f1a-3ad1-c0f8-c204-b74098c78264/instancename:ecm-a79c,2024-02-23 08:59:27,52分钟33秒,2024-02-26 09:52:00,告警模板导入-规则5云主机9,邮件,AA
云主机,uuid:0ea61f1a-3ad1-c0f8-c204-b74098c78264/instancename:ecm-2246,2024-02-23 08:59:27,52分钟33秒,2024-02-26 09:52:00,告警模板导入-规则5云主机9,邮件,AA
云主机,uuid:0ea61f1a-3ad1-c0f8-c204-b74098c78264/instancename:ecm-a79c,2024-02-23 08:59:27,52分钟33秒,2024-02-26 09:52:00,告警模板导入-规则5云主机9,邮件,AA
云主机,uuid:0ea61f1a-3ad1-c0f8-c204-b74098c78264/instancename:ecm-a79c,2024-02-23 08:59:27,52分钟33秒,2024-02-26 09:52:00,告警模板导入-规则5云主机9,邮件,AA
云主机,uuid:0ea61f1a-3ad1-c0f8-c204-b74098c78264/instancename:ecm-a79c,2024-02-23 08:59:27,52分钟33秒,2024-02-26 09:52:00,告警模板导入-规则5云主机9,邮件,AA
云主机,uuid:0ea61f1a-3ad1-c0f8-c204-b74098c78264/instancename:ecm-a79c,2024-02-23 08:59:27,52分钟33秒,2024-02-26 09:52:00,告警模板导入-规则5云主机9,邮件,AA
云主机,uuid:0ea61f1a-3ad1-c0f8-c204-b74098c78264/instancename:ecm-a79c,2024-02-23 08:59:27,52分钟33秒,2024-02-26 09:52:00,告警模板导入-规则5云主机9,邮件,AA
状态码
状态码 | 描述 |
---|---|
200 | 请求成功 |
错误码
errorCode | 描述 |
---|---|
Monitor.AlertHistory.ExportError | 告警历史导出失败 |
其他 | 参见公共错误码说明 |