文档首页> 云数据库 GaussDB(for MySQL)> API参考> API（推荐）> 数据库代理> 扩容数据库代理节点的数量
更新时间：2023-10-23 GMT+08:00
在线调试
CLI示例
查看PDF

扩容数据库代理节点的数量

功能介绍

扩容数据库代理节点的数量。

URI

POST /v3/{project_id}/instances/{instance_id}/proxy/enlarge

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的project ID。

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

instance_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参数

参数

是否必选

参数类型

描述

node_num

是

Integer

代理实例节点扩容操作需要扩容的节点数。

本次扩容的节点数的取值范围：1~30之间的整数。

限制条件：该实例的代理实例节点的总数量小于等于32。

proxy_id

否

String

数据库代理实例ID。

  • 如果实例只开启了一个代理，该参数非必选。
  • 如果实例开启了多个代理，该参数必选，必须指定需要扩容节点的代理实例ID。

响应参数

状态码： 201

表4 响应Body参数

参数

参数类型

描述

job_id

String

任务ID。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

扩容数据库代理节点。

POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/61a4ea66210545909d74a05c27a7179ein07/proxy/enlarge
{
  "node_num" : 2,
  "proxy_id" : "151c14381ac14ecfb9703a745b992677po01"
}

响应示例

状态码： 201

Success.

{
  "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890"
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 数据库代理