全部產品
Search

搜尋本產品

    Data Management：ModifyBackupSetDownloadRules

    文件中心

    Data Management：ModifyBackupSetDownloadRules

    更新時間：Jun 26, 2026

    該介面用於開啟、修改、關閉自動下載功能。

    介面說明

    使用本介面前請先確認備份資料是否儲存在 DBS 的內建 OSS 上，您可透過呼叫 DescribeBackupPlanList 介面查看 BackupStorageType 取值情況。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    dbs:ModifyBackupSetDownloadRules

    update

    *BackupPlan

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

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    BackupPlanId

    string

    是

    備份計畫 ID，可透過呼叫 DescribeBackupPlanList 介面查看。

    dbstooi01xxxx
    OpenAutoDownload

    boolean

    否

    是否開啟自動下載，預設 false。

    false
    BackupGatewayId

    integer

    否

    備份集下載備份閘道 ID。

    23312323
    FullDataFormat

    string

    否

    備份集下載全量資料格式：

    • Native

    • SQL

    • CSV

    • JSON

    說明

    預設 CSV。

    CSV
    IncrementDataFormat

    string

    否

    備份集下載增量資料格式：

    • Native

    • SQL

    • CSV

    • JSON

    說明

    預設 Native。

    Native
    BackupSetDownloadDir

    string

    否

    備份集下載伺服器目錄。

    test
    BackupSetDownloadTargetType

    string

    否

    備份集下載目標類型。

    說明

    預設 agent：已安裝備份閘道，目前僅此項。

    agent
    BackupSetDownloadTargetTypeLocation

    string

    否

    備份集下載目標目錄類型，如果是開啟自動下載，則必填，取值：

    • local

    • nas

    • ftp

    • minio

    說明

    預設為 local。

    local
    ClientToken

    string

    否

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

    ETnLKlblzczshOTUbOCzxxxxxxx

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    HttpStatusCode

    integer

    HTTP 狀態碼。

    200
    RequestId

    string

    請求 ID。

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

    string

    錯誤碼。

    Param.NotFound
    Success

    boolean

    是否成功。

    true
    ErrMessage

    string

    錯誤資訊。

    The specified parameter %s value is not valid.

    BackupPlanId

    string

    備份計畫 ID。

    dbstooi01exxxx

    樣本

    正常返回樣本

    JSON格式

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

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    403 Request.Forbidden Have no Permissions

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

    變更歷史

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