说明
当前接口使用前请使用资源池概况信息查询接口查询待对接的资源池信息,如资源池概况信息查询结果为"regionVersion":"v4.0",即可使用;如资源池概况信息结果为"regionVersion":"v3.0",请使用旧版接口示例。
接口功能介绍
查询告警历史。
接口约束
regionID(资源池)存在,searchKey(搜索关键词)满足参数说明范围。
URI
GET /v4/monitor/query-alert-history
请求参数
Query参数
参数 | 参数类型 | 是否必填 | 示例 | 说明 | 下级对象 |
---|---|---|---|---|---|
regionID | String | 是 | 81f7728662dd11ec810800155d307d5b | ctyun资源池ID | |
azName | String | 是 | 可用区1 | 填写可用区名称或者 default。您可以调用资源池可用区查询获取资源池信息,查询结果中zoneList内返回可用区名称,若查询结果中zoneList为空,即为单可用区,本字段填写default。 | |
searchKey | String | 否 | contactGroupName | 本参数表示搜索关键词。取值范围: contactGroupName:联系人组名,模糊查询。 triggerID:监控平台规则ID,精确查询。 instanceName:实例名,模糊查询。 name:告警规则名称,模糊查询。 根据以上范围取值。 |
|
searchValue | String | 否 | test | 配合searchKey使用,对应的值 | |
status | Integer | 否 | 0 | 本参数表示状态。取值范围: 0:正常。 1:告警。 根据以上范围取值。 |
|
service | String | 否 | ecs | 本参数表示告警服务。取值范围: ecs:云主机。 evs:云硬盘。 pms:物理机。 ... 详见“告警规则:获取告警服务列表”接口返回。 |
|
page | Integer | 否 | 1 | 页码,默认为1 | |
pageSize | Integer | 否 | 10 | 页大小,默认为20 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败),默认值:800 | 800 | |
errorCode | String | 失败时的错误代码,参见公共错误码说明 | ||
message | String | 失败时的错误描述,一般为英文描述 | Success | |
msgDesc | String | 失败时的错误描述,一般为中文描述 | 成功 | |
returnObj | Object | 返回对象 | returnObj |
表returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
issues | Array of Objects | 告警事件列表 | issue | |
totalCount | Integer | 记录总数 | 1 | |
page | Integer | 页码 | 1 | |
pageSize | Integer | 页大小 | 20 |
表issue
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
triggerID | String | 监控平台规则ID | 634fac0339fa5e04c4a33648 | |
status | Integer | 本参数表示状态。取值范围:0:正常。1:告警。根据以上范围取值。 | 1 | |
lastChange | String | 更新时间 | 2022-10-19T07:53:36Z | |
name | String | 规则名称 | 告警规则lyc123 | |
service | String | 服务 | ecs | |
dimension | String | 维度 | ecs | |
level | Integer | 本参数表示报警级别。取值范围:1:灾难告警。2:严重告警。3:一般告警。4:警告告警。根据以上范围取值。 | 1 | |
deviceUUID | String | 设备唯一ID | 000f0322-1f4d-8cc8-bb2e-1c30fb751aa5 | |
instanceName | String | 实例名 | 000f0322-1f4d-8cc8-bb2e-1c30fb751aa5 | |
instanceID | String | 实例ID | 000f0322-1f4d-8cc8-bb2e-1c30fb751aa5 | |
clock | String | 触发时间 | 2022-10-19T07:51:32Z | |
notifyType | Array of String | 告警接收策略 | ["email"] |
请求示例
GET /v4/monitor/query-alert-history?regionID=81f7728662dd11ec810800155d307d5b&searchKey=name&searchValue=告警规则&service=ecs&status=1&page=1&pageSize=1
响应示例
{
"statusCode": 800,
"returnObj": {
"issues": [
{
"triggerID": "634fac0339fa5e04c4a33648",
"status": 0,
"desc":
"test",
"lastChange": "2022-10-19T07:53:36Z",
"name": "告警规则lyc123",
"service": "ecs",
"dimension": "ecs",
"deviceUUID": "000f0322-1f4d-8cc8-bb2e-1c30fb751aa5",
"instanceName": "000f0322-1f4d-8cc8-bb2e-1c30fb751aa5",
"instanceID": "000f0322-1f4d-8cc8-bb2e-1c30fb751aa5",
"level": 1,
"clock": "2022-10-19T07:51:32Z",
"notifyType":[]
}
],
"totalCount": 21,
"page": 1,
"pageSize": 1
},
"errorCode": "",
"message": "Success",
"msgDesc":"成功"
}