Unbinding an EIP
Function
This API is used to unbind an EIP.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
URI
POST /v3/{project_id}/eip/publicips/{publicip_id}/disassociate-instance
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String |
Maximum: 32 |
| publicip_id | Yes | String | EIP ID Minimum: 36 Maximum: 36 |
Request Parameters
None
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| request_id | String | Request ID. |
| publicip | PublicipInstanceResp object | Response body of unbinding an EIP |
| Parameter | Type | Description |
|---|---|---|
| id | String | |
| project_id | String | |
| ip_version | Integer | |
| public_ip_address | String | |
| public_ipv6_address | String | |
| status | String | |
| description | String | |
| public_border_group | String | |
| created_at | String | |
| updated_at | String | |
| type | String | |
| vnic | VnicInfo object | |
| bandwidth | PublicipBandwidthInfo object | |
| enterprise_project_id | String | |
| billing_info | String | |
| lock_status | String | |
| associate_instance_type | String | |
| associate_instance_id | String | |
| publicip_pool_id | String | |
| publicip_pool_name | String | |
| alias | String |
| Parameter | Type | Description |
|---|---|---|
| private_ip_address | String | Definition Private IP address. Range N/A |
| device_id | String | Definition ID of the device that the port belongs to. The device ID indicates the ID of the cloud service resource that uses the private IP address in the subnet, for example, the cloud server ID or load balancer ID. The system automatically sets this parameter. Range N/A |
| device_owner | String | Definition Device that the port belongs to. It can be a cloud service resource that uses a private IP address in the subnet. Range |
| vpc_id | String | Definition VPC ID. Range N/A |
| port_id | String | Definition Port ID. Range N/A |
| port_profile | String | Definition Port profile. Range N/A |
| mac | String | Definition MAC address of the port. Range The system automatically sets this parameter. |
| vtep | String | Definition VTEP IP address. Range N/A |
| vni | String | Definition VXLAN ID. Range N/A |
| instance_id | String | Definition The ID of the instance that the port belongs to, for example, RDS instance ID. Range The system automatically sets this parameter. |
| instance_type | String | Definition Type of the instance that uses the port. Range |
| port_vif_details | String | Definition Details about the virtual interface of the network interface. Range N/A |
| Parameter | Type | Description |
|---|---|---|
| id | String | Definition Bandwidth ID. Range N/A |
| size | Integer | Definition Bandwidth size. Range The value ranges from 5 Mbit/s to 2000 Mbit/s. |
| share_type | String | Definition Whether the bandwidth is shared or dedicated. Range |
| charge_mode | String | Definition The billing option of the bandwidth. Range |
| name | String | Definition Bandwidth name. Range The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). |
| billing_info | String | Definition Bill information. If billing_info is specified, the bandwidth is billed on a yearly/monthly basis. Range N/A |
Example Requests
To unbind an EIP, you only need to transfer publicip_id in the URL. The request body is empty.
POST /v3/{project_id}/eip/publicips/{publicip_id}/disassociate-instance Example Responses
Status code: 200
-
{ "publicip" : { "alias" : "abcd", "associate_instance_id" : null, "associate_instance_type" : null, "bandwidth" : { "billing_info" : "xxxx:xxxx:xxxx:xxxx", "charge_mode" : "bandwidth", "id" : "80549ae1-cf7a-4f39-a45f-bdb8e194a1f4", "name" : "bandwidth-bd25-test", "share_type" : "WHOLE", "size" : 7 }, "billing_info" : null, "created_at" : "2020-06-18T14:05:32Z", "description" : "test!!!!", "enterprise_project_id" : "0", "public_border_group" : "center", "id" : "b0c42aa6-3d1d-4b39-9188-35ee6aa8d6f7", "ip_version" : 4, "lock_status" : null, "project_id" : "060576782980d5762f9ec014dd2f1148", "public_ip_address" : "xx.xx.xx.xx", "public_ipv6_address" : null, "publicip_pool_id" : "160576782980d5762f9ec014dd2f1148", "publicip_pool_name" : "5_mobile", "status" : "DOWN", "type" : "EIP", "updated_at" : "2020-06-18T14:05:32Z", "vnic" : null }, "request_id" : "ead9f912bd1191e3d5f0037141098d91" }
SDK Sample Code
The SDK sample code is as follows.
Java
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 | package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.eip.v3.region.EipRegion; import com.huaweicloud.sdk.eip.v3.*; import com.huaweicloud.sdk.eip.v3.model.*; public class DisassociatePublicipsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); EipClient client = EipClient.newBuilder() .withCredential(auth) .withRegion(EipRegion.valueOf("<YOUR REGION>")) .build(); DisassociatePublicipsRequest request = new DisassociatePublicipsRequest(); request.withPublicipId("{publicip_id}"); try { DisassociatePublicipsResponse response = client.disassociatePublicips(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Python
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkeip.v3.region.eip_region import EipRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkeip.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = EipClient.new_builder() \ .with_credentials(credentials) \ .with_region(EipRegion.value_of("<YOUR REGION>")) \ .build() try: request = DisassociatePublicipsRequest() request.publicip_id = "{publicip_id}" response = client.disassociate_publicips(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" eip "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := eip.EipClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := eip.NewEipClient(hcClient) request := &model.DisassociatePublicipsRequest{} request.PublicipId = "{publicip_id}" response, err := client.DisassociatePublicips(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
| Status Code | Description |
|---|---|
| 200 | Normal response to the POST operation |
Error Codes
See Error Codes.
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot