获取可恢复的实例
更新时间 2025-09-18 11:13:22
最近更新时间: 2025-09-18 11:13:22
接口功能介绍
获取可恢复的实例
接口约束
实例正常
URI
GET /RDS2/v2/open-api/recovery/listtoberecovery
路径参数 无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
aimAt | 是 | String | source/dest表示恢复的源实例/目标实例 | source | |
srcOuterProdInstId | 否 | String | 如果是aimAt='dest',需要填写srcOuterProdInstId | 64185b0c4d3e425bbac1fef9723fbbe8 |
请求参数
请求头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 | Object | 返回结果 | dataObj | |
error | String | 错误码。当接口失败时才返回具体错误编码,成功不返回或者为空 | MYSQL_10001 | |
表 dataObj |
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
data | Array of Objects | 返回对象 | dataList | |
表 dataList |
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
prodInstId | Integer | 内部实例ID | 1 | |
outerProdInstId | String | 实例ID | b829cb713087460800155d307d5b | |
prodInstName | String | 实例名字 | test | |
prodDbEngine | String | 实例版本 | 5.7 |
枚举参数
无
请求示例
请求url
/RDS2/v2/open-api/recovery/listtoberecovery?aimAt=source
请求头header
无
请求体body
无
响应示例
{
"returnObj":{
"data":[
{
"outerProdInstId":"8759730b48a7462f89869b4af7e77183",
"prodInstName":"test",
"prodDbEngine":"8.0",
"prodInstId":5284,
}
]
},
"statusCode":0,
"message":"success"
}
状态码
请参考 状态码
错误码
请参考 错误码