全部產品
Search

搜尋本產品

    Data Management：DescribeFullBackupList - 查看全量備份工作清單

    文件中心

    Data Management：DescribeFullBackupList - 查看全量備份工作清單

    更新時間：Apr 25, 2026

    該介面用於查看DBS全量備份工作清單。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    dbs:DescribeFullBackupList

    get

    *BackupPlan

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

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    BackupPlanId

    string

    是

    備份計劃 ID。

    dbsr179qz******
    PageSize

    integer

    否

    每頁的記錄數，取值：

    • 30

    • 50

    • 100

    預設為 30。

    30
    PageNum

    integer

    否

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

    1
    ClientToken

    string

    否

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

    ETnLKlblzczshOTUbOCzxxxxxxx
    ShowStorageType

    boolean

    否

    是否顯示儲存類型。

    true
    BackupSetId

    string

    否

    備份組 ID。

    1iukx5h******
    StartTimestamp

    integer

    否

    開始備份時間。

    1676887100
    EndTimestamp

    integer

    否

    結束備份時間。

    1676887128
    ShowProgress

    string

    否

    是否展示備份進度

    true
    BackupSetStatus

    string

    否

    備份組狀態

    finish

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    返回參數詳情如下。

    HttpStatusCode

    integer

    HTTP 狀態代碼。

    200
    PageNum

    integer

    頁碼。

    1
    RequestId

    string

    請求 ID。

    636BC118-6080-4119-A6B5-C199CEC1037D
    ErrCode

    string

    錯誤碼。

    Param.NotFound
    Success

    boolean

    是否執行成功。傳回值：

    • true：執行成功。

    • false：執行失敗。

    true
    ErrMessage

    string

    錯誤資訊。

    The specified parameter %s value is not valid.

    TotalPages

    integer

    總頁數。

    1
    TotalElements

    integer

    總全量備份任務數。

    1
    PageSize

    integer

    每頁的記錄數。

    10
    Items

    object

    FullBackupFile

    array<object>

    全量備份任務詳情。

    object

    全量備份任務詳情。

    FinishTime

    integer

    任務結束時間戳記。

    1676887128000
    BackupStatus

    string

    備份任務狀態，取值：

    • schedule：初始化中

    • running：運行中

    • finish：完成

    • stop：失敗

    • pause：暫停

    finish
    SourceEndpointIpPort

    string

    資料庫連接地址。

    121.XXX.XXX.144:3306
    CreateTime

    integer

    任務開始時間戳。

    1676886947000
    ErrMessage

    string

    錯誤資訊。

    NULL
    BackupObjects

    string

    備份對象。

    [{\"DBName\":\"test\"}]
    EndTime

    integer

    備份結束時間戳記。

    1676887128000
    StartTime

    integer

    備份開始時間。

    1676887100000
    BackupSetExpiredTime

    integer

    備份組保留到期時間戳記。

    1677491900000
    StorageMethod

    string

    儲存類型，取值：

    • Standard：標準儲存

    • IA：低頻訪問儲存

    • Archive：Archive Storage

    • UNKNOWN：未知，通常是任務未完成時的狀態

    Standard
    BackupSetId

    string

    備份組 ID。

    1iukx5h******
    BackupSize

    integer

    備份大小。

    580
    SourceEndpointInstanceType

    string

    備份來源資料庫執行個體類型

    rds
    SourceEndpointInstanceId

    string

    備份來源資料庫執行個體 Id

    rm-testxx
    SourceEndpointRegion

    string

    備份來源資料庫所在地區

    cn-beijing
    SourceEndpointHost

    string

    備份來源資料庫串連地址

    127.0.0.1
    StorageEncryptMethod

    string

    備份儲存加密方式

    encrypted
    CrossRoleName

    string

    跨帳號備份 RAM 角色名稱

    ram-for-dbs
    CrossAliyunId

    string

    跨帳號備份阿里雲 Id

    2xxx7778xxxxxxxxxx
    SourceEndpointEnableSsl

    string

    備份來源資料庫是否開啟 SSL 安全連線

    true
    LogicalStructureBackupProgress

    integer

    邏輯備份結構備份進度

    100
    LogicalFullBackupProgress

    integer

    邏輯備份全量備份進度

    100
    BackupGatewayIdentifier

    string

    備份網關唯一標識碼

    TESTGATEWAY
    SourceEndpointUserName

    string

    備份來源資料庫帳號

    dbs_backup
    SourceEndpointPort

    string

    備份來源資料庫連接埠

    3306

    樣本

    正常返回樣本

    JSON格式

    {
  "HttpStatusCode": 200,
  "PageNum": 1,
  "RequestId": "636BC118-6080-4119-A6B5-C199CEC1037D",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.     ",
  "TotalPages": 1,
  "TotalElements": 1,
  "PageSize": 10,
  "Items": {
    "FullBackupFile": [
      {
        "FinishTime": 1676887128000,
        "BackupStatus": "finish",
        "SourceEndpointIpPort": "121.XXX.XXX.144:3306",
        "CreateTime": 1676886947000,
        "ErrMessage": "NULL",
        "BackupObjects": "[{\\\"DBName\\\":\\\"test\\\"}]",
        "EndTime": 1676887128000,
        "StartTime": 1676887100000,
        "BackupSetExpiredTime": 1677491900000,
        "StorageMethod": "Standard",
        "BackupSetId": "1iukx5h******",
        "BackupSize": 580,
        "SourceEndpointInstanceType": "rds",
        "SourceEndpointInstanceId": "rm-testxx",
        "SourceEndpointRegion": "cn-beijing",
        "SourceEndpointHost": "127.0.0.1",
        "StorageEncryptMethod": "encrypted",
        "CrossRoleName": "ram-for-dbs",
        "CrossAliyunId": "2xxx7778xxxxxxxxxx",
        "SourceEndpointEnableSsl": "true",
        "LogicalStructureBackupProgress": 100,
        "LogicalFullBackupProgress": 100,
        "BackupGatewayIdentifier": "TESTGATEWAY",
        "SourceEndpointUserName": "dbs_backup",
        "SourceEndpointPort": "3306"
      }
    ]
  }
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

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

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

    變更歷史

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