文档首页/ 云数据库 GeminiDB/ API参考/ API v3（推荐）/ 实例管理/ 支持节点的开关机 - StartingorStoppingaNode
更新时间：2025-11-27 GMT+08:00
查看PDF
分享

支持节点的开关机 - StartingorStoppingaNode

功能介绍

当底层故障导致节点无法正常工作时，可以对该节点执行关机操作，关机后会由其他节点接管业务。

接口约束

该接口支持如下数据库实例：

  • GeminiDB Redis

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbfornosql:instance:switchNodeStatus

    Write

    -

    -

    nosql:instance:switchNodeStatus

    -

URI

PUT /v3/{project_id}/instances/{instance_id}/nodes

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一region下的project ID。获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表3 请求Body参数

参数

是否必选

参数类型

描述

action

是

String

参数解释：

操作类型。

约束限制：

不涉及。

取值范围：

shutdown： 表示关机。

startup： 表示开机。

默认取值：

不涉及。

node_ids

是

Array of strings

参数解释：

节点ID列表。

约束限制：

最多10个。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码： 202

表4 响应Body参数

参数

参数类型

描述

job_id

String

参数解释：

任务ID。

取值范围：

不涉及。

请求示例

PUT https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/b31f6915c8be45e38958eac14e96a5d2in12/nodes 
 
{ 
  "action" : "shutdown", 
  "node_ids" : [ "d96eaf85e4b44b2aa800dcf2a5981711no12", "e76f07fb1dae420791af867fc2ac4c35no12" ] 
}

响应示例

状态码： 202

Success.

{ 
  "job_id" : "e20eae83-1e77-4d58-8d92-c195e6372b0b" 
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 实例管理