调用ModifyBackupSetDownloadRules接口可以开启、修改、关闭自动下载功能。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 ModifyBackupSetDownloadRules

系统规定参数。取值：ModifyBackupSetDownloadRules。

BackupPlanId String 是 dbstooi01xxxx

备份计划ID。
OpenAutoDownload Boolean 否 false

是否开启自动下载，默认false。
BackupGatewayId Long 否 23312323

备份集下载备份网关ID。
FullDataFormat String 否 CSV

备份集下载全量数据格式：

  • Native
  • SQL
  • CSV
  • JSON
说明 默认 CSV。
IncrementDataFormat String 否 Native

备份集下载增量数据格式：

  • Native
  • SQL
  • CSV
  • JSON
说明 默认Native。
BackupSetDownloadDir String 否 test

备份集下载服务器目录。
BackupSetDownloadTargetType String 否 agent

备份集下载目标类型 。

说明 默认agent：已安装备份网关，目前仅此项。
BackupSetDownloadTargetTypeLocation String 否 local

备份集下载目标目录类型，如果是开启自动下载，则必填，取值：

  • local
  • nas
  • ftp
  • minio
说明 默认为local。
RegionId String 否 cn-hangzhou

地域ID。您可以调用DescribeRegions查询。

ClientToken String 否 ETnLKlblzczshOTUbOCzxxxxxxx

用于保证请求的幂等性，防止重复提交请求。

返回数据

名称 类型 示例值 描述
BackupPlanId String dbstooi01exxxx

备份计划ID。
ErrCode String Param.NotFound

错误码。
ErrMessage String The specified parameter %s value is not valid.

错误信息。
HttpStatusCode Integer 200

HTTP状态码。
RequestId String D6E068C3-25BC-455A-85FE-45F0B22ECB1F

请求ID。
Success Boolean true

是否成功。

示例

请求示例

http(s)://dbs-api.cn-hangzhou.aliyuncs.com/?Action=ModifyBackupSetDownloadRules
&BackupPlanId=dbstooi01xxxx
&<公共请求参数>

正常返回示例

XML 格式 

<ModifyBackupSetDownloadRulesResponse>  <RequestId>D6E068C3-25BC-455A-85FE-45F0B22ECB1F</RequestId>
  <HttpStatusCode>200</HttpStatusCode>
  <BackupPlanId>dbstooi01exxxx</BackupPlanId>
  <Success>true</Success>
</ModifyBackupSetDownloadRulesResponse>

JSON 格式 

{
  "RequestId": "D6E068C3-25BC-455A-85FE-45F0B22ECB1F",
  "HttpStatusCode": 200,
  "BackupPlanId": "dbstooi01exxxx",
  "Success": true
}

错误码

访问错误中心查看更多错误码。