首页 数据库备份 DBS API参考(2021-01-01) API目录 高级下载 DescribeDownloadTask - 查询下载任务列表

DescribeDownloadTask - 查询下载任务列表

调用DescribeDownloadTask接口查询下载任务列表。

接口说明

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

调试

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

调试

授权信息

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

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

请求参数

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

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

cn-hangzhou
InstanceNamestring

实例ID。

说明该参数为必填项。
rm-bp1imnmcjxdz7****
DatasourceIdstring

数据源DBS标记ID,传入格式为:ds-${实例ID}_${regionId}

ds-rm-2ze8g2am97624****_cn-hangzhou
BackupSetIdstring

创建下载任务时生成的备份集ID,您可调用DescribeBackups接口查询。

216****
Statestring

下载任务的状态,取值如下:

  • initializing:初始化。
  • queueing:排队中。
  • running:下载中。
  • failed:下载失败。
  • finished:下载成功。
  • expired:下载过期。
queueing
TaskTypestring

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

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

按创建时间区间的起始点查询,Long类型时间戳形式,单位为毫秒(ms)。

1661941554000
EndTimestring

按创建时间区间的终止点查询,Long类型时间戳形式,单位为毫秒(ms)。

1661941556000
PageSizestring

每页的记录数。

50
CurrentPagestring

当前页码。

1
OrderDirectstring

排序方向,取值如下:

  • asc:正序。
  • desc:倒序,为默认值。
desc
OrderColumnstring

默认按创建时间排序,取值:gmt_create

gmt_create

返回参数

名称类型描述示例值
object

返回参数如下。

RequestIdstring

请求ID。

5D285EB9-A443-592D-9F3D-A888FAC3****
ErrCodestring

错误码。

DBS.InternalError
Successstring

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

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

错误信息。

instanceName can not be empty
Codestring

错误码。

DBS.InternalError
Messagestring

错误信息。

instanceName can not be empty
Dataobject

任务详情。

PageNumberlong

页码,大于0且不超过Integer的最大值,默认值为1。

1
TotalPageslong

总页数。

2
Extrastring

备份数据上云任务的附加信息。

dbtest
TotalElementslong

总备份任务数。

1
PageSizelong

每页的记录数。

10
Contentarray

任务详情。

object

任务详情。

TaskIdstring

下载任务ID。

dt-qxntlvgu****
RegionCodestring

地域ID。

cn-hangzhou
Formatstring

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

  • csv
  • SQL
  • Parquet
csv
DbListstring

数据库列表。

[dbtest]
BakSetIdstring

全量备份集ID。

148261****
DownloadStatusstring

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

  • initializing:初始化。
  • queueing:排队中。
  • running:下载中。
  • failed:下载失败。
  • finished:下载成功。
  • expired:下载过期。
queueing
ExportDataSizestring

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

0
ImportDataSizestring

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

0
BackupSetTimestring

任意时间点下载任务时所对应的时间点,Long类型时间戳,单位为毫秒(ms)。

1663162216000
TargetTypestring

下载目标类型,返回值如下:

  • OSS
  • URL
URL
TargetPathstring

当TargeType=OSS时,返回数据下载目标路径。

test_db/path
Progressstring

已导出表数量/需导出表总数量。

0/0
GmtCreatestring

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

1663321957000

示例

正常返回示例

JSON格式

{
  "RequestId": "5D285EB9-A443-592D-9F3D-A888FAC3****",
  "ErrCode": "DBS.InternalError",
  "Success": "true",
  "ErrMessage": "instanceName can not be empty",
  "Code": "DBS.InternalError",
  "Message": "instanceName can not be empty",
  "Data": {
    "PageNumber": 1,
    "TotalPages": 2,
    "Extra": "dbtest",
    "TotalElements": 1,
    "PageSize": 10,
    "Content": [
      {
        "TaskId": "dt-qxntlvgu****",
        "RegionCode": "cn-hangzhou",
        "Format": "csv",
        "DbList": "[dbtest]",
        "BakSetId": "148261****",
        "DownloadStatus": "queueing",
        "ExportDataSize": "0",
        "ImportDataSize": "0",
        "BackupSetTime": "1663162216000",
        "TargetType": "URL",
        "TargetPath": "test_db/path",
        "Progress": "0/0",
        "GmtCreate": "1663321957000"
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-11-16OpenAPI 返回结构发生变更
变更项变更内容
出参OpenAPI 返回结构发生变更
阿里云首页 数据库备份 DBS 相关技术圈