全部產品
Search
文件中心

Data Management:ModifyBackupObjects - 修改備份對象

更新時間:Jan 13, 2026

該介面用於修改一個DBS備份計劃的備份對象。

調試

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

調試

授權資訊

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

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

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dbs:ModifyBackupObjects

update

*全部資源

*

請求參數

名稱

類型

必填

描述

樣本值

BackupPlanId

string

備份計劃 ID。

dbs1h****usfa

BackupObjects

string

BackupObjects 的定義格式為 JSON 字串,定義如下:

[
    {
        "DBName":"待備份庫名",
        "SchemaName":"待備份 Schema 名",
        "TableIncludes":[{
        	"TableName":"待備份表表名"
        }],
        "TableExcludes":[{
            "TableName":"待備份庫名不需要備份表的表名"
        }]
    }
]
  • 當使用者只配置了DBName,不配置其他子物件的規則,那麼表示遷移這個資料庫下面的所有對象。

  • 當使用者配置了DBName,且配置了部分對象的規則,那麼不配置的對象預設不遷移。各種對象名的定義可以支援如下的Regex:
    • 點號.:表示匹配除\r\n之外的任何單個字元。

    • 星號*:表示匹配前面子運算式任意次,h*llo匹配 hlloheeeello等字串。

    • 問號?:表示匹配前面子運算式零次或 1 次,h.?llo匹配hllohello,但不能匹配haello

    • 字元集合[characters]:表示匹配方括弧內任意一個字元,例如h[aello]匹配hallohello

    • 負值字元集合[^characters]:表示不匹配方括弧內任意一個字元,例如h[^ae]llo匹配hcllohdllo,但是不能匹配hallohello

    • 字元範圍[character1-character2]:表示 character1-character2範圍內的字元都可以匹配,例如 [0-9][a-z]

說明

SchemaNameNewSchemaName只用於 MSSQL,其他資料庫的庫名定義使用 DBNameNewDBName參數。

[ { "DBName":"17xxx92xxxx374", "SchemaName":"gy9xnj8xxxxxx", "TableIncludes":[{ "TableName":"test1" }], "TableExcludes":[{ "TableName":"test2" }] } ]

ClientToken

string

用於保證請求的等冪性,防止重複提交請求。

ETnLKlblzczshOTUbOCzxxxxxxx

返回參數

名稱

類型

描述

樣本值

object

返回參數詳情如下。

HttpStatusCode

integer

HTTP 狀態代碼。

200

RequestId

string

請求 ID。

D6E068C3-25BC-455A-85FE-45F0B22ECB1F

ErrCode

string

錯誤碼。

InvalidParameter

Success

boolean

請求是否成功,傳回值如下:

  • true:請求成功。

  • false:請求失敗。

true

ErrMessage

string

錯誤資訊。

The specified parameter %s value is not valid.

BackupPlanId

string

備份計劃 ID。

dbs1h****usfa

NeedPrecheck

boolean

本次修改是否會觸發預檢查,如果為 true 則需要再調用 StartBackupPlan 介面啟動備份計劃。

true

樣本

正常返回樣本

JSON格式

{
  "HttpStatusCode": 200,
  "RequestId": "D6E068C3-25BC-455A-85FE-45F0B22ECB1F",
  "ErrCode": "InvalidParameter",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid. ",
  "BackupPlanId": "dbs1h****usfa",
  "NeedPrecheck": true
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

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

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

變更歷史

更多資訊,參考變更詳情