Help Center/ Database Security Service/ API Reference/ API/ Risk Data Export/ Modifying the Name and Path of the Risk Export Bucket (by Domain ID)

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

View PDF

Modifying the Name and Path of the Risk Export Bucket (by Domain ID)

Function

Modify the name and path of the risk export bucket (by domain ID).

URI

POST /v1/{domain_id}/audit/{instance_id}/backup/risk/global/bucket-path

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
domain_id	Yes	String	Definition Account ID. Obtain the value by calling the IAM API for querying IAM user details. Constraints N/A Range Determined by the value of the IAM API used for [querying user tokens]. 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
backup_domain_id	No	String	DomainID
bucket_name	Yes	String	OBS Bucket Name
bucket_root_path	No	String	Root path of the OBS bucket

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
result	String	Operation Result SUCCESS: success

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/{domain_id}/audit/{instance_id}/backup/risk/global/bucket-path

{
  "backup_domain_id" : "",
  "bucket_name" : "cbh-ynf",
  "bucket_root_path" : ""
}