调用DescribeDownloadTask查询高级下载任务列表-数据管理 DMS-阿里云

查询RDS MySQL、RDS PostgreSQL、PolarDB MySQL版实例的高级下载任务列表。

接口说明

适用引擎

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

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dbs:DescribeDownloadTask

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionCode	string	是	实例所在地域 ID，您可以调用 DescribeDBInstanceAttribute 查询。	cn-hangzhou
InstanceName	string	否	实例 ID。说明该参数为必填项。	rm-bp1imnmcjxdz7****
DatasourceId	string	否	数据源 DBS 标记 ID，传入格式为：ds-${实例 ID}_${regionId}。	ds-rm-2ze8g2am97624****_cn-hangzhou
BackupSetId	string	否	创建下载任务时生成的备份集 ID，您可调用 DescribeBackups 接口查询。	216****
State	string	否	下载任务的状态，取值如下： initializing：初始化。 queueing：排队中。 running：下载中。 failed：下载失败。 finished：下载成功。 expired：下载过期。	queueing
TaskType	string	否	下载任务类型，取值如下： full：全量备份集下载。 pitr：任意时间点下载。	full
StartTime	string	否	按创建时间区间的起始点查询，Long 类型时间戳形式，单位为毫秒（ms）。	1661941554000
EndTime	string	否	按创建时间区间的终止点查询，Long 类型时间戳形式，单位为毫秒（ms）。	1661941556000
PageSize	string	否	每页的记录数。	50
CurrentPage	string	否	当前页码。	1
OrderDirect	string	否	排序方向，取值如下： asc：正序。 desc：倒序，为默认值。	desc
OrderColumn	string	否	默认按创建时间排序，取值：gmt_create。	gmt_create
ClusterName	string	否		dds-example

返回参数

名称	类型	描述	示例值
	object	返回参数如下。
RequestId	string	请求 ID。	5D285EB9-A443-592D-9F3D-A888FAC3****
ErrCode	string	错误码。	DBS.InternalError
Success	string	请求是否成功，返回值如下： true：请求成功。 false：请求失败。	true
ErrMessage	string	错误信息。	instanceName can not be empty
Code	string	错误码。	DBS.InternalError
Message	string	错误信息。	instanceName can not be empty
Data	object	任务详情。
PageNumber	integer	页码，大于 0 且不超过 Integer 的最大值，默认值为 1。	1
TotalPages	integer	总页数。	2
Extra	string	备份数据上云任务的附加信息。	dbtest
TotalElements	integer	总备份任务数。	1
PageSize	integer	每页的记录数。	10
Content	object
List	array<object>	任务详情。
	object	任务详情。
TaskId	string	下载任务 ID。	dt-qxntlvgu****
RegionCode	string	地域 ID。	cn-hangzhou
Format	string	下载转换的目标格式，返回值如下： csv SQL Parquet	csv
DbList	string	数据库列表。	[dbtest]
BakSetId	string	全量备份集 ID。	148261****
DownloadStatus	string	下载任务的状态，返回值如下： initializing：初始化。 queueing：排队中。 running：下载中。 failed：下载失败。 finished：下载成功。 expired：下载过期。	queueing
ExportDataSize	string	导出数据量，单位为字节（Byte）。	0
ImportDataSize	string	处理数据量，单位为字节（Byte）。	0
BackupSetTime	string	任意时间点下载任务时所对应的时间点，Long 类型时间戳，单位为毫秒（ms）。	1663162216000
TargetType	string	下载目标类型，返回值如下： OSS URL	URL
TargetPath	string	当TargetType=OSS时，返回数据下载目标路径。	test_db/path
Progress	string	已导出表数量/需导出表总数量。	0/0
GmtCreate	string	任务创建时间，返回格式为时间戳形式。	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": {
      "List": [
        {
          "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"
        }
      ]
    }
  }
}

错误码

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

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

变更历史

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

DescribeDownloadTask - 查询下载任务列表