Binding an EIP
Function
This API is used to bind an EIP.
URI
POST /v3/{project_id}/eip/publicips/{publicip_id}/associate-instance
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. Minimum length: 0 Maximum length: 32 |
publicip_id |
Yes |
String |
EIP ID. Minimum length: 0 Maximum length: 36 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
publicip |
Yes |
AssociatePublicipsOption object |
EIP object. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
associate_instance_type |
Yes |
String |
Minimum length: 0 Maximum length: 36 Enumerated values:
|
associate_instance_id |
Yes |
String |
Minimum length: 0 Maximum length: 36 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Request ID. Minimum length: 0 Maximum length: 36 |
publicip |
PublicipInstanceResp object |
Response body of binding an EIP. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Minimum length: 0 Maximum length: 36 |
project_id |
String |
Minimum length: 0 Maximum length: 32 |
ip_version |
Integer |
Enumerated values:
|
public_ip_address |
String |
Minimum length: 0 Maximum length: 36 |
public_ipv6_address |
String |
Minimum length: 0 Maximum length: 64 |
status |
String |
Enumerated values:
|
description |
String |
Minimum length: 1 Maximum length: 255 |
public_border_group |
String |
Minimum length: 1 Maximum length: 64 |
created_at |
String |
|
updated_at |
String |
|
type |
String |
Minimum length: 1 Maximum length: 36 Enumerated values:
|
vnic |
VnicInfo object |
|
bandwidth |
PublicipBandwidthInfo object |
|
enterprise_project_id |
String |
Minimum length: 0 Maximum length: 36 |
billing_info |
String |
Minimum length: 0 Maximum length: 256 |
lock_status |
String |
Minimum length: 0 Maximum length: 64 |
associate_instance_type |
String |
Minimum length: 0 Maximum length: 64 Enumerated values:
|
associate_instance_id |
String |
Minimum length: 0 Maximum length: 64 |
publicip_pool_id |
String |
Minimum length: 0 Maximum length: 36 |
publicip_pool_name |
String |
Minimum length: 0 Maximum length: 64 |
alias |
String |
Minimum length: 0 Maximum length: 64 |
Parameter |
Type |
Description |
---|---|---|
private_ip_address |
String |
Minimum length: 0 Maximum length: 36 |
device_id |
String |
Minimum length: 0 Maximum length: 36 |
device_owner |
String |
Minimum length: 0 Maximum length: 64 |
vpc_id |
String |
Minimum length: 0 Maximum length: 36 |
port_id |
String |
Minimum length: 0 Maximum length: 36 |
port_profile |
String |
Minimum length: 0 Maximum length: 256 |
mac |
String |
Minimum length: 0 Maximum length: 64 |
vtep |
String |
Minimum length: 0 Maximum length: 36 |
vni |
String |
Minimum length: 0 Maximum length: 36 |
instance_id |
String |
Minimum length: 0 Maximum length: 36 |
instance_type |
String |
Minimum length: 0 Maximum length: 36 |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Minimum length: 0 Maximum length: 36 |
size |
Integer |
Minimum value: 0 Maximum value: 99999 |
share_type |
String |
Minimum length: 0 Maximum length: 36 |
charge_mode |
String |
Minimum length: 0 Maximum length: 36 |
name |
String |
Minimum length: 0 Maximum length: 64 |
billing_info |
String |
Minimum length: 0 Maximum length: 256 |
Example Request
{ "publicip" : { "associate_instance_id" : "921b9dc7-8151-41e1-b83c-d50fe959592a", "associate_instance_type" : "PORT" } }
Example Response
Status code: 200
Normal response to POST requests
{ "publicip" : { "alias" : "abcd", "associate_instance_id" : "921b9dc7-8151-41e1-b83c-d50fe959592a", "associate_instance_type" : "PORT", "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" : "ACTIVE", "type" : "EIP", "updated_at" : "2020-06-18T14:05:32Z", "vnic" : { "device_id" : "78aa6d7f-7111-434e-9a93-0dc6fdacff63", "device_owner" : "network:nat_gateway", "instance_id" : "", "instance_type" : "", "mac" : "fa:16:3e:83:6b:0a", "port_id" : "921b9dc7-8151-41e1-b83c-d50fe959592a", "port_profile" : null, "private_ip_address" : "xx.xx.xx.xx", "vni" : null, "vpc_id" : "a26c231a-cf6f-48d3-83db-1e261d0e235a", "vtep" : null } }, "request_id" : "ead9f912bd1191e3d5f0037141098d91" }
Status Codes
See Status Codes.
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank 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