Updated on 2026-03-16 GMT+08:00

Binding an EIP to or Unbinding an EIP from a Proxy Instance

Function

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

Learn how to authenticate it.
Obtain the required region and endpoint.

URI

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

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID, which is compliant with the UUID format. Constraints N/A Range The value contains 36 characters with a suffix of in07. Only letters and digits are allowed. Default Value N/A
proxy_id	Yes	String	Definition Proxy instance ID, which is compliant with the UUID format. Constraints N/A Range The value contains 36 characters with a suffix of po01. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Request language type. Constraints N/A Range en-us zh-cn Default Value en-us

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
public_ip	Yes	String	Definition EIP to be bound. Constraints The value must comply with the IP address rule. Range N/A Default Value N/A
public_ip_id	No	String	Definition EIP ID. Constraints N/A Range N/A Default Value N/A
bind	Yes	String	Definition Bind or unbind an EIP. Constraints N/A Range true: Bind an EIP. false: Unbind an EIP. Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameter
Parameter	Type	Description
job_id	String	Definition Workflow ID. Range N/A

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

Binding an EIP to a proxy instance

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"
}

Unbinding an EIP from a proxy instance

POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/e73893ef73754465a8bd2e0857bbf13ein07/proxy/e87088f0b6a345e79db19d57c41fde15po01/bind

{
  "public_ip" : "xxx.xxx.xxx.xxx",
  "bind" : "false"
}

Example Response

Status code: 200

Success.

{
  "job_id" : "467258e0-4e6e-4167-b072-7f4e23231bf3"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Database Proxy