該接口用于創(chuàng)建一個(gè)DBS備份計(jì)劃。
接口說(shuō)明
本接口對(duì)應(yīng)的控制臺(tái)操作,請(qǐng)參見(jiàn)購(gòu)買備份計(jì)劃。
調(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)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說(shuō)明如下:
- 對(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)限,操作才能成功。
操作 | 訪問(wèn)級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
dbs:CreateBackupPlan | create |
|
| 無(wú) |
請(qǐng)求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Region | string | 否 | DBS 地域,該參數(shù)為必填項(xiàng),可通過(guò) DescribeRegions 查看 DBS 支持地域。 說(shuō)明
更多詳情信息,請(qǐng)參見(jiàn)服務(wù)接入點(diǎn)。
| cn-hangzhou |
InstanceClass | string | 是 | 規(guī)格,取值如下:
說(shuō)明
規(guī)格越高,備份與恢復(fù)的性能越高,更多信息,請(qǐng)參見(jiàn)規(guī)格說(shuō)明。
| micro |
DatabaseType | string | 是 | 數(shù)據(jù)庫(kù)類型,取值如下:
| MySQL |
BackupMethod | string | 是 | 備份方式,取值如下:
| logical |
Period | string | 否 | 指定預(yù)付費(fèi)實(shí)例為包年或者包月類型,取值如下:
| Month |
UsedTime | integer | 否 | 指定購(gòu)買時(shí)長(zhǎng),取值如下:
| 1 |
PayType | string | 否 | 支付方式,取值如下:
說(shuō)明
| prepay |
DatabaseRegion | string | 否 | 數(shù)據(jù)庫(kù)地域。 說(shuō)明
當(dāng) PayType 為 postpay 時(shí),該參數(shù)必選。
| cn-hangzhou |
StorageRegion | string | 否 | 存儲(chǔ)地域。 說(shuō)明
當(dāng) PayType 為 postpay 時(shí),該參數(shù)必選。
| cn-hangzhou |
InstanceType | string | 否 | 數(shù)據(jù)庫(kù)實(shí)例類型,取值如下:
說(shuō)明
當(dāng) PayType 為 postpay 時(shí),此項(xiàng)必選。
| RDS |
StorageType | string | 否 | 該參數(shù)暫未開(kāi)放使用。 | 無(wú) |
FromApp | string | 否 | 用于備注請(qǐng)求來(lái)源,默認(rèn)值為 OpenAPI,無(wú)需手動(dòng)設(shè)置。 | OpenAPI |
ClientToken | string | 否 | 輸入任意字符串,用于保證請(qǐng)求冪等性。 | KJSAHKJFHKJSHFKASHFKJADFHKDXXXX |
ResourceGroupId | string | 否 | 資源組 ID。 | rg-aekzecovzti**** |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"HttpStatusCode": 200,
"RequestId": "7BCF6D62-885F-5A4A-91A1-679760E7****",
"ErrCode": "Param.NotFound",
"Success": true,
"ErrMessage": "The specified parameter %s value is not valid.",
"BackupPlanId": "dbsrhahrsu2****",
"OrderId": "21437345592****"
}
錯(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)容概要 | 操作 |
---|