接口功能介绍
查询RDS实例备份集列表。
接口约束
无
URI
GET /v1/open-api/backup
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
outerProdInstId | 是 | String | 实例ID | 562b89493b1a40e1b97ea05e50dd8170 | |
pageNow | 否 | Integer | 慢查询当前页 | ||
pageSize | 否 | Integer | 页面记录数 | ||
startTime | 否 | String | 备份开始时间 | yyyy-MM-dd HH:mm:ss | |
endTime | 否 | String | 备份结束时间 | yyyy-MM-dd HH:mm:ss | |
backupName | 否 | String | 备份名称 | ||
selectType | 否 | Integer | 查询类别, 1表示自动备份, 2表示手工备份, 3表示实例恢复 4查询所有备份 | ||
backupType | 否 | String | 备份类别 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Integer | 返回码 | 0 | |
message | 是 | String | 返回消息 | ||
returnObj | 是 | Object | 返回对象 | returnObj |
表 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
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
prodOrderStatus | 是 | Integer | 订单状态 | 0 | |
prodInstFlag | 是 | String | 实例标签 | 41-Rds-5228 | |
description | 是 | String | 描述 | xxx | |
ymdhi | 否 | String | 时间 | ||
usessl | 是 | String | 是否开启ssl | true | |
backupType | 是 | String | full表示全量备份,incremental表示增量备份,binlog表示binlog备份,table表示单表恢复,instance表示数据库实例恢复 | ||
endpoint | 是 | String | 节点 | ||
engine | 是 | String | 引擎版本 | 8.0 | |
storeUser | 是 | String | 备份存储所使用用户 | teledb | |
bucketname | 否 | String | bucket名称 | ||
vpcId | 是 | String | VPC的Id | 303c73a2-5d10-5faf | |
host | 是 | String | 主机IP | 10.244.162.244 | |
prodInstSetName | 是 | String | 备份的set名字 | set_si_1611663011 | |
storeIp | 是 | String | 存储主机ip | 10.244.162.244 | |
startTime | 是 | Date | 开始时间 | 1658295860000 | |
toLsn | 否 | String | 备份到的LSN | ||
id | 是 | Integer | 记录id | 492 | |
binlogEndTime | 否 | Date | 最后binlog的时间 | 1658295860000 | |
usezos | 是 | Integer | 是否使用对象存储 | 0 | |
errorcode | 是 | TinyInt | 0代表没有开始,1代表参数不对,2代表执行过程中,3代表成功,4代表被停止,5代表执行失败 | ||
prodInstName | 是 | String | 实例名称 | ||
isValid | 是 | Byte | 是否有效 | ||
secretKey | 是 | String | 密钥 | 0uYGFG7mOjdT0 | |
storePassword | 否 | String | 密码 | xxx | |
s3ObjectSize | 是 | String | 对象存储的大小 | --- | |
s3ObjectName | 是 | String | 对象存储名称 | ||
history | 是 | String | 备份历史信息 | [set_si_161] connect to StoreHost | |
datalen | 是 | String | 备份数据大小 | ||
s3Bucket | 是 | String | 对象存储bucket名称 | Rds-test1113-bucket | |
fromLsn | 是 | String | 最开始binlog的时间 | ||
gtidLastChange | 是 | String | 最后记录修改的GTID | ||
storePath | 是 | String | 备份路径 | ||
outerProdInstId | 是 | String | 实例ID | ||
ctype | 是 | String | 类型,manual手动,auto自动 | manual | |
accessKey | 是 | String | 访问密钥 | FK8Z6BOA31SA30MLYK | |
createTime | 是 | Date | 创建时间 | 1658295860000 | |
port | 是 | String | 端口 | 6301 | |
ProdInstId | 是 | Integer | 内部实例Id | 41 | |
endTime | 是 | Date | 结束时间 | 1658295860000 | |
backupName | 是 | String | 备份名称 |
请求示例
请求头header
无
请求体body
无
响应示例
{
"statusCode": 0,
"message": "success",
"returnObj": {
"lastPage": 1,
"navigatepageNums": [1],
"startRow": 1,
"hasNextPage": false,
"prePage": 0,
"nextPage": 0,
"endRow": 2,
"pageSize": 10,
"list": [{
"prodOrderStatus": 0,
"storePassword": null,
"prodInstFlag": "41-Rds-5228",
"description": "",
"ymdhi": null,
"usessl": "true",
"backupType": "full",
"endpoint": "http://10.114.199.57",
"engine": "8.0",
"storeUser": "teledb",
"bucketname": null,
"vpcId": "303c73a2-5d10-4faf-a098-8525b904c2a6",
"host": "10.224.161.16",
"prodInstSetName": "set_si_1611663011",
"storeIp": "10.224.162.244",
"startTime": 1658295860000,
"toLsn": null,
"id": 492,
"binlogEndTime": null,
"usezos": 0,
"errorcode": 3,
"prodInstName": "Rds-5228",
"secretKey": "0uYGfG7mOjdT0fJ56SmUXjo1BL0IrGK3g4X5ZS",
"s3ObjectSize": "---",
"isValid": null,
"s3ObjectName": "2021-07-15_16-34-18.tar.gz",
"history": "[set_si_1611663011]connect to StoreHost|[set_si_1611663011]connect to DbHost|[set_si_1611663011]run innobackup|[set_si_1611663011]backup OK",
"datalen": "3.4MB",
"s3Bucket": "Rds-test1113-bucket",
"fromLsn": null,
"gtidLastChange": null,
"storePath": "/data/set_si_1611663011/10.224.161.16_6301/backup_0000000001/2022-07-20_13-44-20.xbstream",
"outerProdInstId": "85f8a8ac81544230b4e0fc15d750784e",
"ctype": "manual",
"accessKey": "FK8Z6BOA31SA30MLYK",
"createTime": 1658295888000,
"port": "6301",
"prodInstId": 41,
"endTime": 1658295866000,
"backupName": "test1_backup"
}],
"pageNum": 1,
"navigatePages": 8,
"total": 2,
"pages": 1,
"firstPage": 1,
"size": 2,
"isLastPage": true,
"hasPreviousPage": false,
"isFirstPage": true
}
}
状态码
状态码 | 描述 |
---|---|
0 | 请求响应成功 |
错误码
错误码 | 描述 |
---|---|
2001 | 参数异常,失败原因见message |
3001 | 业务异常,失败原因见message |
5001 | 请求响应失败,失败原因见message |