文档首页> 云数据库 GaussDB(for MySQL)> API参考> API（推荐）> 数据库代理> 开启或关闭新增节点自动加入该Proxy
更新时间：2024-02-27 GMT+08:00
在线调试
CLI示例
查看PDF

开启或关闭新增节点自动加入该Proxy

功能介绍

开启或关闭新增节点自动加入该Proxy。

接口约束

该接口目前公测阶段，如需使用，请提交工单联系客服人员申请权限。

URI

POST /v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/new-node-auto-add

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的project ID。

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

instance_id

是

String

实例ID，严格匹配UUID规则。

proxy_id

是

String

数据库代理ID，严格匹配UUID规则。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

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

X-Language

否

String

请求语言类型。默认en-us。

取值范围：

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

参数

是否必选

参数类型

描述

switch_status

是

String

是否开启新增节点自动加入该Proxy。

取值范围：

  • ON：开启。
  • OFF：关闭。

weight

否

Integer

新增节点的读权重：

  • 新增节点自动加入为ON，取值为0~1000。
  • 新增节点自动加入为OFF，则可不输入读权重。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

result

String

开启或关闭新增节点自动加入该Proxy的操作结果。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

开启新增节点自动加入该Proxy。

POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/e73893ef73754465a8bd2e0857bbf13ein07/proxy/e87088f0b6a345e79db19d57c41fde15po01/new-node-auto-add
{
  "switch_status" : "ON",
  "weight" : 100
}

响应示例

状态码： 200

Success.

{
  "result" : "success"
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 数据库代理