Help Center/ Database Security Service/ API Reference/ API/ Dashboard/ Querying Audit Summary Information

Updated on 2025-09-10 GMT+08:00

View PDF

Querying Audit Summary Information

Function

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Specifies the project ID. You can obtain the value by calling the IAM API for querying the project list of a specified IAM user. Constraints N/A Range: The value is subject to the return value of the IAM service interface. The value contains 32 to 64 characters. Default Value: N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	String	Definition: Pagination offset. The query starts after the offset of the first data record. Restrictions: Only integers greater than or equal to 0 are supported. Range: Greater than or equal to 0 Default value: The default value is 0.
limit	No	String	Definition: Number of records queried on each page. Restrictions: Only integers greater than 0 are supported. Range: Greater than 0 and less than or equal to 10000 Default value: The default value is 100.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition: User token. You can obtain the token by calling the IAM API used to query the user token. The token is the value of X-Subject-Token in the response header. Constraints N/A Value range: The value is subject to the user token query interface of the IAM service. Default Value: N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
project_id	String	Project ID
audit_duration	Long	Audit duration
total_sql	Long	Total statements
total_risk	Long	Total risk
today_sql	Long	Today's statements
today_risk	Long	Today's risk
today_session	Long	Today's session
update_time	Long	Update time.
data_list	Array of data_list objects	Version list.
total	Integer	Total number of license files

**Table 5** data_list
Parameter	Type	Description
id	Long	ID
status	String	Alarm status. 1: success 2: failure
project_id	String	Project ID
instance_id	Long	Instance ID
instance_name	String	Instance name
audit_duration	Long	Audit duration
total_sql	Long	Total statements
total_risk	Long	Total risk
today_sql	Long	Today's statements
today_risk	Long	Today's risk
today_session	Long	Today's session
update_time	Long	Update time.
reserve1	String	Reserved word 1
reserve2	String	Reserved word 2

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
details	Array of DbssErrorDetail objects	PDP5 authentication exception information
encoded_authorization_message	String	PDP5 authentication exception information
error_code	String	Error Codes
error_msg	String	Error message.

**Table 7** DbssErrorDetail
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	PDP5 error information

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
details	Array of DbssErrorDetail objects	PDP5 authentication exception information
encoded_authorization_message	String	PDP5 authentication exception information
error_code	String	Error Codes
error_msg	String	Error message.

**Table 9** DbssErrorDetail
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	PDP5 error information

Status code: 500

**Table 10** Response body parameters
Parameter	Type	Description
details	Array of DbssErrorDetail objects	PDP5 authentication exception information
encoded_authorization_message	String	PDP5 authentication exception information
error_code	String	Error Codes
error_msg	String	Error message.

**Table 11** DbssErrorDetail
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	PDP5 error information

Example Requests

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

Example Responses

Status code: 200

Audit summary information

{
  "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
  } ]
}