调用ModifyBackupSetDownloadRules开启、修改、关闭自动下载功能

该接口用于开启、修改、关闭自动下载功能。

接口说明

使用本接口前请先确认备份数据是否存储在 DBS 的内置 OSS 上，您可通过调用 DescribeBackupPlanList 接口查看 BackupStorageType 取值情况。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
BackupPlanId	string	是	备份计划 ID，可通过调用 DescribeBackupPlanList 接口查看。	dbstooi01xxxx
OpenAutoDownload	boolean	否	是否开启自动下载，默认 false。	false
BackupGatewayId	long	否	备份集下载备份网关 ID。	23312323
FullDataFormat	string	否	备份集下载全量数据格式： Native SQL CSV JSON 说明默认 CSV。	CSV
IncrementDataFormat	string	否	备份集下载增量数据格式： Native SQL CSV JSON 说明默认 Native。	Native
BackupSetDownloadDir	string	否	备份集下载服务器目录。	test
BackupSetDownloadTargetType	string	否	备份集下载目标类型。说明默认 agent：已安装备份网关，目前仅此项。	agent
BackupSetDownloadTargetTypeLocation	string	否	备份集下载目标目录类型，如果是开启自动下载，则必填，取值： local nas ftp minio 说明默认为 local。	local
ClientToken	string	否	用于保证请求的幂等性，防止重复提交请求。	ETnLKlblzczshOTUbOCzxxxxxxx

返回参数

名称	类型	描述	示例值
	object
HttpStatusCode	integer	HTTP 状态码。	200
RequestId	string	请求 ID。	D6E068C3-25BC-455A-85FE-45F0B22ECB1F
ErrCode	string	错误码。	Param.NotFound
Success	boolean	是否成功。	true
ErrMessage	string	错误信息。	The specified parameter %s value is not valid.
BackupPlanId	string	备份计划 ID。	dbstooi01exxxx

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "RequestId": "D6E068C3-25BC-455A-85FE-45F0B22ECB1F",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.  ",
  "BackupPlanId": "dbstooi01exxxx"
}

错误码

HTTP status code	错误码	错误信息	描述
403	Request.Forbidden	Have no Permissions	当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史