DescribeOpenBackupSet - 获取用于线下恢复的备份集信息 - 云原生数据库 PolarDB

开放商业备份集的实例拓扑信息和下载链接，满足线下恢复云上实例的需要。

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
polardbx:DescribeOpenBackupSet	get	*PolarDBXInstance `acs:polardbx:{#regionId}:{#accountId}:polardbxinstance/{#PolarDBXInstanceId}`	无	无

请求参数

名称	类型	必填	描述	示例值
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}"
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-10-22	新增 OpenAPI	查看变更详情