該接口用于創(chuàng)建DBS恢復(fù)任務(wù)。
接口說明
調(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)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問級(jí)別:是指每個(gè)操作的訪問級(jí)別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對(duì)于必選的資源類型,用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
dbs:CreateRestoreTask | Write |
|
| 無 |
請(qǐng)求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
BackupPlanId | string | 是 | 備份計(jì)劃 ID。 | dbs1hvb0ww**** |
DestinationEndpointInstanceType | string | 是 | 數(shù)據(jù)庫所在位置,取值:
| RDS |
DestinationEndpointRegion | string | 否 | 數(shù)據(jù)庫實(shí)例的地域。 說明
DestinationEndpointInstanceType 為 RDS、ECS、DDS、Express、Agent 時(shí),該參數(shù)必傳。
| cn-hangzhou |
DestinationEndpointInstanceID | string | 否 | 數(shù)據(jù)庫實(shí)例 ID。 說明
DestinationEndpointInstanceType 為 RDS、ECS、DDS、Express 時(shí),該參數(shù)必傳。
| rm-bp1p8c29***** |
DestinationEndpointIP | string | 否 | 數(shù)據(jù)庫連接地址。 說明
DestinationEndpointInstanceType 為 express、agent、other,該參數(shù)必傳。
| rm-bp*****9jv8pxero.mysql.rds.aliyuncs.com |
DestinationEndpointPort | integer | 否 | 數(shù)據(jù)庫端口。 說明
DestinationEndpointInstanceType 為 express、agent、other、ECS,該參數(shù)必傳。
| 3306 |
DestinationEndpointDatabaseName | string | 否 | 數(shù)據(jù)庫名稱。 說明
數(shù)據(jù)庫類型為 PostgreSQL、MongoDB 時(shí),該參數(shù)必傳。
| test |
DestinationEndpointUserName | string | 否 | 數(shù)據(jù)庫賬號(hào)。 說明
數(shù)據(jù)庫類型為 Redis,或者數(shù)據(jù)庫所在位置為 agent 且數(shù)據(jù)庫類型為 MSSQL 時(shí)該參數(shù)非必須,其他場景均必傳。
| test |
DestinationEndpointPassword | string | 否 | 密碼。 說明
數(shù)據(jù)庫類型為 Redis,或者數(shù)據(jù)庫所在位置為 agent 且數(shù)據(jù)庫類型為 MSSQL 時(shí)該參數(shù)非必須,其他場景均必傳。
| Test |
BackupGatewayId | long | 否 | 備份網(wǎng)關(guān) ID。 說明
DestinationEndpointInstanceType 為 agent 時(shí),該參數(shù)必傳。
| 4312**** |
RestoreObjects | string | 否 | 恢復(fù)對(duì)象。
說明
使用本 API 接口恢復(fù)對(duì)象僅支持恢復(fù)到數(shù)據(jù)庫級(jí)別,如需配置指定表的恢復(fù),請(qǐng)前往控制臺(tái)進(jìn)行操作。具體請(qǐng)參見恢復(fù)數(shù)據(jù)庫。
| MySQL表級(jí)別恢復(fù)示例如下: [{\"DBName\":\"dbname\", \"NewDBName\":\"dbname1\"}] |
RestoreTime | long | 否 | 恢復(fù)時(shí)間,取值:1554560477000。 | 1554560477000 |
BackupSetId | string | 否 | 恢復(fù)所使用的全量備份集 ID,和 RestoreTime 互斥。 | dbs1hvb0w***** |
RestoreTaskName | string | 是 | 恢復(fù)任務(wù)名稱。 | test |
DestinationEndpointOracleSID | string | 否 | Oracle SID 名稱。 說明
數(shù)據(jù)庫類型為 Oracle 時(shí),該參數(shù)必傳。
| test |
RestoreDir | string | 否 | DestinationEndpointInstanceType 為 agent 且備份計(jì)劃為 MySQL 時(shí)必傳。 | test |
RestoreHome | string | 否 | 數(shù)據(jù)庫程序目錄。 | test |
DuplicateConflict | string | 否 | 同名對(duì)象沖突處理方式,當(dāng)前支持: renamenew:遇到同名對(duì)象則重命名 | renamenew |
CrossAliyunId | string | 否 | 跨阿里云賬號(hào)備份的 UID。 | 2749528728******** |
CrossRoleName | string | 否 | 跨阿里云賬號(hào)備份的 RAM 角色名稱。 | test123 |
ClientToken | string | 否 | 用于保證請(qǐng)求的冪等性,防止重復(fù)提交請(qǐng)求。 | ETnLKlblzczshOTUbOC******** |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"HttpStatusCode": 200,
"RequestId": "60AF7C5D-EF4D-4D48-8FD5-C0823FDF28AC",
"ErrCode": "Param.NotFound",
"Success": true,
"ErrMessage": "The specified parameter %s value is not valid. ",
"RestoreTaskId": "s102h*****"
}
錯(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í)行操作 |
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
---|