告警事件：查询告警历史详情
更新时间 2024-09-25 16:20:54
最近更新时间: 2024-09-25 16:20:54
告警事件
告警事件：查询告警历史详情
接口功能介绍
查询单条告警历史详情。
接口约束
无
URI
GET /v4/monitor/query-alert-history-info
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| issueID | 是 | String | 告警历史ID | 65b08a5848091836a6f2afd8 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| error | String | 错误码，请求成功时，不返回该字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回对象 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| status | Integer | 本参数表示告警状态。取值范围：0：正在告警。1：告警历史。根据以上范围取值。 | 1 | |
| alarmType | String | 本参数表示告警类型。取值范围：series：指标类型。event：事件类型。根据以上范围取值。 | series | |
| infoID | String | 告警详情ID | 65b08a5848091836a6f2afd9 | |
| service | String | 本参数表示服务。取值范围：ecs：云主机。evs：云硬盘。pms：物理机。...详见“告警规则：获取告警服务列表”接口返回。 | ecs | |
| dimension | String | 本参数表示告警维度。取值范围：ecs：云主机。disk：磁盘。pms：物理机。...详见“告警规则：获取告警服务维度关系”接口返回。 | ecs | |
| resource | Array of Objects | 告警资源 | resource | |
| condition | Object | 告警规则 | condition | |
| count | Integer | 资源告警出现次数 | 2 | |
| value | Double | 告警数据值 | 0.27116666 | |
| createTime | Integer | 触发时间的时间戳 | 1698823059 | |
| updateTime | Integer | 结束时间的时间戳。 | 1698823059 |
表 resource
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| name | String | 监控指标 | cpu_util | |
| value | String | 监控指标中文描述 | cpu使用率 |
表 condition
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| metric | String | 监控指标 | cpu_util | |
| metricCnName | String | 监控指标中文描述 | cpu使用率 | |
| fun | String | 本参数表示告警采用算法。取值范围：last：原始值算法。avg：平均值算法。max：最大值算法。min：最小值算法。根据以上范围取值。 | avg | |
| operator | String | 本参数表示比较符。默认值le。取值范围：eq：等于。gt：大于。ge：大于等于。lt：小于。le：小于等于。根据以上范围取值。 | eq | |
| period | String | 本参数表示算法统计周期。默认值5m。参数fun为last时不可传。参数fun为avg、max、min均需填此参数。本参数格式为“数字+单位”。单位取值范围：m：分钟。h：小时。d：天。根据以上范围取值。 | 5m | |
| threshold | String | 告警阈值，可以是整数、小数或百分数格式字符串 | 0 | |
| unit | String | 单位。 | % |
请求示例
请求url
/v4/monitor/query-alert-history-info?issueID=65b08a5848091836a6f2afd8
请求头header
无
请求体body
无
响应示例
{
"statusCode":800,
"returnObj":[
{
"resource":[
{
"name":"vpn_gateway_id",
"value":"13f47d3b-8e18-56db-a8d7-75be184964f5"
}
],
"infoID":"65b08a5848091836a6f2afd9",
"service":"ipsec_vpn",
"dimension":"ipsec_vpn_gw_stats",
"condition":{
"metric":"vpn_gw_in_bps",
"metricCnName":"VPN网关入方向流量速率",
"period":"5m",
"fun":"avg",
"operator":"eq",
"threshold":"0",
"unit":""
},
"createTime":1706068568,
"updateTime":1706079352,
"value":0,
"status":0,
"alarmType": "series",
"count":0
}
],
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| 其他 | 参见公共错误码说明 |
