You can enable, modify, and disable the automatic download function by calling the ModifyBackupSetDownloadRules operation.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ModifyBackupSetDownloadRules

The operation that you want to perform. Valid values: ModifyBackupSetDownloadRules.

BackupPlanId String Yes dbstooi01xxxx

The ID of the backup plan.

OpenAutoDownload Boolean No false

Specifies whether to enable automatic download. Default value: false.

BackupGatewayId Long No 23312323

Backup set download backup gateway ID.

FullDataFormat String No CSV

Backup set download full data format:

  • Native
  • SQL
  • CSV
  • JSON
Note The default value is CSV.
IncrementDataFormat String No Native

Download an incremental data format from the backup set:

  • Native
  • SQL
  • CSV
  • JSON
Note Default value: Native.
BackupSetDownloadDir String No test

The Directory of the backup set download server.

BackupSetDownloadTargetType String No agent

The type of the target backup set.

Note Default agent: the backup gateway is installed.
RegionId String No cn-hangzhou

The region ID of the instance. You can call DescribeRegions query.

ClientToken String No ETnLKlblzczshOTUbOCzxxxxxxx

The client token that is used to ensure the idempotency of the request.

Response parameters

Parameter Type Example Description
BackupPlanId String dbstooi01exxxx

The ID of the backup plan.

ErrCode String Param.NotFound

The error code.

ErrMessage String The specified parameter %s value is not valid.

The error message.

HttpStatusCode Integer 200

The HTTP status code.

RequestId String D6E068C3-25BC-455A-85FE-45F0B22ECB1F

The ID of the request.

Success Boolean true

Indicates whether the request succeeded.


Sample requests

http(s):// Action=ModifyBackupSetDownloadRules
&<Common request parameters>

Sample success responses

XML format

<ModifyBackupSetDownloadRulesResponse>  <RequestId>D6E068C3-25BC-455A-85FE-45F0B22ECB1F</RequestId>

JSON format

  "RequestId": "D6E068C3-25BC-455A-85FE-45F0B22ECB1F",
  "HttpStatusCode": 200,
  "BackupPlanId": "dbstooi01exxxx",
  "Success": true

Error codes

For a list of error codes, visit the API Error Center.