更新时间:2024-10-21 GMT+08:00
分享

查询审计汇总信息

功能介绍

查询审计汇总信息

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/audit/summary/info

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

表2 Query参数

参数

是否必选

参数类型

描述

offset

String

偏移量

limit

String

查询记录数

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

project_id

String

项目ID

audit_duration

Long

审计总时长

total_sql

Long

语句总量

total_risk

Long

风险总量

today_sql

Long

今日语句

today_risk

Long

今日风险

today_session

Long

今日会话

update_time

Long

更新时间

data_list

Array of data_list objects

列表信息

total

Integer

总数

表5 data_list

参数

参数类型

描述

id

Long

ID

status

String

状态

  • 1: success
  • 2: failure

project_id

String

项目ID

instance_id

Long

实例ID

instance_name

String

实例名称

audit_duration

Long

审计时长

total_sql

Long

语句总量

total_risk

Long

风险总量

today_sql

Long

今日语句

today_risk

Long

今日风险

today_session

Long

今日会话

update_time

Long

更新时间

reserve1

String

保留字1

reserve2

String

保留字2

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。

表7 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

error_msg

String

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

状态码: 403

表8 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。

表9 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

error_msg

String

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

状态码: 500

表10 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。

表11 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

error_msg

String

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

请求示例

/v2/{project_id}/audit/summary/info

响应示例

状态码: 200

审计汇总信息

{
  "project_id" : "b9351f98c724428794ba7d105fa3558d",
  "audit_duration" : 99423,
  "total_sql" : 120267839,
  "total_risk" : 1597508,
  "today_sql" : 4354,
  "today_risk" : 4354,
  "today_session" : 4350,
  "update_time" : 1712570404644,
  "total" : 2,
  "data_list" : [ {
    "id" : 235049,
    "status" : "1",
    "reserve1" : null,
    "reserve2" : null,
    "project_id" : "b9351f98c724428794ba7d105fa3558d",
    "instance_id" : 5542,
    "instance_name" : "DBSS-mysql8-test",
    "audit_duration" : 99423,
    "total_sql" : 3537,
    "total_risk" : 380,
    "today_sql" : 0,
    "today_risk" : 0,
    "today_session" : 0,
    "update_time" : 1712570404093
  }, {
    "id" : 235050,
    "status" : "1",
    "reserve1" : null,
    "reserve2" : null,
    "project_id" : "b9351f98c724428794ba7d105fa3558d",
    "instance_id" : 5550,
    "instance_name" : "DBSS-Q1-test",
    "audit_duration" : 0,
    "total_sql" : 148,
    "total_risk" : 36,
    "today_sql" : 0,
    "today_risk" : 0,
    "today_session" : 0,
    "update_time" : 1712570404138
  } ]
}

状态码: 400

请求参数错误

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

状态码: 500

服务器内部错误

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

状态码

状态码

描述

200

审计汇总信息

400

请求参数错误

403

认证失败

500

服务器内部错误

错误码

请参见错误码

相关文档