All Products
Search
Document Center

Database Backup:ModifyBackupSetDownloadRules

Last Updated:Mar 03, 2024

Enables, configures, or disables the automatic download feature.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
BackupPlanIdstringYes

The ID of the backup gateway that is used to download the backup set.

dbstooi01xxxx
OpenAutoDownloadbooleanNo

local

false
BackupGatewayIdlongNo

The format in which the full backup set is downloaded. Valid values:

  • Native
  • SQL
  • CSV
  • JSON
Note Default value: CSV.
23312323
FullDataFormatstringNo

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:

  • local
  • nas
  • ftp
  • minio
Note Default value: local.
CSV
IncrementDataFormatstringNo

The ID of the backup schedule.

Native
BackupSetDownloadDirstringNo

The server directory to which the backup set is downloaded.

test
BackupSetDownloadTargetTypestringNo

test

agent
BackupSetDownloadTargetTypeLocationstringNo

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
ClientTokenstringNo

cn-hangzhou

ETnLKlblzczshOTUbOCzxxxxxxx

Response parameters

ParameterTypeDescriptionExample
object
HttpStatusCodeinteger

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

200
RequestIdstring

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

D6E068C3-25BC-455A-85FE-45F0B22ECB1F
ErrCodestring

23312323

Param.NotFound
Successboolean

The error code.

true
ErrMessagestring

The ID of the backup schedule.

The specified parameter %s value is not valid.
BackupPlanIdstring

CSV

dbstooi01exxxx

Examples

Sample success responses

JSONformat

{
  "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 timeSummary of changesOperation
No change history