开启数据库代理
URI
POST /v3/{project_id}/instances/{instance_id}/proxy
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户在某一Region下的project ID。 获取方法请参见获取项目ID。 |
instance_id |
是 |
String |
实例ID,严格匹配UUID规则。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 |
X-Language |
否 |
String |
请求语言类型。默认en-us。 取值范围:
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
flavor_ref |
是 |
String |
代理规格码。 |
node_num |
是 |
Integer |
数据库代理节点数,取值整数2-16。 |
proxy_name |
否 |
String |
代理实例名称。 用于表示实例的名称,同一租户下,同类型的实例名可重名。 取值范围:最小为4个字符,最大为64个字符且不超过64个字节(注意:一个中文字符占用3个字节),必须以字母或中文开头,区分大小写,可以包含字母、数字、中划线、下划线或中文,不能包含其他特殊字符。 |
proxy_mode |
否 |
String |
代理实例类型。默认类型为readwrite。
|
route_mode |
否 |
Integer |
数据库代理路由模式,默认为0,权重负载模式。 取值范围:
|
nodes_read_weight |
否 |
Array of NodesWeight objects |
数据库节点的读权重设置。 在proxy_mode为readonly时,只能为只读节点选择权重。 |
subnet_id |
否 |
String |
数据库VPC下的子网ID。 |
new_node_auto_add_status |
否 |
String |
是否开启新增节点自动加入该Proxy。如果需要设置是否开启新增节点自动加入该Proxy,请联系客服人员添加白名单,加入白名单后,方可输入该字段。 取值范围:
|
new_node_weight |
否 |
Integer |
新增节点的读权重:
|
响应参数
状态码: 201
参数 |
参数类型 |
描述 |
---|---|---|
job_id |
String |
任务ID。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
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" }
状态码
请参见状态码。
错误码
请参见错误码。