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

Generating a Report Immediately

Function

Generate a report immediately.

URI

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

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

db_ids

No

String

Database ID list. Use commas (,) to separate multiple IDs.

end_date

No

String

End date.

end_time

Yes

String

End time

start_date

No

String

Start Date

start_time

Yes

String

Start time

template_id

Yes

String

Template ID

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

result

String

Operation Result

  • success: Request succeeded

  • failed: failed

Status code: 400

Table 5 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 6 DbssErrorDetail

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

PDP5 error information

Status code: 401

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: 403

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: 500

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

Example Requests

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

{
  "template_id" : "t8g7LJgBTpKZyZbbeTgS",
  "start_time" : "2025-08-20 16:00:00",
  "end_time" : "2025-08-21 07:03:31",
  "db_ids" : null
}

Example Responses

Status code: 200

Report ID

{
  "result" : "success"
}

Status Codes

Status Code

Description

200

Report ID

400

Invalid request parameter.

401

Authorization failed.

403

Unauthorized

500

Server error.

Error Codes

See Error Codes.