全部產品
Search

搜尋本產品

    Data Management：DescribeBackupPlanList - 查看備份計劃

    文件中心

    Data Management：DescribeBackupPlanList - 查看備份計劃

    更新時間：Mar 19, 2026

    該介面用於查看一個DBS備份計劃。

    介面說明

    請在使用本介面前，提前開通 OSS 服務，更多資訊請參見Object Storage Service。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    dbs:DescribeBackupPlanList

    get

    *BackupPlan

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

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    BackupPlanId

    string

    否

    備份計劃 ID，支援查詢多個備份計劃，英文逗號“,”分隔。

    dbstooi01exXXXX
    Region

    string

    否

    DBS 地區，可通過調用 DescribeRegions 介面查看 DBS 支援地區。

    cn-hangzhou
    PageSize

    integer

    否

    每頁的記錄數，取值為 1~100。

    說明

    預設為 30。

    30
    PageNum

    integer

    否

    頁碼，大於等於 0 且不超過 Integer 的最大值，預設值為：0。

    1
    BackupPlanName

    string

    否

    備份計劃名稱。

    test123
    BackupPlanStatus

    string

    否

    備份計劃狀態，取值：

    • wait：未配置

    • init：未啟動（預檢查失敗）

    • running：運行中

    • stop：失敗

    • pause：暫停

    • locked：鎖定中

    • check_pass：預檢查通過

    wait
    ClientToken

    string

    否

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

    ASDASDASDSADASFCZXVZ
    ResourceGroupId

    string

    否

    資源群組 ID。

    rg-aekzecovzti****
    ShowStorageStrategyInfo

    boolean

    否

    ShowBackupStrategyInfo

    boolean

    否

    ShowRecoverTimeRange

    boolean

    否

    BackupMethod

    string

    否

    logical

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    返回參數詳情如下。

    HttpStatusCode

    integer

    HTTP 狀態代碼。

    200
    PageNum

    integer

    頁碼。

    1
    RequestId

    string

    請求 ID。

    4F1888AC-1138-4995-B9FE-D2734F61C058
    ErrCode

    string

    錯誤碼。

    InvalidParameterValid
    Success

    boolean

    是否成功。

    true
    ErrMessage

    string

    錯誤資訊。

    The specified parameter %s value is not valid.

    TotalPages

    integer

    總頁數。

    4
    TotalElements

    integer

    總備份計劃數。

    100
    PageSize

    integer

    每頁的記錄數。

    30
    Items

    object

    BackupPlanDetail

    array<object>

    備份計劃詳情。

    object

    傳回值。

    CrossRoleName

    string

    跨阿里雲帳號備份的 RAM 角色名稱。

    test123
    SourceEndpointInstanceType

    string

    資料庫所在位置，傳回值如下：

    • rds

    • ecs

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

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

    • dds：雲 MongoDB

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

    rds
    BackupSetDownloadDir

    string

    備份組下載伺服器目錄。

    */test/test123
    SourceEndpointIpPort

    string

    資料庫連接地址。

    100.*.*.10:33204
    CrossAliyunId

    string

    跨阿里雲帳號備份的 uid。

    2xxx7778xxxxxxxxxx
    DuplicationArchivePeriod

    integer

    轉為歸檔冷備儲存時間（天）。

    365
    BackupPlanId

    string

    備份計劃 ID。

    dbstooi01eXXXX
    EndTimestampForRestore

    integer

    資料庫可恢復段的結束時間，格式為時間戳記。

    1554560477000
    BackupPlanStatus

    string

    備份計劃狀態，傳回值如下：

    • wait：未配置

    • init：未啟動（預檢查失敗）

    • running：運行中

    • stop：失敗

    • pause：暫停

    • locked：鎖定中

    • check_pass：預檢查通過

    init
    BackupSetDownloadFullDataFormat

    string

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

    • Native

    • SQL

    • CSV

    • JSON

    SQL
    BackupRetentionPeriod

    integer

    備份資料保留時間，傳回值：0~1825（天）。

    365
    OSSBucketRegion

    string

    OSS Bucket 地區。

    cn-hangzhou
    SourceEndpointOracleSID

    string

    Oracle SID 名稱。

    test
    BackupStorageType

    string

    內建儲存類型，傳回值如下：

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

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

    system
    BackupMethod

    string

    備份方式，傳回值如下：

    • logical：邏輯備份

    • physical：物理備份

    • duplication：轉儲備份

    logical
    SourceEndpointRegion

    string

    資料庫地區。

    cn-hangzhou
    BackupPeriod

    string

    全量備份周期，傳回值如下：

    • Monday：周一

    • Tuesday：周二

    • Wednesday：周三

    • Thursday：周四

    • Friday：周五

    • Saturday：周六

    • Sunday：周日

    Monday
    SourceEndpointDatabaseName

    string

    資料庫名稱。

    test
    BackupSetDownloadGatewayId

    integer

    備份組下載備份網關 ID。

    123123
    BackupPlanCreateTime

    integer

    備份計劃建立時間戳記。

    1582527713000
    InstanceClass

    string

    規格，傳回值如下：

    • micro：入門型

    • small：低配型

    • medium：中配型

    • large：高配型

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

    micro
    BackupSetDownloadTargetType

    string

    備份組下載目標類型。

    說明

    唯一取值：agent，表示已安裝備份網關。

    agent
    DuplicationInfrequentAccessPeriod

    integer

    轉為低頻訪問儲存時間（天）。

    180
    BackupStartTime

    string

    全量備份開始時間，格式為 HH:mm。

    14:22
    ErrMessage

    string

    預檢查任務異常資訊。

    can not connect to oracle instance orcl with user dbs
    BackupObjects

    string

    備份對象。

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

    integer

    可資料庫恢復段的開始時間，傳回值：1554560477000。

    1554560477000
    SourceEndpointInstanceID

    string

    資料庫執行個體 ID。

    test
    OpenBackupSetAutoDownload

    boolean

    是否開啟自動備份組下載功能。

    true
    BackupPlanName

    string

    備份計劃名稱。

    dbstooi01e****
    OSSBucketName

    string

    OSS Bucket 名稱。

    dbs-backup-1857XXXXX489
    BackupGatewayId

    integer

    備份網關 ID。

    827362187368736
    SourceEndpointUserName

    string

    資料庫帳號。

    test
    BackupSetDownloadIncrementDataFormat

    string

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

    • Native

    • SQL

    • CSV

    • JSON

    SQL
    EnableBackupLog

    boolean

    是否開啟增量記錄備份，傳回值如下：

    • true：開啟

    • false：關閉

    true
    ResourceGroupId

    string

    資源群組 ID。

    rg-aekzecovzti****
    DatabaseType

    string

    資料庫類型。

    MySQL
    BackupPlanRegion

    string

    cn-beijing
    SourceEndpointHost

    string

    127.0.0.1
    InstanceChargeType

    string

    PREPAY
    InstanceExpiredTimestamp

    integer

    1764051253000
    SourceEndpointEnableSsl

    string

    true
    StorageEncryptMethod

    string

    encrypted
    SourceEndpointPort

    string

    3306
    IncrementBackupRetentionPeriod

    string

    365
    IncrementDuplicationInfrequentAccessPeriod

    string

    365
    IncrementDuplicationArchivePeriod

    string

    365
    LogBackupRetentionPeriod

    string

    365
    LogDuplicationInfrequentAccessPeriod

    string

    365
    LogDuplicationArchivePeriod

    string

    365
    BackupGatewayIdentifier

    string

    TESTGATEWAY
    EnableMysqlPhysicalBackupBinLog

    boolean

    樣本

    正常返回樣本

    JSON格式

    {
  "HttpStatusCode": 200,
  "PageNum": 1,
  "RequestId": "4F1888AC-1138-4995-B9FE-D2734F61C058",
  "ErrCode": "InvalidParameterValid",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.     ",
  "TotalPages": 4,
  "TotalElements": 100,
  "PageSize": 30,
  "Items": {
    "BackupPlanDetail": [
      {
        "CrossRoleName": "test123",
        "SourceEndpointInstanceType": "rds",
        "BackupSetDownloadDir": "*/test/test123",
        "SourceEndpointIpPort": "100.*.*.10:33204",
        "CrossAliyunId": "2xxx7778xxxxxxxxxx",
        "DuplicationArchivePeriod": 365,
        "BackupPlanId": "dbstooi01eXXXX",
        "EndTimestampForRestore": 1554560477000,
        "BackupPlanStatus": "init",
        "BackupSetDownloadFullDataFormat": "SQL",
        "BackupRetentionPeriod": 365,
        "OSSBucketRegion": "cn-hangzhou",
        "SourceEndpointOracleSID": "test",
        "BackupStorageType": "system",
        "BackupMethod": "logical",
        "SourceEndpointRegion": "cn-hangzhou",
        "BackupPeriod": "Monday",
        "SourceEndpointDatabaseName": "test",
        "BackupSetDownloadGatewayId": 123123,
        "BackupPlanCreateTime": 1582527713000,
        "InstanceClass": "micro",
        "BackupSetDownloadTargetType": "agent",
        "DuplicationInfrequentAccessPeriod": 180,
        "BackupStartTime": "14:22",
        "ErrMessage": "  can not connect to oracle instance orcl with user dbs",
        "BackupObjects": "[     {         \\\"DBName\\\":\\\"待備份庫名\\\",         \\\"SchemaName\\\":\\\"待備份 Schema 名\\\",         \\\"TableIncludes\\\":[{             \\\"TableName\\\":\\\"待備份表表名\\\"         }],         \\\"TableExcludes\\\":[{             \\\"TableName\\\":\\\"待備份庫名不需要備份表的表名\\\"         }]     } ]",
        "BeginTimestampForRestore": 1554560477000,
        "SourceEndpointInstanceID": "test",
        "OpenBackupSetAutoDownload": true,
        "BackupPlanName": "dbstooi01e****",
        "OSSBucketName": "dbs-backup-1857XXXXX489",
        "BackupGatewayId": 827362187368736,
        "SourceEndpointUserName": "test",
        "BackupSetDownloadIncrementDataFormat": "SQL",
        "EnableBackupLog": true,
        "ResourceGroupId": "rg-aekzecovzti****",
        "DatabaseType": "MySQL",
        "BackupPlanRegion": "cn-beijing",
        "SourceEndpointHost": "127.0.0.1",
        "InstanceChargeType": "PREPAY",
        "InstanceExpiredTimestamp": 1764051253000,
        "SourceEndpointEnableSsl": "true",
        "StorageEncryptMethod": "encrypted",
        "SourceEndpointPort": "3306",
        "IncrementBackupRetentionPeriod": "365",
        "IncrementDuplicationInfrequentAccessPeriod": "365",
        "IncrementDuplicationArchivePeriod": "365",
        "LogBackupRetentionPeriod": "365",
        "LogDuplicationInfrequentAccessPeriod": "365",
        "LogDuplicationArchivePeriod": "365",
        "BackupGatewayIdentifier": "TESTGATEWAY",
        "EnableMysqlPhysicalBackupBinLog": true
      }
    ]
  }
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

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

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

    變更歷史

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