CreateDownload - 创建下载任务

调用CreateDownload接口创建高级下载任务。

接口说明

您可以按任意时间点或按指定备份集创建高级下载任务,并支持选择下载目标为URL或直接将数据写入您的OSS中,后续方便您进行数据分析以及离线归档。更多详情,请参见高级下载

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dbs:CreateDownloadRead
    全部资源

请求参数

名称类型必填描述示例值
RegionCodestring

实例所在地域ID,您可调用DescribeDBInstanceAttribute查询。

cn-beijing
InstanceNamestring

实例ID。

rm-wz994c1t1****
BakSetTypestring

下载任务类型,取值如下:

  • full:全量备份集下载。
  • pitr:任意时间点下载。
full
BakSetIdstring

备份集ID,您可调用DescribeBackups接口获取该参数值。

说明当BakSetType=full时,该参数必填。
146005****
DownloadPointInTimestring

下载任意时间点。Long类型时间戳形式,单位为毫秒(ms)。

说明当BakSetType=pitr时,该参数必填。
1661331864000
BakSetSizestring

全量备份集大小,您可调用DescribeBackups接口查询,单位为字节(Byte)。

216****
FormatTypestring

下载转换的目标格式,取值如下:

  • csv
  • SQL
  • Parquet
说明该参数为必填项。
csv
TargetTypestring

下载目标类型,取值如下:

  • OSS
  • URL
OSS
TargetBucketstring

OSS Bucket名称。

  • 当TargetType=OSS时,该参数必填。
  • 请确认您的账号已拥有AliyunDBSDefaultRole权限,如何授权,请参见RAM资源授权。您也可访问控制台根据操作指引去授权。
test123
TargetPathstring

数据下载目标路径。

说明当TargetType=OSS时,该参数必填。
test_db/path
TargetOssRegionstring

OSS Bucket所在地域。

说明当TargetType=OSS时,该参数必填。
cn-beijing

返回参数

名称类型描述示例值
object

返回值如下。

RequestIdstring

请求ID。

A08F908D-2C35-583F-93C1-ED80753F****
ErrCodestring

错误码。

DBS.ParamIsInValid
Successstring

请求是否成功,返回值如下:

  • true:请求成功。
  • false:请求失败。
true
ErrMessagestring

错误信息。

formatType can not be empty
Codestring

状态码。

DBS.ParamIsInValid
Messagestring

错误信息。

formatType can not be empty
Dataobject

返回数据如下。

BakSetIdstring

全量备份集ID。

146005****
DownloadStatusstring

下载任务的状态,返回值如下:

  • initializing:初始化。
  • queueing:排队中。
  • running:下载中。
  • failed:下载失败。
  • finished:下载成功。
  • expired:下载过期。
说明下载目标为URL的任务完成3天后会过期。
initializing
Progressstring

已下载表数量/表总数。

说明如果任务当前处理准备阶段,该进度返回为0/0。
0/0
BackupSetTimelong

任意时间点下载任务时所对应的时间点,返回格式为时间戳形式。

1661373070000
RegionCodestring

地域ID。

cn-beijing
TargetPathstring

数据下载目标路径。

说明当TargeType=OSS时,该参数返回。
test_db/path
DbListstring

当下载任务为库表过滤任务时,该字段返回对应库表信息。

testdb
ExportDataSizelong

导出数据量,单位为字节(Byte)。

0
ImportDataSizelong

处理数据量,单位为字节(Byte)。

0
GmtCreatelong

任务创建时间,返回格式为时间戳形式。

1661940917570
TaskIdstring

下载任务ID。

dt-qxnsfq5s****
Formatstring

目标转换格式。

csv
TargetTypestring

下载目标类型。

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

错误码

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

阿里云首页 数据库备份 DBS 相关技术圈