Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Instance Management/ Binding or Unbinding an EIP
Updated on 2024-08-20 GMT+08:00
View PDF
Share

Binding or Unbinding an EIP

Function

This API is used to bind an EIP to an instance node or unbind an EIP from an instance node. Before calling this API:

URI

POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/nodes/{node_id}/public-ip
Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Explanation:

Project ID of a tenant in a region.

For details about how to obtain the project ID, see Obtaining a Project ID.

Restrictions:

None

Value range:

The value can contain 32 characters. Only letters and digits are allowed.

Default value:

None

instance_id

Yes

Instance ID.

node_id

Yes

Node ID.

Request Parameters

Table 2 Parameter description

Parameter

Mandatory

Type

Description

action

Yes

String

Operation identifier. Value:

  • BIND: An EIP is bound.
  • UNBIND: An EIP is unbound.

public_ip

Yes

String

EIP.

public_ip_id

Yes

String

EIP ID.

Response Parameters

Table 3 Parameter description

Parameter

Type

Description

job_id

String

Job ID.

Example Request

  • Binding an EIP to a GaussDB instance 
    POST https://gaussdb-opengauss.ap-southeast-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"
}
  • Unbinding an EIP from a GaussDB instance 
    POST https://gaussdb-opengauss.ap-southeast-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"
}

Example Response

EIP bounded or unbounded. 
{
	"job_id": "2b414788a6004883a02390e2eb0ea227"
}

Status Code

Error Code

For details, see Error Codes.

Parent topic: Instance Management