Skip to main content

SQL审核报告列表

接口描述

  • 通过该接口可获取审核报告列表数据

请求Url

  • http://{host}/bbm/v1/audit/reports
  • host为系统访问的地址

请求方式

  • GET

Header 请求头

参数名必选类型说明示例值及参考API
Authorizationstring签名描述Bearer + 登录token

请求参数

参数名必选类型说明示例值及参考API
pageint用于分页查询,查询第N页数据 默认1示例值 1
sizeint用于分页查询,每页数据条数,-1时不分页示例值 10
sortstring根据sort值对应的字段排序,倒序时在字段前加-号,多个排序字段使用,号连接,可通过id或者start_time倒序获取最新审核报告示例值: -id -start_time
querystring精准过滤条件,使用示例:字段1:条件1, 字段2:条件2,字段3:条件3示例值: query=name:abc,sla:A
searchstring模糊过滤条件,使用示例:字段1:条件1, 字段2:条件2,字段3:条件3示例值: search=name:abc,sla:A
db_idInt通过纳管数据库ID 筛选审核报告示例值:db_id=100
system_codestring通过纳管数据库唯一标识 筛选审核报告示例值:system_code=codeA11
from_timeint筛选审核报告开始时间大于等于传入时间(UNIX时间戳单位秒)示例值:from_time=1660214400
to_timeint筛选审核报告开始时间小于传入时间(UNIX时间戳单位秒)示例值:to_time=1660214400
from_scorefloat筛选审核报告开始时间大于等于传入时间(UNIX时间戳单位秒)示例值:from_score=20
to_scorefloat筛选审核报告开始时间小于传入时间(UNIX时间戳单位秒)示例值:to_score=100
statusstring通过审核报告状态筛选 doing 为执行中 done 为执行完成示例值:status=done
task_typestring通过审核报告类型筛选 dynamic 为线上审核 static 为线下审核示例值:task_type=dynamic
task_idint通过审核任务ID查询审核报告示例值:task_id=100

请求示例

http://{host}/bbm/v1/audit/reports?db_id=794&system_code=1ae832bc-7a94-4d66-bcc7-bf7c04e88023&from_time=1650214400&to_time=1670214700&from_score=10&to_score=100&sort=-id&size=10&page=1&status=done&task_type=dynamic

返回参数说明

参数名类型说明示例值及参考API
idInt审核报告id 可于报告导出或者风险sql等查询过滤示例:6422
namestring报告名称,命名方式为 对应审核任务名称+当前执行次数示例:业务系统1-uat-20210808-1
task_idint对应审核任务id
task_namestring对应审核任务名称
task_typestring任务类型 选择范围 :dynamic static 线上审核:dynamic 线下审核 static示例:dynamic
db_idint纳管数据库ID示例 333 参考api: 查询一个或者多个纳管资源
db_namestring纳管数据库名称
db_typestring纳管数据库类型
schemasstring审核的schema
errorstring审核错误时记录的错误信息
statusstring报告状态 取值范围 doing(生成中) done(生成完成)
start_timeint审核任务开始执行时间示例 1628352002
end_timeint审核任务结束执行时间示例 1628352002
from_timeint审核取样开始时间示例 1627747201000
to_timeint审核取样结束时间示例 1628352003000
scorefloat报告总分示例:85.51
sql_scorefloatSQL语句审核总体评分示例:85.51
object_scorefloat数据库对象审核总体评分示例:85.51
template_idint审核规则模板ID示例:85.51

返回示例

[
{
"id": 63152,
"name": "SYSAUD-rac_db-2",
"task_id": 678,
"task_name": "SYSAUD-rac_db",
"db_id": 449,
"db_name": "rac_db",
"db_type": "oracle",
"schemas": "AUDITPOC,MONITOR,SCOTT",
"error": "",
"task_type": "dynamic",
"start_time": 1628352002,
"end_time": 1628352192,
"from_time": 1627747201000,
"to_time": 1628352003000,
"score": 85.51,
"object_score": 86.59,
"sql_score": 84.35,
"status": "done",
"template_id": 19
}
]

Curl示例

curl --request GET \
--url 'http://{host}/bbm/v1/audit/reports?db_id=794&system_code=1ae832bc-7a94-4d66-bcc7-bf7c04e88023&from_time=1650214400&to_time=1670214700&from_score=10&to_score=100&sort=-id&size=10&page=1&status=done&task_type=dynamic' \
--header 'Authorization: Bearer ********'