更新时间:2025-07-29 GMT+08:00

开启数据库代理

功能介绍

开启数据库代理,只支持ELB模式。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

租户在某一Region下的project ID。

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

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

instance_id

String

参数解释

实例ID,此参数是实例的唯一标识。

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,后缀为in07,长度为36个字符。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

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

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

X-Language

String

参数解释

请求语言类型。

约束限制

不涉及。

取值范围

  • en-us

  • zh-cn

默认取值

en-us。

表3 请求Body参数

参数

是否必选

参数类型

描述

flavor_ref

String

参数解释

数据库代理规格码。

约束限制

不涉及。

取值范围

获取方法请参见查询数据库代理规格信息返回的spec_code字段。

默认取值

不涉及。

node_num

Integer

参数解释

数据库代理节点数。

约束限制

不涉及。

取值范围

2-16。

默认取值

不涉及。

proxy_name

String

参数解释

数据库代理名称。

约束限制

同一租户下,同类型的实例名可重名。

取值范围

最小为4个字符,最大为64个字符且不超过64个字节,必须以字母开头,区分大小写,可以包含字母、数字、中划线、下划线,不能包含其他特殊字符。

默认取值

不涉及。

proxy_mode

String

参数解释

数据库代理类型。

约束限制

不涉及。

取值范围

  • readwrite:读写。

  • readonly:只读。

默认取值

readwrite。

route_mode

Integer

参数解释

数据库代理路由模式。

约束限制

不涉及。

取值范围:

  • 0:表示权重负载模式。

  • 1:表示负载均衡模式(数据库主节点不接受读请求)。

  • 2:表示负载均衡模式(数据库主节点接受读请求)。

默认取值

0。

nodes_read_weight

Array of NodesWeight objects

参数解释

数据库节点的读权重设置。

约束限制

在proxy_mode为readonly时,只能为只读节点选择权重。

subnet_id

String

参数解释

子网的网络ID,获取方法如下:

  • 方法1:登录虚拟私有云服务的控制台界面,单击VPC下的子网,进入子网详情页面,查找网络ID。

  • 方法2:通过虚拟私有云服务的API接口查询,具体操作可参考查询子网列表

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

new_node_auto_add_status

String

参数解释:

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

约束限制

不涉及。

取值范围

  • ON:开启。

  • OFF:关闭。

默认取值

OFF。

new_node_weight

Integer

参数解释

新增节点的读权重。

约束限制

在new_node_auto_add_status参数为ON时为必选字段。

取值范围

  • 如果路由模式为0,新增节点自动加入为ON,取值为0~1000。

  • 如果路由模式不为0或新增节点自动加入为OFF,则可不输入读权重。

默认取值

不涉及。

表4 NodesWeight

参数

是否必选

参数类型

描述

id

String

参数解释

数据库节点ID。

约束限制

节点ID需要属于对应的实例。

取值范围

只能由英文字母、数字组成,前面为UUID,后缀为no07,长度为36个字符。

默认取值:

不涉及。

weight

Integer

参数解释

节点权重。

约束限制

不涉及。

取值范围

  • 路由模式为0:取值为0~1000。

  • 路由模式为1:数据库主节点取值为0,只读节点取值为0或1。

  • 路由模式为2:数据库主节点取值为1,只读节点取值为0或1。

响应参数

状态码: 201

表5 响应Body参数

参数

参数类型

描述

job_id

String

参数解释

任务ID。

取值范围

不涉及。

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码: 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

开启数据库代理,代理实例规格2U8GB,代理模式只读模式。

POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/43e4feaab48f11e89039fa163ebaa7e4br01/proxy
{
  "flavor_ref" : "gaussdb.proxy.large.x86.2",
  "node_num" : 2,
  "proxy_name" : "gaussdb-proxy",
  "proxy_mode" : "readonly",
  "route_mode" : 0,
  "nodes_read_weight" : [ {
    "id" : "45021bf73a244312a3f2af95092feeecno07",
    "weight" : 50
  }, {
    "id" : "d78a65690cea4af5ad14585e110ff89bno07",
    "weight" : 400
  } ],
  "subnet_id" : "6991d82d-9166-4aff-a1fa-d2a8748b7084"
}

响应示例

状态码: 201

Success.

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

状态码

请参见状态码

错误码

请参见错误码