全部產品
Search
文件中心

PolarDB:DescribeSharedBackups - 查詢共用備份組列表

更新時間:May 20, 2026

查詢共用備份組列表。

調試

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

調試

授權資訊

當前API暫無授權資訊透出。

請求文法

POST  HTTP/1.1

請求參數

名稱

類型

必填

描述

樣本值

RegionId

string

地區 ID。

說明

您可以調用 DescribeRegions 介面查看目標帳號下的可用地區資訊,包括地區 ID。

cn-hangzhou

DBClusterId

string

叢集 ID。

pc-**************

BackupId

string

備份組 ID。

111111111

ShareType

string

共用類型:

  • ShareIncoming:共用給我。

  • ShareOutgoing:我的共用。

ShareIncoming

PageSize

integer

每頁記錄數,取值範圍:30 ~ 100,預設值為 30

30

PageNumber

integer

取值範圍為大於 0 但不超過 Integer 最大值的整數,預設值為 1

1

DBType

string

資料庫類型,取值範圍如下:

  • MySQL

  • PostgreSQL

  • Oracle

多個類型間用英文逗號隔開。

MySQL,PostgreSQL,Oracle

DBVersion

string

資料庫版本。

8.0

返回參數

名稱

類型

描述

樣本值

object

Schema of Response

TotalRecordCount

string

總記錄數

16

PageRecordCount

string

本頁記錄數。

1

RequestId

string

請求 ID。

3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF

PageNumber

string

頁碼。

1

Items

array<object>

共用備份組列表。

object

共用備份組基本資料。

BackupSetSize

string

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

4639948800

ConsistentTime

string

一致性快照的時間點,格式為 Unix 時間戳記,單位為秒。

1589253947

BackupStatus

string

備份狀態,取值範圍如下:

  • Success:備份完成

  • Failed:備份失敗

Success

BackupType

string

備份類型,僅支援全量備份,取值固定為 FullBackup

FullBackup

BackupStartTime

string

本次備份開始時間(UTC 時間)。

2020-11-15T07:30:05Z

BackupEndTime

string

本次備份結束時間(UTC 時間)。

2020-05-12T03:25:55Z

BackupId

string

備份組 ID。

111111111

DBClusterId

string

叢集 ID。

pc-****************

BackupsLevel

string

備份組層級,取值範圍如下:

  • Level-1:一級備份

  • Level-2:二級備份

Level-2

BackupMode

string

備份模式,取值範圍如下:

  • Automated:系統自動備份

  • Manual:手動備份

Manual

BackupMethod

string

資料備份方法,僅支援快照備份,取值固定為 Snapshot

Snapshot

DBType

string

資料庫引擎類型。

MySQL

DBVersion

string

資料庫引擎版本。

5.6

ShareType

string

共用類型。

ShareIncoming

PayType

string

付費類型,取值範圍如下:

  • Postpaid:隨用隨付。

  • Prepaid:預付費(訂用帳戶)。

Postpaid

ServerlessType

string

Serverless 類型。返回 AgileServerless 表示當前叢集是 Serverless 叢集,返回空值表示當前叢集是普通叢集。

AgileServerless

RegionId

string

地區 ID。

cn-hongzhou

SharerUID

string

共用方 UID。

170*************

樣本

正常返回樣本

JSON格式

{
  "TotalRecordCount": "16",
  "PageRecordCount": "1",
  "RequestId": "3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF",
  "PageNumber": "1",
  "Items": [
    {
      "BackupSetSize": "4639948800",
      "ConsistentTime": "1589253947",
      "BackupStatus": "Success",
      "BackupType": "FullBackup",
      "BackupStartTime": "2020-11-15T07:30:05Z",
      "BackupEndTime": "2020-05-12T03:25:55Z",
      "BackupId": "111111111",
      "DBClusterId": "pc-****************",
      "BackupsLevel": "Level-2",
      "BackupMode": "Manual",
      "BackupMethod": "Snapshot",
      "DBType": "MySQL",
      "DBVersion": "5.6",
      "ShareType": "ShareIncoming",
      "PayType": "Postpaid",
      "ServerlessType": "AgileServerless",
      "RegionId": "cn-hongzhou",
      "SharerUID": "170*************"
    }
  ]
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情