接口功能介绍
查询已删除实例的备份集列表,即已退订未被回收的实例的备份集列表。
接口约束
无
URI
GET /v1/open-api/describe-detached-backups
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
outerProdInstId | 是 | String | 主机实例id | 3 | |
backupName | 否 | String | 备份名称 | backup-test | |
selectType | 否 | Integer | 查询类别, 1表示自动备份, 2表示手工备份, 3表示实例恢复 4查询所有备份 | 1 | |
backupType | 否 | String | 备份类别 | full | |
startTime | 否 | String | 备份开始时间 yyyy-MM-dd HH:mm:ss | 2022-09-16 17:50:08 | |
endTime | 否 | String | 备份结束时间 yyyy-MM-dd HH:mm:ss | 2022-09-16 17:50:10 | |
pageNow | 否 | Integer | 当前页 | 1 | |
pageSize | 否 | Integer | 单页记录条数 | 10 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Integer | 返回码 | 0 | |
message | 是 | String | 返回消息 | ||
returnObj | 是 | Array of Objects | 返回对象 | backupReconveryList |
表 returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
pageNum | 是 | Integer | 当前页 | 1 | |
pageSize | 是 | Integer | 每页的数量 | 1 | |
size | 是 | Integer | 当前页的数量 | 0 | |
startRow | 是 | Integer | 当前页面第一个元素在数据库中的行号 | 0 | |
endRow | 是 | Integer | 当前页面最后一个元素在数据库中的行号 | 0 | |
total | 是 | Integer | 总记录数 | ||
pages | 是 | Integer | 总页数 | ||
firstPage | 是 | Integer | 第一页 | ||
prePage | 是 | Integer | 前一页 | ||
isFirstPage | 是 | Boolean | 是否为第一页 | ||
isLastPage | 是 | Boolean | 是否为最后一页 | ||
hasPreviousPage | 是 | Boolean | 是否有前一页 | ||
hasNextPage | 是 | Boolean | 是否有下一页 | ||
navigatePages | 是 | Integer | 导航页码数 | ||
navigatepageNums | 是 | Array of Integer | 所有导航页号 | ||
list | 是 | Array of Objects | 结果集(每页显示的数据 | T |
表T
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
prodInstName | 是 | String | 实例名称 | set_2016063011 | |
backupName | 是 | String | 备份名称 | backup-test | |
backupType | 是 | String | full表示全量备份,incremental表示增量备份,binlog表示binlog备份,table表示单表恢复,instance表示数据库实例恢复 | full | |
startTime | 是 | Date | 开始时间 | 1662998413000 | |
endTime | 是 | Date | 结束时间 | 1662998414000 | |
ctype | 是 | String | 备份类型 | auto | |
errorcode | 是 | TinyInt | 0代表没有开始,1代表参数不对,2代表执行过程中,3代表成功,4代表被停止,5代表执行失败 | 3 | |
datalen | 是 | String | 备份数据大小 | 3.1MB | |
storePath | 是 | String | 备份路径 | /data/xxx.xbstream | |
usezos | 是 | Integer | 是否使用对象存储 | 1 |
请求示例
请求头header参数
无
请求体body参数
无
响应示例
{
"statusCode": 0,
"message": "success",
"returnObj": {
"navigatepageNums": [
1
],
"startRow": 0,
"hasNextPage": false,
"prePage": 0,
"nextPage": 0,
"endRow": 1,
"pageSize": 2,
"list": [
{
"storePath": "",
"prodInstName": "ONLY_FOR_DAS1",
"ctype": "auto",
"startTime": 1668739287000,
"endTime": 1668739287000,
"usezos": 0,
"backupName": "",
"datalen": "---",
"errorcode": 5,
"backupType": "full"
},
{
"storePath": "/data/set_si_20414663011/172.31.204.146_6301/backup_0000000012",
"prodInstName": "ONLY_FOR_DAS1",
"ctype": "auto",
"startTime": 1668182453000,
"endTime": 1668182453000,
"usezos": 0,
"backupName": "ONLY_FOR_DAS1_202211120000",
"datalen": "---",
"errorcode": 5,
"backupType": "full"
}
],
"pageNum": 1,
"navigatePages": 8,
"navigateFirstPage": 1,
"total": 2,
"pages": 1,
"size": 2,
"isLastPage": true,
"hasPreviousPage": false,
"navigateLastPage": 1,
"isFirstPage": true
}
}
状态码
状态码 | 描述 |
---|---|
0 | 请求响应成功 |
错误码
错误码 | 描述 |
---|---|
2001 | 参数异常,失败原因见message |
3001 | 业务异常,失败原因见message |
5001 | 请求响应失败,失败原因见message |