CreateDownload - 创建下载任务_数据管理 DMS-阿里云帮助中心

创建高级下载任务。

接口说明

适用引擎

RDS MySQL（云盘系列）
RDS PostgreSQL
PolarDB MySQL 版

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dbs:CreateDownload

create

*DBInstance

acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}

无

请求参数

名称	类型	必填	描述	示例值
RegionCode	string	是	实例所在地域 ID，您可调用DescribeDBInstanceAttribute（RDS 实例）或DescribeDBClusterAttribute（PolarDB 实例）查询。	cn-beijing
InstanceName	string	是	实例 ID。	rm-wz994c1t1****
BakSetType	string	否	下载任务类型，取值如下： full：全量备份集下载。 pitr：任意时间点下载。	full
BakSetId	string	否	备份集 ID，您可调用DescribeBackups（RDS 实例）或DescribeBackups（PolarDB 实例）接口获取该参数值。说明当 BakSetType=full 时，该参数必填。	146005****
DownloadPointInTime	string	否	下载任意时间点。Long 类型时间戳形式，单位为毫秒（ms）。说明当 BakSetType=pitr 时，该参数必填。	1661331864000
BakSetSize	string	否	全量备份集大小，您可调用DescribeBackups（RDS 实例）或DescribeBackups（PolarDB 实例）接口查询，单位为字节（Byte）。	216****
FormatType	string	否	下载转换的目标格式，取值如下： CSV SQL Parquet 说明该参数为必填项。	CSV
TargetType	string	否	下载目标类型，取值如下： OSS URL	OSS
TargetBucket	string	否	OSS Bucket 名称。当 TargetType=OSS 时，该参数必填。请确认您的账号已拥有 AliyunDBSDefaultRole 权限，如何授权，请参见 RAM 资源授权。您也可访问控制台根据操作指引去授权。	test123
TargetPath	string	否	数据下载目标路径。说明当 TargetType=OSS 时，该参数必填。	test_db/path
TargetOssRegion	string	否	OSS Bucket 所在地域。说明当 TargetType=OSS 时，该参数必填。	cn-beijing
PrimaryKeyTypeOnly	string	否	仅 MongoDB 引擎需要填写该字段。用于标识库表中主键类型是否唯一。是: true; 否: false。	false
IsCluster	string	否	仅 MongoDB 引擎需要填写该字段。用于标识当前实例是否为分片集群。类型为 MongoDB 分片集群: true; 类型为其他: false。	false
AdminDatabase	string	否	仅 MongoDB 引擎需要填写该字段。用于标识鉴权库名称。默认名称为 admin。	admin
UseZstd	string	否	用于标识压缩包采纳的压缩算法是否为 zstd。默认为 false。	false
ClusterName	string	否	仅 MongoDB 引擎分片集群需要填写该字段。分片集群 ID。	dds-0xid8e5336******

返回参数

名称	类型	描述	示例值
	object	返回值如下。
RequestId	string	请求 ID。	A08F908D-2C35-583F-93C1-ED80753F****
ErrCode	string	错误码。	DBS.ParamIsInValid
Success	string	请求是否成功，返回值如下： true：请求成功。 false：请求失败。	true
ErrMessage	string	错误信息。	formatType can not be empty
Code	string	状态码。	DBS.ParamIsInValid
Message	string	错误信息。	formatType can not be empty
Data	object	返回数据如下。
BakSetId	string	全量备份集 ID。	146005****
DownloadStatus	string	下载任务的状态，返回值如下： initializing：初始化。 queueing：排队中。 running：下载中。 failed：下载失败。 finished：下载成功。 expired：下载过期。说明下载目标为 URL 的任务完成 3 天后会过期。	initializing
Progress	string	已下载表数量/表总数。说明如果任务当前处理准备阶段，该进度返回为 0/0。	0/0
BackupSetTime	integer	任意时间点下载任务时所对应的时间点，返回格式为时间戳形式。	1661373070000
RegionCode	string	地域 ID。	cn-beijing
TargetPath	string	数据下载目标路径。说明当TargetType=OSS时，该参数返回。	test_db/path
DbList	string	当下载任务为库表过滤任务时，该字段返回对应库表信息。	testdb
ExportDataSize	integer	导出数据量，单位为字节（Byte）。	0
ImportDataSize	integer	处理数据量，单位为字节（Byte）。	0
GmtCreate	integer	任务创建时间，返回格式为时间戳形式。	1661940917570
TaskId	string	下载任务 ID。	dt-qxnsfq5s****
Format	string	目标转换格式。	CSV
TargetType	string	下载目标类型。	URL

示例

正常返回示例

JSON格式

{
  "RequestId": "A08F908D-2C35-583F-93C1-ED80753F****",
  "ErrCode": "DBS.ParamIsInValid",
  "Success": "true",
  "ErrMessage": "formatType can not be empty",
  "Code": "DBS.ParamIsInValid",
  "Message": "formatType can not be empty",
  "Data": {
    "BakSetId": "146005****",
    "DownloadStatus": "initializing",
    "Progress": "0/0",
    "BackupSetTime": 1661373070000,
    "RegionCode": "cn-beijing",
    "TargetPath": "test_db/path",
    "DbList": "testdb",
    "ExportDataSize": 0,
    "ImportDataSize": 0,
    "GmtCreate": 1661940917570,
    "TaskId": "dt-qxnsfq5s****",
    "Format": "CSV",
    "TargetType": "URL"
  }
}

错误码

HTTP status code	错误码	错误信息	描述
200	DBS.DownloadTask.CannotFind	Can not find download task.	无法找到高级下载任务。
200	DBS.DownloadTask.JobAlreadyExist	Job already submit in recent days, please check it.	相同备份集的高级下载任务在近几天被提交过，请检查。
200	DBS.DownloadTask.OnlyOneRunningOrFailedTask	There can be only one running or failed task for the instance.	当前实例只能同时存在一个运行中/失败的任务。
200	DBS.DownloadTask.OssForbid	OSS is forbidden to access. Please check your OSS bucket.	访问OSS被拒绝。请检查您的OSS权限配置。
200	DBS.DownloadTask.OssStorageTypeInvalid	Unsupported bucket storage. Please make sure that your OSS bucket's storgae type is standard.	当前OSS bucket类型不支持。请确保您的OSS bucket类型是标准存储类型。
200	Forbidden.InstanceNotFound	instance not found	实例不存在
403	Request.Forbidden	Have no Permissions	当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作
403	DBS.NoPermissionException	Rejected by ValidationChecker.	Rejected by ValidationChecker.
404	DBS.NotExists	data source do not existed.	DBS.NotExists

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

变更历史

更多信息，参考变更详情。