Querying All EIPs
Function
This API is used to query all EIPs.
URI
GET /v3/{project_id}/eip/publicips
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Minimum length: 0 Maximum length: 32 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
marker |
No |
String |
Minimum length: 0 Maximum length: 36 |
offset |
No |
Integer |
Minimum value: 0 Maximum value: 99999 |
limit |
No |
Integer |
Minimum value: 0 Maximum value: 2000 |
fields |
No |
Array |
|
sort_key |
No |
String |
Enumerated values:
|
sort_dir |
No |
String |
Enumerated values:
|
id |
No |
Array |
|
ip_version |
No |
Array |
Enumerated values:
|
public_ip_address |
No |
Array |
|
public_ip_address_like |
No |
String |
Minimum length: 0 Maximum length: 64 |
public_ipv6_address |
No |
Array |
|
public_ipv6_address_like |
No |
String |
Minimum length: 0 Maximum length: 64 |
type |
No |
Array |
Enumerated values:
|
network_type |
No |
Array |
Enumerated values:
|
publicip_pool_name |
No |
Array |
|
status |
No |
Array |
Enumerated values:
|
alias_like |
No |
String |
Minimum length: 0 Maximum length: 64 |
alias |
No |
Array |
|
description |
No |
Array |
|
vnic.private_ip_address |
No |
Array |
|
vnic.private_ip_address_like |
No |
String |
Minimum length: 0 Maximum length: 64 |
vnic.device_id |
No |
Array |
|
vnic.device_owner |
No |
Array |
|
vnic.vpc_id |
No |
Array |
|
vnic.port_id |
No |
Array |
|
vnic.device_owner_prefixlike |
No |
String |
Minimum length: 0 Maximum length: 64 |
vnic.instance_type |
No |
Array |
|
vnic.instance_id |
No |
Array |
|
bandwidth.id |
No |
Array |
|
bandwidth.name |
No |
Array |
|
bandwidth.name_like |
No |
Array |
|
bandwidth.size |
No |
Array |
|
bandwidth.share_type |
No |
Array |
Enumerated values:
|
bandwidth.charge_mode |
No |
Array |
Enumerated values:
|
billing_info |
No |
Array |
|
billing_mode |
No |
String |
Enumerated values:
|
associate_instance_type |
No |
Array |
Enumerated values:
|
associate_instance_id |
No |
Array |
|
enterprise_project_id |
No |
Array |
|
public_border_group |
No |
Array |
|
allow_share_bandwidth_type_any |
No |
Array |
|
Request Parameter
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Request ID. Minimum length: 0 Maximum length: 36 |
publicips |
Array of PublicipSingleShowResp objects |
EIP object. |
page_info |
PageInfoOption object |
Pagination page number information. |
total_count |
Integer |
Total number of EIPs. Minimum value: 0 Maximum value: 999999 |
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 |
network_type |
String |
Minimum length: 0 Maximum length: 64 |
status |
String |
Minimum length: 0 Maximum length: 64 Enumerated values:
|
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 |
Minimum length: 1 Maximum length: 36 Enumerated values:
|
vnic |
VnicInfo object |
|
bandwidth |
PublicipBandwidthInfo object |
Bandwidth bound to 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 Enumerated values:
|
associate_instance_id |
String |
Minimum length: 0 Maximum length: 36 |
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 |
profile |
ProfileInfo object |
|
fake_network_type |
Boolean |
Enumerated values:
|
tags |
Array of strings |
|
associate_instance_metadata |
String |
Minimum length: 1 Maximum length: 64 |
associate_mode |
String |
Minimum length: 1 Maximum length: 36 |
allow_share_bandwidth_types |
Array of strings |
Maximum length: 64 |
cascade_delete_by_instance |
Boolean |
|
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 |
Parameter |
Type |
Description |
---|---|---|
local_network_port |
String |
Minimum length: 0 Maximum length: 36 |
standalone |
Boolean |
|
notify_status |
String |
Minimum length: 0 Maximum length: 36 Enumerated values:
|
create_time |
String |
Minimum length: 0 Maximum length: 64 |
fake_network_type |
Boolean |
Enumerated values:
|
create_source |
String |
Minimum length: 0 Maximum length: 36 Enumerated value:
|
ecs_id |
String |
Minimum length: 0 Maximum length: 36 |
lock_status |
String |
Minimum length: 0 Maximum length: 36 |
freezed_status |
String |
Minimum length: 0 Maximum length: 36 Enumerated values:
|
bandwith_info |
BandwidthInfoResp object |
|
Parameter |
Type |
Description |
---|---|---|
bandwidth_name |
String |
Minimum length: 0 Maximum length: 256 |
bandwidth_number |
Integer |
Minimum value: 0 Maximum value: 99999 |
bandwidth_type |
String |
Enumerated values:
|
bandwidth_id |
String |
Minimum length: 0 Maximum length: 36 |
Parameter |
Type |
Description |
---|---|---|
previous_marker |
String |
Marker value of the previous page. Minimum length: 0 Maximum length: 36 |
next_marker |
String |
Marker value of the next page. Minimum length: 0 Maximum length: 36 |
current_count |
Integer |
Total number of data records on the current page. Minimum value: 0 Maximum value: 99999 |
Example Request
None
Example Response
Status code: 200
Normal response to the GET operation
{ "page_info" : { "current_count" : 1, "next_marker" : "0490aeae-ab8f-4764-b012-45645e9c0aa9", "previous_marker" : "0490aeae-ab8f-4764-b012-45645e9c0aa9" }, "publicips" : [ { "created_at" : "2022-03-17T09:46:22Z", "updated_at" : "2022-03-30T02:46:04Z", "lock_status" : null, "allow_share_bandwidth_types" : [ "bgp", "sbgp", "share", "share_yidongdanxian", "share_youxuan" ], "id" : "006343a1-32bf-4361-958a-efd158153dd0", "alias" : null, "project_id" : "060576787a80d5762fa2c00f07ddfcf4", "ip_version" : 4, "public_ip_address" : "88.88.1.141", "public_ipv6_address" : null, "status" : "DOWN", "description" : "", "enterprise_project_id" : "0", "billing_info" : null, "type" : "EIP", "vnic" : { "private_ip_address" : "172.16.1.235", "device_id" : "", "device_owner" : "", "vpc_id" : "1c30f428-9741-48b2-a788-0b2f359705eb", "port_id" : "22d3576d-c042-4f3d-8c7c-1330a2724627", "mac" : "fa:16:3e:3a:22:66", "vtep" : null, "vni" : null, "instance_id" : "", "instance_type" : "", "port_profile" : null }, "bandwidth" : { "id" : "149ff19b-5de4-4436-958f-2eca39952e93", "size" : 100, "share_type" : "PER", "charge_mode" : "traffic", "name" : "bandwidth-xym-br-eqos", "billing_info" : "" }, "associate_instance_type" : "PORT", "associate_instance_id" : "22d3576d-c042-4f3d-8c7c-1330a2724627", "publicip_pool_id" : "9af5f2e5-1765-4b86-b342-ece52e785c8b", "publicip_pool_name" : "5_union", "public_border_group" : "center", "tags" : [ "key=value" ] } ], "request_id" : "c4962d006b34af3c2343de7f88ef65e3", "total_count" : 100 }
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