全部產品
Search

搜尋本產品

    Data Management：CreateBackupPlan - 建立備份計劃

    文件中心

    Data Management：CreateBackupPlan - 建立備份計劃

    更新時間：Jan 13, 2026

    該介面用於建立一個DBS備份計劃。

    介面說明

    本介面對應的控制台操作，請參見購買備份計劃。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    dbs:CreateBackupPlan

    create

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    Region

    string

    否

    DBS 地區，該參數為必填項，可通過 DescribeRegions 查看 DBS 支援地區。

    說明

    更多詳情資訊，請參見服務存取點。

    cn-hangzhou
    InstanceClass

    string

    是

    規格，取值如下：

    • micro：入門型

    • small：低配型

    • medium：中配型

    • large：高配型

    • xlarge：高配型（無資料傳輸量上限）

    說明

    規格越高，備份與恢複的效能越高，更多資訊，請參見規格說明。

    micro
    DatabaseType

    string

    是

    資料庫類型，取值如下：

    • MySQL

    • MSSQL

    • Oracle

    • MariaDB

    • PostgreSQL

    • DRDS

    • MongoDB

    • Redis

    MySQL
    BackupMethod

    string

    是

    備份方式，取值如下：

    • logical：邏輯備份

    • physical：物理備份

    logical
    Period

    string

    否

    指定預付費執行個體為包年或者包月類型，取值如下：

    • Year：包年

    • Month：包月

    Month
    UsedTime

    integer

    否

    指定購買時間長度，取值如下：

    • 當參數 Period 為 Year 時，UsedTime 取值為 1~5。

    • 當參數 Period 為 Month 時，UsedTime 取值為 1~11。

    1
    PayType

    string

    否

    支付方式，取值如下：

    prepay：預付費（訂用帳戶）

    prepay
    DatabaseRegion

    string

    否

    資料庫地區。

    cn-hangzhou
    StorageRegion

    string

    否

    儲存地區。

    cn-hangzhou
    InstanceType

    string

    否

    資料庫執行個體類型，取值如下：

    • RDS

    • PolarDB

    • DDS：阿里雲 MongoDB

    • Kvstore：阿里雲 Redis

    • Other：通過 IP:Port 接入的資料庫

    • dg：無公網 IP:Port 的自建資料庫（通過資料庫網關 DG 接入）

    RDS
    StorageType

    string

    否

    該參數暫未開放使用。

    無
    FromApp

    string

    否

    用於備忘請求來源，預設值為 OpenAPI，無需手動設定。

    OpenAPI
    ClientToken

    string

    否

    輸入任一字元串，用於保證請求等冪性。

    KJSAHKJFHKJSHFKASHFKJADFHKDXXXX
    ResourceGroupId

    string

    否

    資源群組 ID。

    rg-aekzecovzti****

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    傳回值詳情如下。

    HttpStatusCode

    integer

    HTTP 狀態代碼。

    200
    RequestId

    string

    請求 ID。

    7BCF6D62-885F-5A4A-91A1-679760E7****
    ErrCode

    string

    錯誤碼。

    Param.NotFound
    Success

    boolean

    請求是否成功，傳回值如下：

    • true：請求成功

    • false：請求失敗

    true
    ErrMessage

    string

    錯誤資訊。

    The specified parameter %s value is not valid.
    BackupPlanId

    string

    備份計劃 ID。

    dbsrhahrsu2****
    OrderId

    string

    訂單 ID。

    21437345592****

    樣本

    正常返回樣本

    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****"
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    403 Request.Forbidden Have no Permissions 當前操作未被授權，請聯絡主帳號在RAM控制台進行授權後再執行操作

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

    變更歷史

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