Enables, configures, or disables the automatic download feature.
Debugging
Authorization information
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
BackupPlanId | string | Yes | The ID of the backup schedule. | dbstooi01**** |
OpenAutoDownload | boolean | No | Specifies whether to enable the automatic download feature. Default value: false. | false |
BackupGatewayId | long | No | The ID of the backup gateway that is used to download the backup set. | 2331**** |
FullDataFormat | string | No | The format in which the full backup set is downloaded. Valid values:
Note
Default value: CSV.
| CSV |
IncrementDataFormat | string | No | The format in which the incremental backup set is downloaded. Valid values:
Note
Default value: Native.
| Native |
BackupSetDownloadDir | string | No | The server directory to which the backup set is downloaded. | test |
BackupSetDownloadTargetType | string | No | The type of the destination server to which the backup set is downloaded. Note
Set the value to agent, which indicates a server on which a backup gateway is installed.
| agent |
BackupSetDownloadTargetTypeLocation | string | No | The type of the destination directory to which the backup set is downloaded. This parameter is required if the automatic download feature is enabled. Valid values:
Note
Default value: local.
| local |
ClientToken | string | No | The client token that is used to ensure the idempotence of the request. | ETnLKlblzczshOTUbOCzx**** |
Response parameters
Examples
Sample success responses
JSON
format
{
"HttpStatusCode": 200,
"RequestId": "D6E068C3-25BC-455A-85FE-45F0B22ECB1F",
"ErrCode": "Param.NotFound",
"Success": true,
"ErrMessage": "The specified parameter %s value is not valid. ",
"BackupPlanId": "dbstooi01e****"
}
Error codes
HTTP status code | Error code | Error message |
---|---|---|
403 | Request.Forbidden | Have no Permissions |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|