文档首页/ 数据库安全服务 DBSS/ API参考/ API/ 数据分析/ 查询审计告警信息
更新时间：2024-10-24 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询审计告警信息

功能介绍

查询审计告警信息

调用方法

请参见如何调用API。

URI

POST /v1/{project_id}/{instance_id}/audit/alarm-log

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

instance_id

是

String

实例ID。可在查询实例列表接口的ID字段获取。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。 通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

time

是

time object

时间

risk

否

String

风险级别

  • LOW
  • MEDIUM
  • HIGH

type

否

String

告警类型

  • RISK_RULE: 风险规则
  • RISK_CPU: CPU超限
  • RISK_MEMORY: 内存超限
  • RISK_DISK: 磁盘超限
  • RISK_DISK_CAPACITY: 磁盘容量不足六个月
  • RISK_BACKUP: 备份失败
  • AUDIT_QPS_OVERFLOW: 流量超限入库延迟告警
  • RISK_AGENT: Agent异常
  • AUDIT_BACKUP_FAILED: 实例备份失败(运维侧)

status

否

String

告警确认状态

  • DONE: 已确认
  • UNDO: 未确认

page

否

Integer

页码

size

否

Integer

每页条数
表4 time

参数

是否必选

参数类型

描述

time_range

否

String

时间范围。和start_time，end_time不能同时使用，同时传该参数优先级更高。枚举值

HALF_HOUR, HOUR, THREE_HOUR, TWELVE_HOUR, DAY, WEEK, MONTH;

start_time

否

String

开始时间，必须和end_time成对出现。格式必须为yyyy-MM-dd HH:mm:ss。UTC时间

end_time

否

String

结束时间，必须和start_time成对出现。格式必须为yyyy-MM-dd HH:mm:ss。UTC时间

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

total_num

Integer

总条数

alarm_log

Array of alarm_log objects

告警列表
表6 alarm_log

参数

参数类型

描述

id

String

告警ID

alarmLife

String

告警状态

  • ON
  • OFF

sendEmail

Boolean

是否发送邮件

alarm_time

String

告警发生时间

alarm_type

String

告警类型

  • RISK_RULE: 风险规则
  • RISK_CPU: CPU超限
  • RISK_MEMORY: 内存超限
  • RISK_DISK: 磁盘超限
  • RISK_DISK_CAPACITY: 磁盘容量不足六个月
  • RISK_BACKUP: 备份失败
  • AUDIT_QPS_OVERFLOW: 流量超限入库延迟告警
  • RISK_AGENT: Agent异常
  • AUDIT_BACKUP_FAILED: 实例备份失败(运维侧)

alarm_fix_time

String

告警恢复时间

alarm_status

String

告警确认状态

  • DONE: 已确认
  • UNDO: 未确认

alarm_risk

String

告警风险等级

  • LOW
  • MEDIUM
  • HIGH

alarm_description

String

告警描述信息

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。
表8 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

error_msg

String

错误请求返回的错误信息。

状态码： 403

表9 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。
表10 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

error_msg

String

错误请求返回的错误信息。

状态码： 500

表11 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。
表12 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

error_msg

String

错误请求返回的错误信息。

请求示例

/v1/{project_id}/{instance_id}/audit/alarm-log

{
  "time" : {
    "time_range" : "DAY",
    "start_time" : null,
    "end_time" : null
  },
  "risk" : null,
  "type" : null,
  "status" : null,
  "page" : 1,
  "size" : 100
}

响应示例

状态码： 200

成功

{
  "total_num" : 3,
  "alarm_log" : [ {
    "id" : "99AJFI8BZEbGVdGbOczC",
    "alarmLife" : "ON",
    "sendEmail" : true,
    "alarm_time" : "2024-04-25 06:55:00",
    "alarm_type" : "RISK_DISK",
    "alarm_fix_time" : null,
    "alarm_status" : "UNDO",
    "alarm_description" : "DISK USAGE 5%",
    "alarm_risk" : "HIGH"
  }, {
    "id" : "9tAJFI8BZEbGVdGbOcy4",
    "alarmLife" : "ON",
    "sendEmail" : true,
    "alarm_time" : "2024-04-25 06:55:00",
    "alarm_type" : "RISK_MEMORY",
    "alarm_fix_time" : null,
    "alarm_status" : "UNDO",
    "alarm_description" : "MEMORY USAGE 53.54%",
    "alarm_risk" : "HIGH"
  }, {
    "id" : "9dAJFI8BZEbGVdGbOcyq",
    "alarmLife" : "ON",
    "sendEmail" : true,
    "alarm_time" : "2024-04-25 06:55:00",
    "alarm_type" : "RISK_CPU",
    "alarm_fix_time" : null,
    "alarm_status" : "UNDO",
    "alarm_description" : "CPU USAGE 1.0%",
    "alarm_risk" : "HIGH"
  } ]
}

状态码： 400

请求参数错误

{
  "error" : {
    "error_code" : "DBSS.XXXX",
    "error_msg" : "XXX"
  }
}

状态码： 500

服务器内部错误

{
  "error" : {
    "error_code" : "DBSS.XXXX",
    "error_msg" : "XXX"
  }
}

状态码

状态码

描述

200

成功

400

请求参数错误

403

认证失败

500

服务器内部错误

错误码

请参见错误码。

父主题： 数据分析