創(chuàng)建高級(jí)下載任務(wù)。
接口說(shuō)明
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語(yǔ)句的Action
元素中使用,用來(lái)給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說(shuō)明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問(wèn)級(jí)別:是指每個(gè)操作的訪問(wèn)級(jí)別,取值為寫(xiě)入(Write)、讀取(Read)或列出(List)。
- 資源類(lèi)型:是指操作中支持授權(quán)的資源類(lèi)型。具體說(shuō)明如下:
- 對(duì)于必選的資源類(lèi)型,用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問(wèn)級(jí)別 | 資源類(lèi)型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
dbs:CreateDownload | create | *DBInstance acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId} |
| 無(wú) |
請(qǐng)求參數(shù)
名稱 | 類(lèi)型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionCode | string | 是 | 實(shí)例所在地域 ID,您可調(diào)用DescribeDBInstanceAttribute(RDS 實(shí)例)或DescribeDBClusterAttribute(PolarDB 實(shí)例)查詢。 | cn-beijing |
InstanceName | string | 是 | 實(shí)例 ID。 | rm-wz994c1t1**** |
BakSetType | string | 否 | 下載任務(wù)類(lèi)型,取值如下:
| full |
BakSetId | string | 否 | 備份集 ID,您可調(diào)用DescribeBackups(RDS 實(shí)例)或DescribeBackups(PolarDB 實(shí)例)接口獲取該參數(shù)值。 說(shuō)明
當(dāng) BakSetType=full 時(shí),該參數(shù)必填。
| 146005**** |
DownloadPointInTime | string | 否 | 下載任意時(shí)間點(diǎn)。Long 類(lèi)型時(shí)間戳形式,單位為毫秒(ms)。 說(shuō)明
當(dāng) BakSetType=pitr 時(shí),該參數(shù)必填。
| 1661331864000 |
BakSetSize | string | 否 | 全量備份集大小,您可調(diào)用DescribeBackups(RDS 實(shí)例)或DescribeBackups(PolarDB 實(shí)例)接口查詢,單位為字節(jié)(Byte)。 | 216**** |
FormatType | string | 否 | 下載轉(zhuǎn)換的目標(biāo)格式,取值如下:
說(shuō)明
該參數(shù)為必填項(xiàng)。
| CSV |
TargetType | string | 否 | 下載目標(biāo)類(lèi)型,取值如下:
| OSS |
TargetBucket | string | 否 | OSS Bucket 名稱。
| test123 |
TargetPath | string | 否 | 數(shù)據(jù)下載目標(biāo)路徑。 說(shuō)明
當(dāng) TargetType=OSS 時(shí),該參數(shù)必填。
| test_db/path |
TargetOssRegion | string | 否 | OSS Bucket 所在地域。 說(shuō)明
當(dāng) TargetType=OSS 時(shí),該參數(shù)必填。
| cn-beijing |
返回參數(shù)
示例
正常返回示例
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"
}
}
錯(cuò)誤碼
HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
---|---|---|---|
403 | Request.Forbidden | Have no Permissions | 當(dāng)前操作未被授權(quán),請(qǐng)聯(lián)系主賬號(hào)在RAM控制臺(tái)進(jìn)行授權(quán)后再執(zhí)行操作 |
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
---|