調用CreateDownload API建立進階下載任務-Data Management-阿里雲

建立進階下載任務。

介面說明

適用引擎

RDS MySQL（雲端硬碟系列）
RDS PostgreSQL
PolarDB MySQL 版
MongoDB

調試

您可以在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 Bson qp.xb 說明該參數為必填項。其中，Bson 格式若且唯若執行個體類型為 MongoDB 時才能進行選擇；qp.xb 格式若且唯若執行個體類型為 RDS MySQL 時才能進行選擇。枚舉值： qp.xb : qp.xb csv : csv bson : bson csv-with-header : csv-with-header parquet : parquet sql : sql	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******
IsPhysical	boolean	否	僅當您的執行個體類型為 RDS MySQL 且需要下載 qp.xb 格式時，該參數才必填。您需要指定該參數為 true。	true

返回參數

名稱	類型	描述	樣本值
	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	執行個體不存在
200	DBS.DownloadTask.BakSetError	DBS download task bak set error. Your backup set does not meet the requirements.	您選擇的備份組不滿足進階下載要求。
200	DBS.DownloadTask.CustinIdNotSupport	DBS DownloadTask CustinIdNotSupport.	進階下載執行個體暫不支援下載
200	DBS.DownloadTask.CustinNameNotSupport	DBS DownloadTask CustinNameNotSupport.	進階下載執行個體暫不支援下載。
200	DBS.DownloadTask.DbTypeNotSupport	DBS DownloadTask DbTypeNotSupport.	進階下載引擎類型暫不支援
200	DBS.DownloadTask.InstanceInfoNotSupport	DBS DownloadTask InstanceInfoNotSupport.	進階下載當前執行個體不支援下載
200	DBS.DownloadTask.InstanceParamNotSupport	DBS DownloadTask InstanceParamNotSupport.	進階下載執行個體暫不支援下載。
200	DBS.DownloadTask.InstanceStorageTypeNotSupport	DBS DownloadTask InstanceStorageTypeNotSupport.	進階下載執行個體儲存類型暫不支援下載。
200	DBS.DownloadTask.InstanceVersionNotSupport	DBS DownloadTask InstanceVersionNotSupport.	進階下載引擎版本暫不支援下載。
200	DBS.DownloadTask.NotSupport	DBS DownloadTask NotSupport.	進階下載暫不支援下載。
200	DBS.DownloadTask.RegionNotSupport	DBS DownloadTask RegionNotSupport.	進階下載地區暫不支援
200	DBS.DownloadTask.UserNotSupport	DBS DownloadTask UserNotSupport.	進階下載使用者暫不支援下載
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

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。

Data Management：CreateDownload - 建立下載任務