virtual-private-cloud/api-ref/source/apis/eip/releasing_an_eip.rst

original_name

vpc_eip_0005.html

Releasing an EIP

Function

This API is used to release an EIP.

Note

Note the following when you use EIPs of the Dedicated Load Balancer (5_gray) type:

• In eu-de, EIPs of the Dedicated Load Balancer (5_gray) type cannot be created any more.
• Existing EIPs of the Dedicated Load Balancer (5_gray) type can be bound to dedicated or shared load balancers.
  • The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers.
  • You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see "Binding an EIP" and "Unbinding an EIP" in "API V3" section in the Elastic IP API Reference.
  • EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs.
• Do not add EIPs of the dedicated load balancer type (5_gray) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect.

URI

DELETE /v1/{project_id}/publicips/{publicip_id}

Table 1 <vpc_eip_0005__table45251091> describes the parameters.

Table 1 Parameter description

Name	Mandatory	Description
project_id	Yes	Specifies the project ID.
publicip_id	Yes	Specifies the unique identifier of an EIP.

Request Message

• Request parameter

  Table 2 Request header parameter

  Parameter	Mandatory	Type	Description
  X-Auth-Token	Yes	String	Specifies the user token. The token can be obtained by calling the IAM API used for obtaining a user token. The value of X-Subject-Token in the response header is the user token.

• Example request

  DELETE https://{Endpoint}/v1/{project_id}/publicips/{publicip_id}

Response Message

• Response parameter

  None

• Example response

  None

  Or

  {
         "code":"xxx",
         "message":"xxxxx"
  }

Status Code

See Status Codes <vpc_api_0002>.

Error Code

See Error Codes <vpc_api_0003>.