Updating an EIP
Function
This API is used to update an EIP.
URI
PUT /v3/{project_id}/eip/publicips/{publicip_id}
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 |
UpdatePublicipOption object |
EIP |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
alias |
No |
String |
Minimum length: 0 Maximum length: 64 |
description |
No |
String |
Minimum length: 0 Maximum length: 256 |
associate_instance_type |
No |
String |
Minimum length: 0 Maximum length: 36 The value can be:
|
associate_instance_id |
No |
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 |
PublicipUpdateResp object |
Response object of updating 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 |
The value can be:
|
public_ip_address |
String |
Minimum length: 0 Maximum length: 36 |
public_ipv6_address |
String |
Minimum length: 0 Maximum length: 64 |
status |
String |
Minimum length: 0 Maximum length: 64 The value can be:
|
description |
String |
Minimum length: 0 Maximum length: 256 |
public_border_group |
String |
Minimum length: 1 Maximum length: 64 |
created_at |
String |
Minimum length: 0 Maximum length: 64 |
updated_at |
String |
Minimum length: 0 Maximum length: 64 |
type |
String |
EIP type Minimum length: 1 Maximum length: 36 The value can be:
|
vnic |
VnicInfo object |
|
bandwidth |
PublicipBandwidthInfo object |
Bandwidth of an EIP |
enterprise_project_id |
String |
Enterprise project ID. The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). This is the ID of the enterprise project that you associate with the EIP when you assign the EIP. 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 The value can be:
|
associate_instance_id |
String |
ID of the instance with an EIP bound Minimum length: 0 Maximum length: 36 |
publicip_pool_id |
String |
ID of the network that an EIP belongs to. It is the network ID corresponding to publicip_pool_name. Minimum length: 0 Maximum length: 36 |
publicip_pool_name |
String |
Minimum length: 0 Maximum length: 64 |
alias |
String |
Minimum length: 0 Maximum length: 64 |
associate_mode |
String |
Minimum length: 1 Maximum length: 36 |
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" : { "alias" : "abcd", "description" : "test!!!!" } }
Example Response
Status code: 200
Normal response to PUT requests
{ "publicip" : { "alias" : "abcd", "associate_instance_id" : null, "associate_instance_type" : null, "bandwidth" : { "billing_info" : "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" }
Status Codes
Status Code |
Description |
---|---|
200 |
Normal response to PUT requests |
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