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

Enabling/Disabling Backup

Function

Enable/Disable backup.

URI

POST /v1/{domain_id}/audit/{instance_id}/backup/switch

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

bucket_name

Yes

String

OBS Bucket Name

bucket_root_path

No

String

Backup Root Path

cycle

Yes

String

Backup Cycle

  • PER_DAY: every day

  • PER_WEEK: weekly

  • PER_MONTH: monthly

  • PER_HOUR: every hour

  • FIVE_MIN: every 5 minutes

mode

Yes

String

Backup Mode

  • AUTO: automatic backup

status

Yes

Integer

Specifies the switch status.

  • 0: disabled

  • 1: enabled

trigger_time

Yes

String

Trigger time, in yyyy-MM-dd HH:mm:ss format.

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/switch

{
  "mode" : "AUTO",
  "trigger_time" : "2025-08-21 02:00:44",
  "status" : 1,
  "cycle" : "PER_HOUR",
  "bucket_name" : "cbh-ynf",
  "bucket_root_path" : ""
}

Example Responses

Status code: 200

OK

{
  "result" : "SUCCESS"
}

Status Codes

Status Code

Description

200

OK

400

Invalid request parameter.

401

Authorization failed.

403

Unauthorized

500

Server error.

Error Codes

See Error Codes.