文档首页/ 云数据库 GaussDB/ API参考/ API（推荐）/ 实例管理/ 停止实例/节点
更新时间：2024-11-01 GMT+08:00
查看PDF
分享

停止实例/节点

功能介绍

停止数据库,同时支持节点级别的停止操作。

调试

您可以在API Explorer中调试该接口。

URI

POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/db-stop

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的项目ID。

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

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

instance_id

是

String

需要停止的实例的ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

否

String

语言。

缺省值：en-us

枚举值：

  • zh-cn
  • en-us
表3 请求Body参数

参数

是否必选

参数类型

描述

node_ids

是

Array of strings

需要停止的节点的ID，取值不能为null，如果为空列表，则停止整个实例。

响应参数

表4 参数说明

参数

参数类型

描述

job_id

String

停止实例或节点的异步任务ID。
表5 参数说明

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

停止实例且开启透明事务。

POST https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/d8e6ca5a624745bcb546a227aa3ae1cfin14/db-stop
{  
  "node_ids":  ["187ff420e15c467eaaef226154eb1578no14","4ed9cbb0d61144e0802a82c0ab0e1de5no14"]
}

响应示例

停止实例成功。

{ 
   "job_id" : "bf26cf3c-d046-4080-bb45-f114be7afa5f" 
 }

状态码

错误码

请参见错误码。

父主题： 实例管理

相关文档