Binding and Unbinding an EIP
Function
This API is used to bind an EIP to a DB instance for public access or unbind an EIP from the DB instance as required.
- Before calling this API, learn how to authenticate it.
- Before calling this API, learn about request header parameters.
Constraints
An EIP cannot be bound to or unbound from a DB instance that is being created, modified, restored, or rebooted.
URI
- Parameter description
Table 1 Parameter description Name
Mandatory
Description
project_id
Yes
Project ID of a tenant in a region.
To obtain the value, see Obtaining a Project ID.
instance_id
Yes
Specifies the DB instance ID.
Request
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| public_ip | No | String | NOTICE: When is_bind is true, public_ip is mandatory. Specifies the EIP to be bound. The value must be in the standard IP address format. |
| public_ip_id | No | String | NOTICE: When is_bind is true, public_ip_id is mandatory. Specifies the EIP ID. The value must be in the standard UUID format. |
| is_bind | Yes | Boolean |
|
Example Request
- Bind an EIP to a DB instance.
{ "public_ip":"10.10.10.1", "public_ip_id":"8403e9cd-a7fa-4288-8b15-c7ceac1etest", "is_bind":true } - Unbind an EIP from a DB instance.
{ "is_bind":false }
Response
- Normal response
- Abnormal response
For details, see Abnormal Request Results.
Status Code
- Normal
- Abnormal
For details, see Status Codes.
Error Code
For details, see Error Codes.