切换实例主备节点v2
更新时间 2026-03-30 16:13:20
最近更新时间: 2026-03-30 16:13:20
接口功能介绍
切换文档数据库集群实例中的主备节点
接口约束
实例运行正常
URI
POST /DDS2/v2/openApi/switchoverInstHA
路径参数 无
Query参数 无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| project-id | 否 | String | 项目id | 0 | |
| regionId | 是 | String | 资源池id | bb9fdb42056f11eda1610242ac110002 |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 文档数据库对外的实例标识，需为副本集或者分片集群实例 | 60d420bffb394************************* | |
| resId | 是 | String | 机器id | 14258 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 响应码 取值范围：800为成功，900为失败 | 800 | |
| message | String | 响应信息 | 切换文档数据库实例中的主备节点成功 | |
| returnObj | Object | 返回对象 | returnObj | |
| error | String | 错误码。当接口失败时才返回具体错误编码，成功不返回或者为空。 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| taskId | String | 任务id信息 | 16 |
枚举参数
无
请求示例
请求url
无
请求头header
project-id=0
regionId=bb9fdb42056f11eda1610242ac110002
请求体body
{
"prodInstId":"60d420bffb394*************************",
"resId":"14258"
}
响应示例
{
"statusCode": 800,
"message": "切换文档数据库实例中的主备节点成功",
"returnObj": {"taskId":"18649"}
}
状态码
请参考 状态码
错误码
请参考 错误码
