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

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. 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

Range

Determined by the value of the IAM API used for querying user tokens.

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

  • 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

  • AUDIT_REPORT_DAY: by day

  • AUDIT_REPORT_WEEK: by week

  • AUDIT_REPORT_MONTH: by month

  • AUDIT_REPORT_YEAR: by 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

OK

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

Status Codes

Status Code

Description

200

OK

400

Invalid request parameter.

401

Authorization failed.

403

Unauthorized

500

Server error.

Error Codes

See Error Codes.