文档首页/ 分布式缓存服务 DCS/ API参考/ API V2（推荐）/ 实例管理/ 指定实例节点启停开关
更新时间：2024-12-16 GMT+08:00
在线调试
CLI示例
查看PDF
分享

指定实例节点启停开关

功能介绍

实例节点启停。执行节点关机操作前的24小时内，需要对实例（单机实例除外）进行数据备份。

调用方法

请参见如何调用API。

URI

PUT /v2/{project_id}/instances/{instance_id}/nodes/status

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。获取方法请参见获取项目ID。

instance_id

是

String

实例ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

node_ids

否

Array of strings

实例需要启停的节点ID列表。未配置该参数时，默认启停实例全部节点。

action

否

String

对实例节点的操作：

start：开启节点

stop：关闭节点

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

job_id

String

实例节点启停的任务ID。

状态码： 400

表4 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

error_code

String

错误码。

error_ext_msg

String

扩展错误信息（暂未使用，赋值为null）。

状态码： 401

表5 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

error_code

String

错误码。

error_ext_msg

String

扩展错误信息（暂未使用，赋值为null）。

状态码： 403

表6 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

error_code

String

错误码。

error_ext_msg

String

扩展错误信息（暂未使用，赋值为null）。

状态码： 404

表7 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

error_code

String

错误码。

error_ext_msg

String

扩展错误信息（暂未使用，赋值为null）。

状态码： 405

表8 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

error_code

String

错误码。

error_ext_msg

String

扩展错误信息（暂未使用，赋值为null）。

状态码： 500

表9 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

error_code

String

错误码。

error_ext_msg

String

扩展错误信息（暂未使用，赋值为null）。

请求示例

PUT https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/nodes/status

{
  "action" : "start",
  "node_ids" : [ "3e803f66-fbb0-47ad-b6cb-fb87f5bed4aa", "3eaaff66-fbb0-47ad-b6cb-fb87f5b12fbb" ]
}

响应示例

状态码： 200

实例节点启停任务下发成功。

{
  "job_id" : "8abfa7aa88ad5aa50188aef7ec0936d1"
}

状态码： 405

当前请求不被允许。

{
  "error_code" : "DCS.2001",
  "error_msg" : "the latest backup records over 24h old, need to create new backup file."
}

状态码

状态码

描述

200

实例节点启停任务下发成功。

400

非法请求。

401

认证信息非法。

403

请求被拒绝访问。

404

所请求的资源不存在。

405

当前请求不被允许。

500

内部服务错误。

错误码

请参见错误码。

父主题： 实例管理

相关文档