Help Center/ Database Security Service/ API Reference/ API/ Risk Data Export/ Obtaining the Risk Export Configuration List
Updated on 2025-09-10 GMT+08:00

Obtaining the Risk Export Configuration List

Function

Obtain the risk export configuration list.

URI

GET /v1/{project_id}/audit/{instance_id}/backup/risk/templates

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

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

templates

Array of RiskBackupTemplateBean objects

Configuration List

Table 4 RiskBackupTemplateBean

Parameter

Type

Description

db_id

String

The database record ID.

db_ip

String

Database IP address

db_name

String

Database name

db_port

Integer

Database Port

id

String

Configuration ID

status

Integer

Alarm status.

  • 0: disabled

  • 1: enabled

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}/backup/risk/templates

Example Responses

Status code: 200

OK

{
  "templates" : [ {
    "id" : null,
    "status" : 0,
    "db_id" : "twS8v5gBhN3UjKKcoyJ6",
    "db_ip" : "10.0.2.3",
    "db_name" : "pgtest",
    "db_port" : 5300
  }, {
    "id" : null,
    "status" : 0,
    "db_id" : "UAQ2xZgBhN3UjKKchSay",
    "db_ip" : "192.168.1.62",
    "db_name" : "rds-chen2025",
    "db_port" : 5432
  }, {
    "id" : null,
    "status" : 0,
    "db_id" : "4YF4Y5gBzqyXNYgsjgsC",
    "db_ip" : "122.24.4.52",
    "db_name" : "testmu",
    "db_port" : 1
  } ]
}

Status Codes

Status Code

Description

200

OK

400

Invalid request parameter.

401

Authorization failed.

403

Unauthorized

500

Server error.

Error Codes

See Error Codes.