Help Center/ Database Security Service/ API Reference/ API/ Risk Data Export/ Obtaining the Export Configuration of a Single Risk

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

View PDF

Obtaining the Export Configuration of a Single Risk

Function

Obtain the export configuration of a single risk.

URI

GET /v1/{project_id}/audit/{instance_id}/backup/risk/template/{db_id}

**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
db_id	Yes	String	Definition Database ID. You can obtain the value from the db_id field in the risk export configuration list. Constraints N/A Range The value is determined by the value of the API for obtaining the risk export configuration list. The value is a string of 16 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.) 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
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 4** 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 5** DbssErrorDetail
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	PDP5 error information

Status code: 401

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

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

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

Example Requests

/v1/{project_id}/audit/{instance_id}/backup/risk/template/{db_id}

Example Responses

Status code: 200

{
  "id" : "_QS6ypgBhN3UjKKcnymn",
  "status" : 1,
  "db_id" : "twS8v5gBhN3UjKKcoyJ6",
  "db_ip" : "10.0.2.3",
  "db_name" : "pgtest",
  "db_port" : 5300
}