Help Center/ API Gateway/ API Reference/ Dedicated Gateway APIs (V2)/ Gateway Management/ Updating or Binding an EIP to a Dedicated Gateway
Updated on 2025-12-26 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Updating or Binding an EIP to a Dedicated Gateway

Function

This API is used to bind an EIP to a dedicated gateway or update the EIP bound to a dedicated gateway (only available for LVS gateways).

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    apig:instance:bindOrChangeEip

    Write

    instance *

    • g:ResourceTag/<tag-key>

    • g:EnterpriseProjectId
    • apig:instances:update
    • apig:instance:get
    • eip:publicIps:update

URI

PUT /v2/{project_id}/apigw/instances/{instance_id}/eip

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

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

instance_id

Yes

String

Gateway ID, which can be obtained from the gateway information on the APIG console.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

eip_id

No

String

EIP ID.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

eip_id

String

EIP ID.

eip_address

String

EIP.

eip_status

String

EIP status.

  • FREEZED: The EIP is frozen.

  • BIND_ERROR: The EIP fails to be bound.

  • BINDING: The EIP is being bound.

  • PENDING_DELETE: The EIP is being released.

  • PENDING_CREATE: The EIP is being created.

  • NOTIFYING: The EIP is being created.

  • NOTIFY_DELETE: The EIP is being released.

  • PENDING_UPDATE: The EIP is being updated.

  • DOWN: The EIP has not been bound.

  • ACTIVE: The EIP has been bound.

  • ELB: The EIP has been bound to a load balancer.

  • VPN: The EIP has been bound to a VPN.

  • ERROR: The EIP is failed.

eip_ipv6_address

String

EIP (IPv6).

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

Binding an EIP to a gateway

{
  "eip_id" : "85392b45-685c-4f77-b19a-14ad875b8190"
}

Example Responses

Status code: 200

OK

{
  "eip_id" : "85392b45-685c-4f77-b19a-14ad875b8190",
  "eip_address" : "xxx.xxx.xxx.xxx",
  "eip_status" : "ACTIVE"
}

Status code: 400

Bad Request

{
  "error_code" : "APIC.7211",
  "error_msg" : "Parameter value does not match the rules, parameter name[eip_id]"
}

Status code: 401

Unauthorized

{
  "error_code" : "APIC.7102",
  "error_msg" : "Incorrect token or token resolution failed"
}

Status code: 403

Forbidden

{
  "error_code" : "APIC.7106",
  "error_msg" : "No permissions to request for the method"
}

Status code: 404

Not Found

{
  "error_code" : "APIC.7302",
  "error_msg" : "Instance not found"
}

Status code: 500

Internal Server Error

{
  "error_code" : "APIC.9000",
  "error_msg" : "Failed to request internal service"
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.

Parent topic: Gateway Management