You can call ModifyBackupSetDownloadRules operation to enable, modify, and disable the automatic download feature.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. You can use OpenAPI Explorer to search for API operations, call API operations, and dynamically generate SDK sample code.

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 schedule.

OpenAutoDownload Boolean No false

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

BackupGatewayId Long No 23312323

The ID of the backup gateway used to download backup sets.

FullDataFormat String No CSV

The full data format of backup set download is as follows:

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

Backup set download incremental data format:

  • 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 backup set download target.

Note Default agent: the backup gateway is installed. Currently, only this agent is required.
BackupSetDownloadTargetTypeLocation String No local

The type of the destination directory where the backup set is downloaded. This parameter is required if automatic download is enabled. Valid values:

  • local
  • nas
  • ftp
  • minio
Note The default value is local.
RegionId String No cn-hangzhou

The region ID of the instance. You can call DescribeRegions Use one of the following indexes

ClientToken String No ETnLKlblzczshOTUbOCzxxxxxxx

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

Response parameters

Parameter Type Example Description
BackupPlanId String dbstooi01exxxx

The ID of the backup schedule.

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 was successful.


Sample requests

     http(s):// Action=ModifyBackupSetDownloadRules &BackupPlanId=dbstooi01xxxx &<common request parameters> 

Sample success responses

XML format

     <ModifyBackupSetDownloadRulesResponse> <RequestId>D6E068C3-25BC-455A-85FE-45F0B22ECB1F</RequestId> <HttpStatusCode>200</HttpStatusCode> <BackupPlanId>dbstooi01exxxx</BackupPlanId> <Success>true</Success> </ModifyBackupSetDownloadRulesResponse> 

JSON Format

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

Error codes

Go to the Error Center For more information, see error codes.