云数据库 TAURUSDB-开启数据库代理:请求参数

时间:2024-12-11 17:00:11

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

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

X-Language

String

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

取值范围:

  • en-us

  • zh-cn

表3 请求Body参数

参数

是否必选

参数类型

描述

flavor_ref

String

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

node_num

Integer

数据库代理节点数,取值整数2-16。

proxy_name

String

数据库代理名称。用于表示实例的名称,同一租户下,同类型的实例名可重名。

取值范围:最小为4个字符,最大为64个字符且不超过64个字节(注意:一个中文字符占用3个字节),必须以字母或中文开头,区分大小写,可以包含字母、数字、中划线、下划线或中文,不能包含其他特殊字符。

proxy_mode

String

数据库代理类型。默认类型为readwrite。

route_mode

Integer

数据库代理路由模式,默认为0,权重负载模式。

取值范围:

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

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

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

nodes_read_weight

Array of NodesWeight objects

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

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

subnet_id

String

数据库VPC下的子网ID。

new_node_auto_add_status

String

是否开启新增节点自动加入该Proxy。如果需要设置是否开启新增节点自动加入该Proxy,请联系客服人员添加白名单,加入白名单后,方可输入该字段。加入白名单后,默认值为OFF。

取值范围:

  • ON:开启。

  • OFF:关闭。

new_node_weight

Integer

新增节点的读权重,在new_node_auto_add_status参数为ON时为必选字段:

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

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

表4 NodesWeight

参数

是否必选

参数类型

描述

id

String

数据库节点ID。

weight

Integer

权重:

  • 如果路由模式为0,取值为0~1000。

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

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

support.huaweicloud.com/api-gaussdbformysql/CreateGaussMySqlProxy.html