Querying a Report

Function

Query reports

URI

POST /v1/{project_id}/audit/{instance_id}/reports/list

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition 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 determined by the value of the IAM API. The value contains 32 to 64 characters. Default Value N/A
instance_id	Yes	String	Definition Instance ID. The value can be obtained from the ID field of the API for querying the instance list. Constraints N/A Range The value is determined by the value of the API for querying the instance list. The value contains 32 to 64 characters. Default Value N/A

Request Parameters

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

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
name	No	String	Report name.
page	Yes	Integer	Current page
size	Yes	Integer	Number of records on each page.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
reports	Array of ReportInfo objects	Report object list
total	Long	Specifies the total number of records.

**Table 5** ReportInfo
Parameter	Type	Description
report	ReportBean object	Report Object

**Table 6** ReportBean
Parameter	Type	Description
db_ids	String	The database record ID.
db_names	String	Database name
end_time	String	End time
finish_time	String	Completion time
format	String	Format. The value can be: pdf: PDF file zip: ZIP file
id	String	Report ID
name	String	Report name.
percentum	Integer	Progress
start_time	String	Start time
template_type	String	Report type. PDF ZIP
type	String	Period. The options are as follows: AUDIT_REPORT_DAY: day AUDIT_REPORT_WEEK: week AUDIT_REPORT_MONTH: month AUDIT_REPORT_YEAR: year AUDIT_REPORT_REAL_TIME: immediately
url	String	URL

Status code: 400

**Table 7** 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 8** DbssErrorDetail
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	PDP5 error information

Status code: 401

**Table 9** 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 10** DbssErrorDetail
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	PDP5 error information

Status code: 403

**Table 11** 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 12** DbssErrorDetail
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	PDP5 error information

Status code: 500

**Table 13** 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 14** DbssErrorDetail
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	PDP5 error information

Example Requests

/v1/{project_id}/audit/{instance_id}/reports/list

{
  "page" : 1,
  "size" : 1
}

Example Responses

Status code: 200

{
  "total" : 1,
  "reports" : [ {
    "report" : {
      "id" : "ocdwy5gBPj4d6CRt90sh",
      "name" : "Database Security General Report",
      "type" : "AUDIT_REPORT_REAL_TIME",
      "format" : "pdf",
      "percentum" : 100,
      "url" : "/results/ocdwy5gBPj4d6CRt90sh/download-report",
      "finish_time" : "2025-08-21 07:03:56",
      "db_ids" : "",
      "template_type" : "COMPREHENSIVE",
      "start_time" : "2025-08-20 16:00:00",
      "end_time" : "2025-08-21 07:03:31",
      "db_names" : ""
    }
  } ]
}