DescribeOpenBackupSet_云原生数据库 PolarDB(PolarDB)-阿里云帮助中心

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeOpenBackupSet	系统规定参数。取值：DescribeOpenBackupSet。
RegionId	String	否	cn-hangzhou	实例所属地域ID。
DBInstanceName	String	是	pxc-********	实例名称。
RestoreTime	String	否	2024-10-14T00:00:00Z	实例所需恢复的时间点，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

返回数据

名称	类型	示例值	描述
RequestId	String	FEA5DC20-6D8A-5979-97AA-FC57546ADC20	请求ID。
Data	Any	{"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}	一个包含实例拓扑信息和备份集下载链接的结构体。说明 canBinlogRecoverToTimeUTC 字段表示该备份集所能恢复到的时间点，该时间点在输入参数RestoreTime附近。由于存在DN有最近的本地binlog还没上传的情况，不保证能恢复到所希望的时间点。

说明 PolarDB-X开源版的备份集导入工具将使用Data字段中结构体，把备份集导入成开源版恢复所需要的结构。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeOpenBackupSet
&RegionId=cn-hangzhou
&DBInstanceName=pxc-********
&RestoreTime=2024-10-14T00:00:00Z
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeOpenBackupSetResponse>
    <RequestId>FEA5DC20-6D8A-5979-97AA-FC57546ADC20</RequestId>
    <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}</Data>
</DescribeOpenBackupSetResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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}"
}

错误码

访问错误中心查看更多错误码。