文档首页> 云数据库 GaussDB(for MySQL)> API参考> API（推荐）> 数据库代理> 开关数据库代理SSL
更新时间：2023-12-20 GMT+08:00
在线调试
CLI示例
查看PDF

开关数据库代理SSL

功能介绍

为数据库代理设置SSL数据加密。

URI

PUT /v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/ssl

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的project ID。

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

instance_id

是

String

租户在某一project下的实例ID。

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

参数

是否必选

参数类型

描述

ssl_option

是

Boolean

SSL数据加密开关设置。

取值范围：

  • true: 开启SSL数据加密。
  • false: 关闭SSL数据加密。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

job_id

String

任务ID。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

开关SSL数据加密示例。

PUT https://{endpoint}/v3/056538411200d4cd2f79c003c7606412/instances/096c0fc43e804757b59946b80dc27f8bin07/proxyId/2ec617ba62da4eafb921b69438beed3cpo01/ssl

{
  "ssl_option" : true
}

响应示例

状态码： 200

Success.

{
  "job_id" : "e0fbbfc8-1ac4-4721-b9e9-7dd685c5bdd7"
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

父主题： 数据库代理