文档首页/ 云数据库 GaussDB(for MySQL)/ API参考/ API（即将下线）/ 数据库代理/ 开启数据库代理
更新时间：2024-05-31 GMT+08:00
查看PDF
分享

开启数据库代理

功能介绍

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

该接口计划于2025-03-31下线，建议及时切换到新接口开启数据库代理。

调试

您可以在API Explorer中调试该接口。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一region下的project ID。

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

instance_id

是

String

实例ID

请求参数

表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

代理规格码。

获取方法请参见查询数据库代理规格信息

node_num

是

Integer

代理实例节点数，取值整数2-32。

响应参数

状态码： 202

表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}/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances/43e4feaab48f11e89039fa163ebaa7e4br01/proxy

{
  "flavor_ref" : "gaussdb.mysql.large.x86.4",
  "node_num" : 2
}

响应示例

状态码： 202

Success.

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

状态码

状态码

描述

202

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

父主题： 数据库代理

相关文档