ModifyBackupSetDownloadRules - Database Backup - Alibaba Cloud Documentation Center

Enables, configures, or disables the automatic download feature.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dbs:ModifyBackupSetDownloadRules	update	All Resources *	none	none

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: Native SQL CSV JSON Note Default value: CSV.	CSV
IncrementDataFormat	string	No	The format in which the incremental backup set is downloaded. Valid values: Native SQL CSV JSON 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: local nas ftp minio Note Default value: local.	local
ClientToken	string	No	The client token that is used to ensure the idempotence of the request.	ETnLKlblzczshOTUbOCzx****

Response parameters

Parameter	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The ID of the request.	D6E068C3-25BC-455A-85FE-45F0B22ECB1F
ErrCode	string	The error code.	Param.NotFound
Success	boolean	Indicates whether the request is successful.	true
ErrMessage	string	The error message.	The specified parameter %s value is not valid.
BackupPlanId	string	The ID of the backup schedule.	dbstooi01e****

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": "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

No change history