文档首页/ 云数据库 TaurusDB/ API参考/ API(推荐)/ 数据库代理/ 为数据库代理绑定或解绑弹性公网IP
更新时间:2025-10-11 GMT+08:00

为数据库代理绑定或解绑弹性公网IP

功能介绍

为数据库代理绑定或解绑弹性公网IP。

接口约束

该接口目前公测阶段,如需使用,请提交工单联系客服人员申请权限。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

租户在某一Region下的project ID。

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

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

instance_id

String

参数解释

实例ID,严格匹配UUID规则。

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

proxy_id

String

参数解释

数据库代理ID,严格匹配UUID规则。

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,后缀为po01,长度为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参数

参数

是否必选

参数类型

描述

public_ip

String

参数解释

待绑定的弹性公网IP地址。

约束限制

符合IP规则。

取值范围

不涉及。

默认取值

不涉及。

public_ip_id

String

参数解释

弹性公网IP地址对应的ID。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

bind

String

参数解释

绑定或解绑弹性公网IP。

约束限制

不涉及。

取值范围

  • true:绑定弹性公网IP。

  • false:解绑弹性公网IP。

默认取值

不涉及。

响应参数

状态码: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

错误消息。

请求示例

  • 为数据库代理绑定弹性公网IP。

    POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/e73893ef73754465a8bd2e0857bbf13ein07/proxy/e87088f0b6a345e79db19d57c41fde15po01/bind
    
    {
      "public_ip" : "xxx.xxx.xxx.xxx",
      "public_ip_id" : "8403e9cd-a7fa-4288-8b15-c7ceac1etest",
      "bind" : "true"
    }
  • 解绑数据库代理的弹性公网IP。

    POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/e73893ef73754465a8bd2e0857bbf13ein07/proxy/e87088f0b6a345e79db19d57c41fde15po01/bind
    
    {
      "public_ip" : "xxx.xxx.xxx.xxx",
      "bind" : "false"
    }

响应示例

状态码:200

Success.

{
  "result" : "success"
}

状态码

请参见状态码

错误码

请参见错误码