全部產品
Search
文件中心

PolarDB:DescribeBackupSetList

更新時間:Sep 10, 2026

呼叫 DescribeBackupSetList 介面檢視備份集清單。

調試

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

調試

授權資訊

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

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

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

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

polardbx:DescribeBackupSetList

none

*全部資源。

*

無 無

請求參數

名稱

類型

必填

描述

樣本值

RegionId

string

是

執行個體所屬地域的 ID。

cn-hangzhou

DBInstanceName

string

是

執行個體名稱。

pxc-xxxxxx

StartTime

integer

否

開始時間的時間戳記,單位為毫秒。

1635707845000

EndTime

integer

否

結束時間的時間戳記,單位為毫秒。

1635707845000

PageSize

integer

否

每頁的資料大小。

30

PageNumber

integer

否

分頁下標,從 1 開始。

1

DestCrossRegion

string

否

備份集所在的地域,指定後可傳回某個具體地域的備份集,一次僅支援指定一個地域。

cn-hangzhou

返回參數

名稱

類型

描述

樣本值

object

Message

string

傳回資訊,成功為 success,錯誤則傳回錯誤碼。

success

RequestId

string

請求 ID。

1A6D328C-84B8-40DC-BF49-6C73984D7494

Success

boolean

請求是否成功。

true

Data

array<object>

資料結構體。

object

EndTime

integer

備份結束時間。

1635706960956

Status

integer

備份集狀態:

  • 0:備份中;

  • 1:備份成功;

  • 2:備份失敗。

1

BackupSetSize

integer

備份集大小,單位為位元組。

88803195

BackupSetId

string

備份集 ID。

111

BackupType

integer

備份類型:

  • 0:快速備份;

  • 1:一致性備份。

1

BeginTime

integer

備份開始時間。

1635706960956

BackupModel

integer

備份模式:

  • 0:自動備份;

  • 1:手動備份。

0

樣本

正常返回樣本

JSON格式

{
  "Message": "success",
  "RequestId": "1A6D328C-84B8-40DC-BF49-6C73984D7494",
  "Success": true,
  "Data": [
    {
      "EndTime": 1635706960956,
      "Status": 1,
      "BackupSetSize": 88803195,
      "BackupSetId": "111",
      "BackupType": 1,
      "BeginTime": 1635706960956,
      "BackupModel": 0
    }
  ]
}

錯誤碼

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

變更歷史

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