Enables, configures, or disables the automatic download feature.
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
BackupPlanId | string | Yes | The ID of the backup gateway that is used to download the backup set. | dbstooi01xxxx |
OpenAutoDownload | boolean | No | local | false |
BackupGatewayId | long | No | The format in which the full backup set is downloaded. Valid values:
Note
Default value: CSV.
| 23312323 |
FullDataFormat | 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.
| CSV |
IncrementDataFormat | string | No | The ID of the backup schedule. | Native |
BackupSetDownloadDir | string | No | The server directory to which the backup set is downloaded. | test |
BackupSetDownloadTargetType | string | No | test | agent |
BackupSetDownloadTargetTypeLocation | 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.
| local |
ClientToken | string | No | cn-hangzhou | ETnLKlblzczshOTUbOCzxxxxxxx |
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": "dbstooi01exxxx"
}
Error codes
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|
No change history