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

Obtaining a Report Template

Function

Obtaining a Report Template

URI

GET /v2/{project_id}/audit/{instance_id}/reports/templates

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

** Parameter description**:

Specifies the project ID. You can obtain the value by calling the IAM API for querying the project list of a specified IAM user.

** Restrictions**:

N/A

** Value 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

instance_id

Yes

String

Definition:

Instance ID. The value can be obtained from the ID field of the API for querying the instance list.

** Restrictions**:

N/A

Range:

The value is subject to 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. (The token is the value of X-Subject-Token in the response header.)

** Restrictions**:

N/A

Range:

Used by the IAM service to query the user token.

** Default value**:

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

os_type

String

OS type

templates

Array of TemplateInfo objects

Obtaining the Template List

Table 4 TemplateInfo

Parameter

Type

Description

template

TemplateBean object

Template object

Table 5 TemplateBean

Parameter

Type

Description

db_ids

String

Database ID.

db_names

String

Database name

desc

String

Description

frequency

String

Period

group

String

Type

  • COMPREHENSIVE: comprehensive report

  • COMPLIANCE: compliance report

  • DB_SPECIAL: database special report

  • CLIENT_SPECIAL: client special report

  • SQL_SPECIAL: SQL

id

String

Template ID

name

String

Report template name.

status

String

Status.

  • OFF: disabled

  • ON: enabled

type

String

Report type.

  • COMPREHENSIVE: comprehensive database security report

  • COMPLIANCE: database security compliance report

  • SOX: SOX - **Sarbanes-Oxley Report

  • PCI: industry standard security report

  • DB_ANALYSIS: database server analysis report

  • CLIENT_IP_ANALYSIS: client IP address analysis report

  • SQL_DCL_COMMAND: DCL command report

  • SQL_DDL_COMMAND: DDL command report

  • SQL_DML_COMMAND: DML command report

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

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

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

Status code: 500

Table 12 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 13 DbssErrorDetail

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

PDP5 error information

Example Requests

/v2/{project_id}/audit/{instance_id}/reports/templates

Example Responses

Status code: 200

OK

{
  "templates" : [ {
    "template" : {
      "id" : "t8g7LJgBTpKZyZbbeTgS",
      "name" : "Database Security General Report",
      "type" : "COMPREHENSIVE",
      "group" : "COMPREHENSIVE",
      "frequency" : "AUDIT_REPORT_WEEK",
      "status" : "ON",
      "desc" : "Database Security General Report",
      "db_ids" : "",
      "db_names" : ""
    }
  } ],
  "os_type" : "amd64"
}

Status Codes

Status Code

Description

200

OK

400

Invalid request parameter.

401

Authorization failed.

403

Unauthorized

500

Server error.

Error Codes

See Error Codes.