获取设备告警列表
功能介绍
获取设备告警列表
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/alarm-manager/alarms
| 参数 | 是否必选 | 参数类型 | 描述 | 
|---|---|---|---|
| project_id | 是 | String | 项目ID。获取方法请参见获取项目ID | 
| 参数 | 是否必选 | 参数类型 | 描述 | 
|---|---|---|---|
| offset | 否 | Integer | 查询的起始位置,取值范围为非负整数,默认为0 | 
| limit | 否 | Integer | 每页显示的条目数量,取值范围1~100,默认为100 | 
| device_id | 否 | String | 设备ID | 
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 | 
|---|---|---|---|
| X-Auth-Token | 是 | String | 租户Token。获取方法请参见获取Token | 
响应参数
状态码: 200
| 参数 | 参数类型 | 描述 | 
|---|---|---|
| total | Integer | 满足条件的设备告警总数 | 
| data | Array of GetDeviceAlarmArrayObject objects | 设备告警实体列表 | 
| 参数 | 参数类型 | 描述 | 
|---|---|---|
| id | String | 设备告警记录ID | 
| name | String | 设备告警名称 | 
| alarm_id | Integer | 设备告警ID | 
| level | String | 设备告警等级,紧急告警(critical),严重告警(major),一般告警(minor) | 
| platform | String | 设备平台 | 
| impact | String | 设备告警的影响 | 
| detail | String | 设备告警详情内容 | 
| reason | String | 设备告警原因 | 
| deal_suggestion | String | 设备告警处理建议 | 
| create_time | Long | 创建时间(时间戳) | 
请求示例
无
响应示例
状态码: 200
获取设备告警列表成功
{
  "total" : 0,
  "data" : [ {
    "id" : "6b0e806f35c2470a825da1f1ab05caf5",
    "name" : "安装在设备HiLens_69上的技能test-unzip异常且无法恢复",
    "alarm_id" : 5,
    "level" : "critical",
    "platform" : "hilens",
    "impact" : "业务中断",
    "detail" : "多次尝试恢复技能均失败",
    "reason" : "技能10分钟内退出就会被认为是异常退出",
    "deal_suggestion" : "查看Log分析原因",
    "create_time" : 1636451227616
  } ]
}
 状态码
| 状态码 | 描述 | 
|---|---|
| 200 | 获取设备告警列表成功 | 
| 500 | 服务内部错误 | 
错误码
请参见错误码。
 
  