服务器告警概览
功能介绍
该 API 用于查询服务器告警概览
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/physicalservers/alarms/summary
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID 约束限制: 不涉及 取值范围: 账号的项目ID 默认取值: 不涉及 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 调用接口的认证方式分为Token,如果您使用的Token方式,此参数为必填,请填写Token的值 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
alarm_levels |
Array of AlarmLevel objects |
参数解释: 告警级别 约束限制: 不涉及 |
alarm_devices |
Array of AlarmDevice objects |
参数解释: 告警设备信息,包括设备类型及告警数量 约束限制: 不涉及 |
alarm_hosts |
Array of AlarmHost objects |
参数解释: 故障服务器Top10 约束限制: 不涉及 |
alarm_groups |
Array of AlarmGroup objects |
参数解释: 告警分组 约束限制: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
alarm_level |
Integer |
参数解释: 告警级别 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
alarm_number |
Integer |
参数解释: 告警数量 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
resource_name |
String |
参数解释: 资源名称 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
resource_id |
String |
参数解释: 资源id 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
alarm_infos |
Array of AlarmInfo objects |
参数解释: 告警信息 约束限制: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
alarm_device |
String |
参数解释: 告警设备 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
alarm_number |
Integer |
参数解释: 告警数量 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
alarm_duration |
String |
参数解释: 告警时间 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
label |
String |
参数解释: 标签 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
alarm_devices |
Array of AlarmDevice objects |
参数解释: 告警设备 约束限制: 不涉及 |
sns |
Array of strings |
参数解释: sn列表 约束限制: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
alarm_device |
String |
参数解释: 告警硬件 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
alarm_number |
Integer |
参数解释: 告警数量 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
error_msg |
String |
参数解释: 错误描述 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
error_msg |
String |
参数解释: 错误描述 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
状态码:429
参数 |
参数类型 |
描述 |
---|---|---|
- |
String |
- |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
error_msg |
String |
参数解释: 错误描述 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求示例
服务器告警概览
GET https://{endpoint}/v1/{project_id}/physicalservers/alarms/summary
响应示例
状态码:200
{ "alarm_levels" : [ { "alarm_level" : 3, "alarm_number" : 90 }, { "alarm_level" : 2, "alarm_number" : 104 }, { "alarm_level" : 1, "alarm_number" : 15 }, { "alarm_level" : 4, "alarm_number" : 60 } ], "alarm_devices" : [ { "alarm_device" : "memory_health", "alarm_number" : 163 }, { "alarm_device" : "cpu_health", "alarm_number" : 19 }, { "alarm_device" : "fan_health", "alarm_number" : 6 }, { "alarm_device" : "nic_health", "alarm_number" : 6 }, { "alarm_device" : "disk_health", "alarm_number" : 2 }, { "alarm_device" : "power_health", "alarm_number" : 0 }, { "alarm_device" : "other_health", "alarm_number" : 73 } ], "alarm_hosts" : [ { "resource_name" : "", "resource_id" : "01963d9c-dfca-72bc-8974-fae1f2c0700b", "alarm_infos" : [ { "alarm_device" : "alarm-eu43Rear", "alarm_duration" : 7161622903615878 } ] } ], "alarm_groups" : [ { "label" : "Unknown", "alarm_devices" : [ { "alarm_device" : "power_health", "alarm_number" : 0 }, { "alarm_device" : "nic_health", "alarm_number" : 6 }, { "alarm_device" : "memory_health", "alarm_number" : 163 }, { "alarm_device" : "fan_health", "alarm_number" : 6 }, { "alarm_device" : "disk_health", "alarm_number" : 2 }, { "alarm_device" : "cpu_health", "alarm_number" : 19 }, { "alarm_device" : "other_health", "alarm_number" : 73 } ], "sns" : [ "01963d9c-dfdf-7e66-a8cf-29ba55dcb4bd", "0197a5d0-0b9c-7564-a0ad-bf152d026a3c", "01963d9c-dfca-72bc-8974-fae1f2c0700b", "019661e2-5390-7aa5-91e8-5fc6841f6ed9", "01963d9c-dfd0-7a44-b42e-5270e52296b6" ] } ] }
状态码
状态码 |
描述 |
---|---|
200 |
- |
400 |
请求参数错误,请求失败 |
401 |
请求未鉴权 |
429 |
请求过载 |
500 |
服务端内部错误 |
错误码
请参见错误码。