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 an API, you need to understand the API in Authentication.

• Before calling this API, obtain the required region and endpoint.

Constraints

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

URI

• URI format

  PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/public-ip

• 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.

Request

• Parameter description

  Table 2 Parameter description

  Name	Mandatory	Type	Description
  public_ip	No	String	Important 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	Important 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.

• Example

  PUT https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/public-ip

• Request example

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

Response

• Normal response

  None

• Abnormal response

  For details, see Abnormal Request Results.

Status Code

• Normal

  200

• Abnormal

  For details, see Status Codes.

Error Code

For details, see Error Codes.

last updated: 2024-11-14 08:39 UTC - commit: f56365719e781224dbc063c31e4cf80643481650