全部產品
Search
文件中心

AnalyticDB:DescribeBackups - 查詢備份組列表

更新時間:Jan 14, 2026

查詢執行個體備份組

介面說明

當前服務的接入地址請參見服務存取點

調試

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

調試

授權資訊

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

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

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

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

adb:DescribeBackups

get

*DBClusterLakeVersion

acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

請求參數

名稱

類型

必填

描述

樣本值

DBClusterId

string

湖倉版叢集 ID。

說明

您可以調用 DescribeDBClusters 介面查看目標地區下所有叢集的叢集 ID。

am-bp18934i73vb5****

BackupId

string

備份組 ID。

1679758862

StartTime

string

查詢開始時間,格式:yyyy-MM-ddTHH:mmZ。

2011-06-01T16:00Z

EndTime

string

查詢結束時間,需要大於查詢開始時間,格式:yyyy-MM-ddTHH:mmZ。

2023-02-20T02:30Z

PageSize

integer

每頁記錄數,取值:

  • 30;

  • 50;

  • 100

預設值:30。

30

PageNumber

integer

頁碼,取值:大於 0 且不超過 整數資料類型最大值的正整數。預設值:1。

1

Remote

boolean

是否僅查詢跨地區備份。取值為 true 時,僅查詢跨地區備份。取值為 false 時,僅查詢本地備份。

false

返回參數

名稱

類型

描述

樣本值

object

TotalCount

string

總記錄數。

300

PageSize

string

本頁備份組個數。

30

RequestId

string

請求 ID。

CE17270B-F8F8-5A31-9DB4-DADDFDAD7940

PageNumber

string

頁碼。

1

FreeBackupSize

integer

備份組免費大小,單位:Byte。

0

TotalBackupSize

integer

總備份組大小,單位:Byte。

64953700

Items

object

Backup

array<object>

備份組列表。

object

DBClusterId

string

湖倉版叢集 ID。

am-bp11q28kvl688****

BackupType

string

備份類型。取值說明:

  • FullBackup:全量備份。

  • IncrementalBackup:增量備份。

FullBackup

BackupStartTime

string

備份開始時間。

2022-06-01T16:00Z

BackupSize

integer

備份檔案大小,單位:Byte。

2167808

BackupEndTime

string

備份結束時間。

2022-06-02T16:00Z

BackupExpiredTime

string

備份組到期時間。

2022-07-02T16:00Z

BackupId

string

備份組 ID。

32732****

BackupMethod

string

備份方法。只支援快照備份(Snapshot)。

Snapshot

BackupRegion

string

跨地區備份所在地區。

cn-hangzhou

ParentBackupId

string

跨地區備份所關聯的本地備份組 ID

32733****

BackupStatus

string

備份的狀態。取值如下:

  • Running:備份進行中中。

  • Finished:備份已完成。

Finished

樣本

正常返回樣本

JSON格式

{
  "TotalCount": "300",
  "PageSize": "30",
  "RequestId": "CE17270B-F8F8-5A31-9DB4-DADDFDAD7940",
  "PageNumber": "1",
  "FreeBackupSize": 0,
  "TotalBackupSize": 64953700,
  "Items": {
    "Backup": [
      {
        "DBClusterId": "am-bp11q28kvl688****",
        "BackupType": "FullBackup",
        "BackupStartTime": "2022-06-01T16:00Z",
        "BackupSize": 2167808,
        "BackupEndTime": "2022-06-02T16:00Z",
        "BackupExpiredTime": "2022-07-02T16:00Z\n",
        "BackupId": "32732****",
        "BackupMethod": "Snapshot",
        "BackupRegion": "cn-hangzhou",
        "ParentBackupId": "32733****",
        "BackupStatus": "Finished"
      }
    ]
  }
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 您指定的 DBClusterId 不存在,請確認 DBClusterId 值是否正確。

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

變更歷史

更多資訊,參考變更詳情