更新时间：2025-10-14 GMT+08:00
分片节点主备切换
调试
您可以在API Explorer中调试该接口。
URI
POST /v3/{project_id}/instances/{instance_id}/switch-shard
|
名称 |
是否必选 |
说明 |
|---|---|---|
|
project_id |
是 |
参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 |
|
instance_id |
是 |
参数解释： 实例ID，此参数是用户创建实例的唯一标识。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为36个字符。 默认取值： 不涉及。 |
请求参数
|
名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
shards |
是 |
Array |
参数解释： 节点列表，支持对单个或者多个DN分片做主备切换。节点信息为将要升主的备DN分片对应的节点ID(node_id)和组件ID(component_id)。具体请参考表3。 约束限制： 长度最大为1000。 |
|
名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
node_id |
是 |
String |
参数解释： 将要升主的备DN的节点ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
component_id |
是 |
String |
参数解释： 将要升主的备DN的组件ID。组件ID通过查询实例的组件列表获取。 约束限制： 不涉及。 取值范围： 最大长度7个字符，不能为null或者空字符串，不能为空格，校验和使用之前会自动过滤掉前后空格。至少包含大写字母（A-Z），小写字母（a-z），数字（0-9），非字母数字字符（限定为_）四类字符中的三类字符。 默认取值： 不涉及。 |
响应参数
|
名称 |
参数类型 |
说明 |
|---|---|---|
|
job_id |
String |
参数解释： 分片节点主备切换的任务ID。 取值范围： 不涉及。 |
请求示例
切换多个DN分片的主备。
POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0c8243400d37468bb4aed3cc94c2911d/instances/f9b5f9b296ec6808e067in14/switch-shard
{
"shards": [
{
"node_id": "0bc478b4d132494a8f7b804da521b4b2no14",
"component_id": "dn_6001"
},
{
"node_id": "53dee94c50574d36a0060db0a6b644f6no14",
"component_id": "dn_6004"
}
]
}
响应示例
分片节点主备切换成功。
{
"job_id": "e96bbb23-e053-4bd0-b0b7-16ad3f5d9b6d"
}
状态码
- 正常
- 异常
请参见状态码。
错误码
请参见错误码。
父主题： 实例管理
