全部產品
Search
文件中心

PolarDB:DescribeOpenBackupSet

更新時間:Sep 10, 2026

開放商業備份集的實例拓撲資訊和下載連結,滿足線下恢復雲上實例的需要。

調試

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

調試

授權資訊

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

請求參數

名稱

類型

必填

描述

樣本值

RegionId

string

否

實例所屬地域 ID。

cn-hangzhou

DBInstanceName

string

是

實例名稱。

pxc-********

RestoreTime

string

否

實例所需恢復的時間點,格式為 yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。

2024-10-14T00:00:00Z

返回參數

名稱

類型

描述

樣本值

object

Schema of Response

RequestId

string

請求 ID。

FEA5DC20-6D8A-5979-97AA-FC57546ADC20

Data

any

一個包含實例拓撲資訊和備份集下載連結的結構體。

說明

canBinlogRecoverToTimeUTC 欄位表示該備份集所能恢復到的時間點,該時間點在輸入參數 RestoreTime 附近。由於存在 DN 有最近的本地 binlog 還沒上傳的情況,不保證能恢復到所希望的時間點。

{"gmsBackupSet": {"pubFullDownloadUrl": "https://xxxxx","dnName": "pxc-xdb-m-xxxxxx","hostInstanceId": 0001,"binlogs": [],"backupEndTime": "2024-10-21T10:11:56Z","backupLinkExpiredTime": "2024-10-23T06:13:54Z","dnBackupSetId": "00088","notCompletedBinlogs": [],"commitIndex": "15249275","innerFullDownloadUrl": "http://xxxxx","backupStartTime": "2024-10-21T10:09:20Z","backupSetSize": 526118912},"dnBackupSets": [],"insName": "pxc-xxxxx","backupSetId": "cb-xxxxx","canBinlogRecoverToTime": 1729567925000,"backupEndTime": "2024-10-21T10:12:16Z","canBinlogRecoverToTimeUTC": "2024-10-22T03:32:05Z","canBackupMinRecoverToTimeUTC": "2024-10-21T10:11:56Z","pitrInvalid": false,"backupStartTime": "2024-10-21T10:09:16Z","canBackupMinRecoverToTime": 1729505516000}

說明

PolarDB-X 開源版的備份集匯入工具將使用 Data 欄位中結構體,把備份集匯入成開源版恢復所需要的結構。

樣本

正常返回樣本

JSON格式

{
  "RequestId": "FEA5DC20-6D8A-5979-97AA-FC57546ADC20",
  "Data": "{\"gmsBackupSet\": {\"pubFullDownloadUrl\": \"https://xxxxx\",\"dnName\": \"pxc-xdb-m-xxxxxx\",\"hostInstanceId\": 0001,\"binlogs\": [],\"backupEndTime\": \"2024-10-21T10:11:56Z\",\"backupLinkExpiredTime\": \"2024-10-23T06:13:54Z\",\"dnBackupSetId\": \"00088\",\"notCompletedBinlogs\": [],\"commitIndex\": \"15249275\",\"innerFullDownloadUrl\": \"http://xxxxx\",\"backupStartTime\": \"2024-10-21T10:09:20Z\",\"backupSetSize\": 526118912},\"dnBackupSets\": [],\"insName\": \"pxc-xxxxx\",\"backupSetId\": \"cb-xxxxx\",\"canBinlogRecoverToTime\": 1729567925000,\"backupEndTime\": \"2024-10-21T10:12:16Z\",\"canBinlogRecoverToTimeUTC\": \"2024-10-22T03:32:05Z\",\"canBackupMinRecoverToTimeUTC\": \"2024-10-21T10:11:56Z\",\"pitrInvalid\": false,\"backupStartTime\": \"2024-10-21T10:09:16Z\",\"canBackupMinRecoverToTime\": 1729505516000}"
}

錯誤碼

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

變更歷史

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