告警管理-查询告警总览信息 - ShowSecOpsAlarmOverview
功能介绍
功能介绍:告警管理-查询告警总览信息
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v2/{project_id}/sec-ops/alarms/overview
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。可参考获取项目ID获取。 约束限制: 不涉及 取值范围: 以IAM服务接口返回值为准,字符长度32-32,满足正则匹配"^[a-z0-9]{32}$" 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: IAM服务查询用户Token接口为准 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| turn_on_num | Integer | 参数解释: 开启告警数量 取值范围: 不涉及 |
| turn_off_num | Integer | 参数解释: 关闭告警数量 取值范围: 不涉及 |
| total_alarm | AlarmLevelInfo object | 参数解释: 告警总数 取值范围: 不涉及 |
| untreated_alarm | AlarmLevelInfo object | 参数解释: 未处置告警数 取值范围: 不涉及 |
| alarm_source_info | AlarmSourceInfo object | 参数解释: 告警来源信息 取值范围: 不涉及 |
| api_num | Integer | 参数解释: API数量 取值范围: 不涉及 |
| cbh_num | Integer | 参数解释: CBH数量 取值范围: 不涉及 |
| database_encrypt_num | Integer | 参数解释: 数据库加密数量 取值范围: 不涉及 |
| database_op_num | Integer | 参数解释: 数据库操作数量 取值范围: 不涉及 |
| dbss_num | Integer | 参数解释: DBSS数量 取值范围: 不涉及 |
| fatal_num | Integer | 参数解释: 致命数量 取值范围: 不涉及 |
| high_risk_num | Integer | 参数解释: 高风险数量 取值范围: 不涉及 |
| low_risk_num | Integer | 参数解释: 低风险数量 取值范围: 不涉及 |
| middle_risk_num | Integer | 参数解释: 中风险数量 取值范围: 不涉及 |
| notice_num | Integer | 参数解释: 提示数量 取值范围: 不涉及 |
请求示例
无
响应示例
状态码:200
{
"turn_on_num" : 18,
"turn_off_num" : 4,
"total_alarm" : {
"fatal_num" : 3,
"high_risk_num" : 3,
"middle_risk_num" : 5,
"low_risk_num" : 8,
"notice_num" : 10
},
"untreated_alarm" : {
"fatal_num" : 3,
"high_risk_num" : 3,
"middle_risk_num" : 5,
"low_risk_num" : 8,
"notice_num" : 10
},
"alarm_source_info" : {
"dbss_num" : 10,
"cbh_num" : 10,
"database_encrypt_num" : 10,
"database_op_num" : 10,
"api_num" : 10
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询成功 |
错误码
请参见错误码。