Binding and Unbinding an EIP

Updated on 2024-01-12 GMT+08:00

View PDF

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.

An EIP cannot be bound to or unbound from a DB instance that is being created, modified, restored, or rebooted.

Parameter description

**Table 1** Parameter description
Name	Mandatory	Description
project_id	Yes	Specifies the project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID.
instance_id	Yes	Specifies the DB instance ID.

Parameter description

**Table 2** Parameter description
Name	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	true: Bind an EIP. false: Unbind an EIP.

Binding an EIP to a DB instance

{
    "public_ip":"10.10.10.1",
    "public_ip_id":"8403e9cd-a7fa-4288-8b15-c7ceac1etest",
    "is_bind":true
}

For details, see Error Codes.

Parent topic: DB Instance Management

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel