ModifyBackupSetDownloadRules-阿里云帮助中心

Enables, modifies, or disables the automatic download feature.

Operation description

Before calling this operation, verify whether the backup data is stored in the built-in OSS of DBS. You can call the DescribeBackupPlanList operation to check the value of BackupStorageType.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dbs:ModifyBackupSetDownloadRules

update

*BackupPlan

acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}

None

Request parameters

Parameter	Type	Required	Description	Example
BackupPlanId	string	Yes	The ID of the backup plan. You can call the DescribeBackupPlanList operation to query the ID.	dbstooi01xxxx
OpenAutoDownload	boolean	No	Specifies whether to enable automatic download. Default value: false.	false
BackupGatewayId	integer	No	The ID of the backup gateway used to download the backup set.	23312323
FullDataFormat	string	No	The format of the full data downloaded from the backup set. Valid values: Native SQL CSV JSON Note Default value: CSV.	CSV
IncrementDataFormat	string	No	The format of the incremental data downloaded from the backup set. 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 target type for downloading the backup set. Note Default value: agent. A backup gateway is installed. This is the only supported value.	agent
BackupSetDownloadTargetTypeLocation	string	No	The target directory type for downloading the backup set. This parameter is required if automatic download is enabled. Valid values: local nas ftp minio Note Default value: local.	local
ClientToken	string	No	The client token used to ensure the idempotence of the request and prevent duplicate request submissions.	ETnLKlblzczshOTUbOCzxxxxxxx

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The request ID.	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 plan.	dbstooi01exxxx

Examples

Success response

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

HTTP status code	Error code	Error message	Description
403	Request.Forbidden	Have no Permissions

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.