全部產品
Search

搜尋本產品

    Data Management：ConfigureBackupPlan - 配置備份計劃

    文件中心

    Data Management：ConfigureBackupPlan - 配置備份計劃

    更新時間：Jan 13, 2026

    該介面用於配置一個DBS備份計劃。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    dbs:ConfigureBackupPlan

    update

    *BackupPlan

    acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    BackupPlanId

    string

    是

    備份計劃 ID，可通過調用 DescribeBackupPlanList 介面擷取該參數的值。

    dbstooi0*******
    SourceEndpointInstanceType

    string

    是

    資料庫所在位置，可通過調用 DescribeBackupPlanList 介面擷取該參數的值。取值如下：

    • RDS

    • ECS

    • Express：通過專線/VPN 閘道/智能網關接入的資料庫

    • Agent：通過備份網關接入的資料庫

    • DDS：雲 MongoDB

    • Other：通過 IP:Port 直連的資料庫

    RDS
    SourceEndpointRegion

    string

    否

    資料庫地區，可通過調用 DescribeBackupPlanList 介面擷取該參數的值。

    說明

    SourceEndpointInstanceType 為 RDS、ECS、DDS、Express、Agent 時，該參數必傳。

    cn-hangzhou
    SourceEndpointInstanceID

    string

    否

    資料庫執行個體 ID，可通過調用 DescribeBackupPlanList 介面擷取該參數的值。

    說明

    SourceEndpoint.InstanceType 為 RDS、ECS、DDS、Express 時，該參數必傳。

    rm-uf6wjk5*********
    SourceEndpointIP

    string

    否

    資料庫連接地址，可通過調用 DescribeBackupPlanList 介面擷取該參數的值。

    說明

    SourceEndpointInstanceType 為 express、agent、other 時，該參數必傳。

    rm-uf6wjk5*******.mysql.rds.aliyuncs.com
    SourceEndpointPort

    integer

    否

    資料庫連接埠，可通過調用 DescribeBackupPlanList 介面擷取該參數的值。

    說明

    SourceEndpoint.InstanceType 為 express、agent、other、ECS 時，該參數必傳。

    3306
    SourceEndpointDatabaseName

    string

    否

    資料庫名稱，可通過調用 DescribeBackupPlanList 介面擷取該參數的值。

    說明

    資料庫類型為 PostgreSQL、MongoDB 時，該參數必傳。

    testRDS
    SourceEndpointUserName

    string

    否

    資料庫帳號。

    說明

    資料庫類型為 Redis，或者資料庫所在位置為 agent 且資料庫類型為SQL Server時該參數非必須，其他情境均必傳。

    testRDS
    SourceEndpointPassword

    string

    否

    密碼。

    說明

    資料庫類型為 Redis，或者資料庫所在位置為 agent 且資料庫類型為SQL Server時該參數非必須，其他情境均必傳。

    testPassword
    BackupGatewayId

    integer

    否

    備份網關 ID，可通過調用 DescribeBackupPlanList 介面擷取該參數的值。

    說明

    SourceEndpointInstanceType 為 agent 時，該參數必傳。

    23313123312
    OSSBucketName

    string

    否

    OSS Bucket 名稱。

    說明

    系統預設自動產生新的名稱。

    TestOssBucket
    BackupObjects

    string

    否

    備份對象，可通過調用 DescribeBackupPlanList 介面擷取該參數的值。

    [ { "DBName":"待備份庫名", "SchemaName":"待備份 Schema 名", "TableIncludes":[{ "TableName":"待備份表表名" }], "TableExcludes":[{ "TableName":"待備份庫名不需要備份表的表名" }] } ]
    BackupPeriod

    string

    否

    全量備份周期，取值：

    • Monday：周一

    • Tuesday：周二

    • Wednesday：周三

    • Thursday：周四

    • Friday：周五

    • Saturday：周六

    • Sunday：周日

    Monday
    BackupStartTime

    string

    否

    全量備份開始時間，格式為HH:mmZ（UTC 時間）。可通過調用 DescribeBackupPlanList 介面擷取該參數的值。

    14:22
    EnableBackupLog

    boolean

    否

    是否開啟增量記錄備份，取值：

    • true：開啟

    • false：關閉

    true
    BackupLogIntervalSeconds

    integer

    否

    增量時間間隔，以秒（s）為單位。

    說明

    僅支援物理備份。

    1000
    BackupRetentionPeriod

    integer

    否

    備份資料保留時間，取值：0 ~ 1825，預設為 730 天。

    730
    DuplicationInfrequentAccessPeriod

    integer

    否

    轉為低頻訪問儲存時間，預設為 180 天。

    180
    DuplicationArchivePeriod

    integer

    否

    轉為歸檔冷備儲存時間，預設為 365 天。

    365
    BackupPlanName

    string

    是

    自訂備份計劃名稱，可通過調用 DescribeBackupPlanList 介面擷取該參數的值。

    dbstooi0*******
    SourceEndpointOracleSID

    string

    否

    Oracle SID 名稱。

    說明

    資料庫類型為 Oracle 時，該參數必傳。

    test
    BackupStorageType

    string

    否

    內建儲存類型：

    • 空（預設）：備份資料存放區在使用者 OSS 上。

    • system ：備份資料存放區在 DBS 的內建 OSS 上。

    無
    BackupSpeedLimit

    integer

    否

    磁碟 IO 限制 ， 單位為 KB/s。

    說明

    僅對 MySQL 物理備份生效。

    262144
    BackupRateLimit

    integer

    否

    網路頻寬節流設定， 單位為 KB/s ，最大允許 10GB。

    說明

    僅對 MySQL 物理備份生效。

    262144
    BackupStrategyType

    string

    否

    全量備份周期，取值：

    • simple：周期備份，和 BackupPeriod、BackupStartTime 配合使用。

    • manual：手動備份。

    說明

    預設為 simple。

    simple
    CrossAliyunId

    string

    否

    跨阿里雲帳號備份的 UID，可通過調用 DescribeRestoreTaskList 介面擷取該參數的值。

    2xxx7778xxxxxxxxxx
    CrossRoleName

    string

    否

    跨阿里雲帳號備份的 RAM 角色名稱，可通過調用 DescribeRestoreTaskList 介面擷取該參數的值。

    test123
    AutoStartBackup

    boolean

    否

    是否開啟自動備份。

    • true：開啟

    • false：不開啟

    false
    ClientToken

    string

    否

    用於保證請求的等冪性，防止重複提交請求。由用戶端產生該參數值，要保證在不同請求間唯一，最大值不超過 64 個 ASCII 字元，且該參數值中不能包含非 ASCII 字元。

    ETnLKlblzczshOTUbOCzxxxxxxx
    ResourceGroupId

    string

    否

    資源群組 ID。

    rg-aekzecovzti****

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    詳情資訊如下。

    HttpStatusCode

    integer

    HTTP 狀態代碼。

    200
    RequestId

    string

    請求 ID。

    F1FB49D4-B504-47F1-9F43-D7EAB33F****
    ErrCode

    string

    錯誤碼。

    Param.NotFound
    Success

    boolean

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

    • true：請求成功

    • false：請求失敗

    true
    ErrMessage

    string

    錯誤資訊。

    The specified parameter %s value is not valid.

    BackupPlanId

    string

    備份計劃 ID。

    dbstooi01ex****

    樣本

    正常返回樣本

    JSON格式

    {
  "HttpStatusCode": 200,
  "RequestId": "F1FB49D4-B504-47F1-9F43-D7EAB33F****",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.     ",
  "BackupPlanId": "dbstooi01ex****"
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

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

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

    變更歷史

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