DescribeDownloadTask - 查詢下載工作清單 -

查詢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 標記識別項，傳入格式為：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 - 查詢下載工作清單