文档首页/ 云数据库 GaussDB/ API参考/ API(推荐)/ 实例管理/ 绑定/解绑弹性公网IP - BindingorUnbindinganEIP
更新时间:2026-07-07 GMT+08:00
分享

绑定/解绑弹性公网IP - BindingorUnbindinganEIP

功能介绍

实例下的节点绑定弹性公网IP/解绑弹性公网IP。

调试

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

URI

POST /v3/{project_id}/instances/{instance_id}/nodes/{node_id}/public-ip

表1 参数说明

名称

是否必选

参数类型

说明

project_id

String

参数解释:

租户在某一Region下的项目ID。

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

约束限制:

不涉及。

取值范围:

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

默认取值

不涉及。

instance_id

String

参数解释:

实例ID,此参数是用户创建实例的唯一标识。请参考查询数据库实例列表 - QueryingDBInstances接口获取实例ID。

约束限制:

不涉及。

取值范围:

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

默认取值

不涉及。

node_id

String

参数解释:

节点ID。请参考查询实例的组件列表 - QueryingtheComponentsofaDBInstance获取节点ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。

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

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值

不涉及。

X-Language

String

参数解释:

语言。

约束限制:

不涉及。

取值范围:

  • zh-cn:中文
  • en-us:英文

默认取值

en-us

表3 参数说明

参数

是否必选

参数类型

描述

action

String

参数解释:

操作标识。

约束限制

不涉及。

取值范围

  • BIND,表示绑定弹性公网IP。
  • UNBIND,表示解绑弹性公网IP。

默认取值

不涉及。

public_ip

String

参数解释

弹性公网IP。

请参考“查询弹性公网IP列表”获取响应参数中的“private_ip_address”。

约束限制

不涉及。

取值范围

IPv4格式。

默认取值

不涉及。

public_ip_id

String

参数解释

弹性公网IP的ID。

请参考“查询弹性公网IP列表”获取响应参数中的“id”。

约束限制

不涉及。

取值范围

UUID格式。

默认取值

不涉及。

响应参数

表4 参数说明

名称

参数类型

说明

job_id

String

参数解释:

工作流ID。

取值范围:

不涉及。

请求示例

  • 为GaussDB实例绑定弹性公网IP。
    POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/nodes/0bc478b4d132494a8f7b804da521b4b2no14/public-ip
    {
        "action": "BIND",
        "public_ip": "10.154.218.161",
        "public_ip_id": "45da4782-e0c8-4aa4-a290-b8740014f710"
    }
  • 为GaussDB实例解绑弹性公网IP。
    POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/nodes/0bc478b4d132494a8f7b804da521b4b2no14/public-ip
    {
        "action": "UNBIND",
        "public_ip": "10.154.218.161",
        "public_ip_id": "45da4782-e0c8-4aa4-a290-b8740014f710"
    }

响应示例

绑定/解绑弹性公网IP成功。
{
	"job_id": "2b414788a6004883a02390e2eb0ea227"
}

状态码

错误码

请参见错误码

相关文档