查询RDS实例下的备份任务列表(已下线)
更新时间 2025-09-11 11:32:24
最近更新时间: 2025-09-11 11:32:24
接口功能介绍
查询RDS实例下的备份任务列表
接口约束
无
URI
GET /RDS2/v1/open-api/describe-backup-tasks
路径参数 无
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参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
project-id | 否 | String | 项目id | b829cb71308746a094853c21d5aac0a1 | |
inst-id | 否 | String | 实例id (和参数outerProdInstId保持一致) | 264729201196525109 | |
regionId | 是 | String | 资源池regionId,比如实例在资源池A,则需要填写A资源池的regionId。 | 81f7728662dd11ec810800155d307d5b |
请求体body参数 无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回码 | 0 | |
message | String | 返回消息 | ||
returnObj | Array of Objects | 返回对象 | returnObj | |
error | String | 错误码。当接口失败时才返回具体错误编码,成功不返回或者为空 | MYSQL_10002 | |
表 returnObj |
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
pageNum | Integer | 当前页 | 1 | |
pageSize | Integer | 每页的数量 | 1 | |
size | Integer | 当前页的数量 | 0 | |
startRow | Integer | 当前页面第一个元素在数据库中的行号 | 0 | |
endRow | Integer | 当前页面最后一个元素在数据库中的行号 | 0 | |
total | Integer | 总记录数 | 1 | |
pages | Integer | 总页数 | 1 | |
firstPage | Integer | 第一页 | 1 | |
prePage | Integer | 前一页 | 1 | |
isFirstPage | Boolean | 是否为第一页 | ||
isLastPage | Boolean | 是否为最后一页 | ||
hasPreviousPage | Boolean | 是否有前一页 | ||
hasNextPage | Boolean | 是否有下一页 | ||
navigatePages | Integer | 导航页码数 | 1 | |
navigatepageNums | Array of Integers | 所有导航页号 | ||
list | Array of Objects | 结果集(每页显示的数据) | list | |
表 list |
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
backupType | String | full表示全量备份,incremental表示增量备份,binlog表示binlog备份,table表示单表恢复,instance表示数据库实例恢复 | 3 | |
backupName | String | 备份名称 | backup-test | |
errorcode | String | 0代表没有开始,1代表参数不对,2代表执行过程中,3代表成功,4代表被停止,5代表执行失败 | 3 | |
history | String | 备份过程 | [set_20816063011]connect to StoreHost;[set_20816063011]connect to DbHost ;[set_20816063011]run innobackup ;[set_20816063011]backup OK | |
fromLsn | String | 备份开始的lsn | 20461233 | |
toLsn | String | 备份返回的最新lsn | 20461263 | |
gtidLastChange | String | 备份最后的gtid列表 | 8a7b2c6e-2dd1-11ed-84b8-fa163e7406c4:1-40 | |
createTime | Long | 创建或修改时间 | 1663059318000 |
枚举参数
无
请求示例
请求url
GET /v1/open-api/describe-backup-tasks?outerProdInstId=3&backupName=backup-test
请求头header
无
请求体body
无
响应示例
{
"statusCode": 0,
"message": "success",
"returnObj": {
"lastPage": 1,
"navigatepageNums": [
1
],
"startRow": 1,
"hasNextPage": false,
"prePage": 0,
"nextPage": 0,
"endRow": 1,
"pageSize": 10,
"list": [
{
"gtidLastChange": "8a7b2c6e-2dd1-11ed-84b8-fa163e7406c4: 1-40",
"createTime": 1663059318000,
"toLsn": "20461263",
"history": "
[
set_20816063011
]
connect to StoreHost|
[
set_20816063011
]
connect to DbHost|
[
set_20816063011
]
run innobackup|
[
set_20816063011
]
backup OK",
"backupName": "backup-test",
"errorcode": 3,
"backupType": "full",
"fromLsn": "20461233"
}
],
"pageNum": 1,
"navigatePages": 8,
"total": 1,
"pages": 1,
"firstPage": 1,
"size": 1,
"isLastPage": true,
"hasPreviousPage": false,
"isFirstPage": true
}
}
状态码
请参考 状态码
错误码
请参考 错误码