Querying All EIPs

Function

This API is used to query all EIPs. (This API is not supported in eu-nl.)

URI

GET /v3/{project_id}/eip/publicips

Table 1 Path parameter

Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. Minimum length: 0 Maximum length: 32

Table 2 Query parameters

Parameter	Mandatory	Type	Description
marker	No	String	Start resource ID of pagination query. If the parameter is left blank, only resources on the first page are queried. Minimum length: 0 Maximum length: 36
offset	No	Integer	Start resource number of pagination query. Minimum value: 0 Maximum value: 99999
limit	No	Integer	Number of records returned on each page. The value ranges from 0 to 2,000. The maximum value varies by region. Minimum value: 0 Maximum value: 2000
fields	No	Array	Field. Format: "fields=id&fields=owner&..." Supported fields: id, project_id, ip_version, type, public_ip_address, public_ipv6_address, network_type, status, description, created_at, updated_at, vnic, bandwidth, associate_instance_type, associate_instance_id, lock_status, billing_info, tags, enterprise_project_id, allow_share_bandwidth_types, public_border_group, alias, publicip_pool_name, and publicip_pool_id.
sort_key	No	String	Sort. Format: "sort_key=id" Supported fields: id, public_ip_address, public_ipv6_address, ip_version, created_at, updated_at, and public_border_group. Enumerated values: id public_ip_address public_ipv6_address ip_version created_at updated_at public_border_group
sort_dir	No	String	Sorting direction. The value can be asc or desc Enumerated values: asc desc
id	No	Array	Filter by id.
ip_version	No	Array	Filter by ip_version. The value can be 4 (IPv4) or 6 (IPv6). Enumerated values: 4 6
public_ip_address	No	Array	Filter by public_ip_address.
public_ip_address_like	No	String	Filter by public_ip_address in a fuzzy search. Minimum length: 0 Maximum length: 64
public_ipv6_address	No	Array	Filter by public_ipv6_address.
public_ipv6_address_like	No	String	Filter by public_ipv6_address in a fuzzy search. Minimum length: 0 Maximum length: 64
type	No	Array	Filter by type. The value can be: EIP: EIP DUALSTACK: Dual-stack IPv6 Enumerated values: EIP DUALSTACK
network_type	No	Array	Filter by network_type. The value can be 5_telcom, 5_union, 5_bgp, 5_sbgp, 5_ipv6, or 5_graybgp. Enumerated values: 5_telcom 5_union 5_bgp 5_sbgp 5_ipv6 5_graybgp
publicip_pool_name	No	Array	Filter by publicip_pool_name. The value can be 5_telcom, 5_union, 5_bgp, 5_sbgp, 5_ipv6, 5_graybgp, or a dedicated pool name.
status	No	Array	Filter by status. The value can be FREEZED, DOWN, ACTIVE, or ERROR. Enumerated values: FREEZED DOWN ACTIVE ERROR
alias_like	No	String	Filter by alias in a fuzzy search. Minimum length: 0 Maximum length: 64
alias	No	Array	Filter by alias.
description	No	Array	Filter by description.
vnic.private_ip_address	No	Array	Filter by private_ip_address.
vnic.private_ip_address_like	No	String	Filter by private_ip_address in a fuzzy search. Minimum length: 0 Maximum length: 64
vnic.device_id	No	Array	Filter by device_id.
vnic.device_owner	No	Array	Filter by device_owner.
vnic.vpc_id	No	Array	Filter by vpc_id.
vnic.port_id	No	Array	Filter by port_id.
vnic.device_owner_prefixlike	No	String	Filter by device_owner_prefixlike in a fuzzy search. Minimum length: 0 Maximum length: 64
vnic.instance_type	No	Array	Filter by instance_type.
vnic.instance_id	No	Array	Filter by instance_id.
bandwidth.id	No	Array	Filter by the bandwidth ID.
bandwidth.name	No	Array	Filter by name.
bandwidth.name_like	No	Array	Filter by name in a fuzzy search.
bandwidth.size	No	Array	Filter by size.
bandwidth.share_type	No	Array	Filter by share_type. Enumerated values: PER WHOLE
bandwidth.charge_mode	No	Array	Filter by charge_mode. Enumerated values: bandwidth traffic 95peak_plus
billing_info	No	Array	Filter by billing_info.
billing_mode	No	String	Filter by billing_mode. The value can be PAY_PER_USE. Enumerated values: PAY_PER_USE
associate_instance_type	No	Array	Filter by associate_instance_type. The value can be PORT, NATGW, ELB, VPN, or ELBV1. Enumerated values: PORT NATGW ELB VPN ELBV1
associate_instance_id	No	Array	Filter by associate_instance_id.
enterprise_project_id	No	Array	Filter by enterprise_project_id.
public_border_group	No	Array	Filter by public_border_group.
allow_share_bandwidth_type_any	No	Array	Shared bandwidth type. EIPs can be filtered by shared bandwidth type. You can specify multiple shared bandwidth types, which are separated by commas (,).

Request Parameter

None

Response Parameters

Status code: 200

Table 3 Response body parameters

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

Table 4 PublicipSingleShowResp

Parameter	Type	Description
id	String	Unique ID of the EIP. Minimum length: 0 Maximum length: 36
project_id	String	Project ID. Minimum length: 0 Maximum length: 32
ip_version	Integer	IP address version. The value can be: 4: IPv4 EIP 6: IPv6 EIP Enumerated values: 4 6
public_ip_address	String	EIP or IPv6 port address. Minimum length: 0 Maximum length: 36
public_ipv6_address	String	Obtained EIP if IPv6 EIPs are available. This parameter does not exist if only IPv4 EIPs are available. Minimum length: 0 Maximum length: 64
network_type	String	Network type of an EIP. This parameter is discarded and is not displayed by default. It is inherited by publicip_pool_name. Minimum length: 0 Maximum length: 64
status	String	EIP status. The value can be: FREEZED (Frozen) BIND_ERROR (Binding failed) BINDING (Binding) PENDING_DELETE (Releasing) PENDING_CREATE (Assigning) NOTIFYING NOTIFY_DELETE PENDING_UPDATE (Updating) DOWN (Unbound) ACTIVE (Bound) ELB (Bound to a load balancer) VPN (Bound to a VPN) ERROR Minimum length: 0 Maximum length: 64 Enumerated values: FREEZED BIND_ERROR BINDING PENDING_DELETE PENDING_CREATE NOTIFYING NOTIFY_DELETE PENDING_UPDATE DOWN ACTIVE ELB VPN ERROR
description	String	Supplementary information about the EIP. This is customized by users and is not perceived by the system. Minimum length: 0 Maximum length: 256
public_border_group	String	Whether the resource is in a central region or an edge site. The value can be center or an edge site name. This resource can only be associated with an EIP of the same region. Minimum length: 1 Maximum length: 64
created_at	String	Time (UTC) when an EIP is assigned. Format: yyyy-MM-ddTHH:mm:ssZ Minimum length: 0 Maximum length: 64
updated_at	String	Time (UTC) when an EIP is updated. Format: yyyy-MM-ddTHH:mm:ssZ Minimum length: 0 Maximum length: 64
type	String	EIP type. Minimum length: 1 Maximum length: 36 Enumerated values: EIP DUALSTACK
vnic	VnicInfo object	Port information of the instance with an EIP bound. If the instance with an EIP bound does not depend on a port, the value is null.
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	Order information of an EIP. This parameter is left empty for pay-per-use resources. Minimum length: 0 Maximum length: 256
lock_status	String	Frozen status of an EIP. The metadata type indicates that the EIP is frozen due to arrears or abuse. The value can be: police locked Minimum length: 0 Maximum length: 64
associate_instance_type	String	Type of the instance bound with an EIP. The value can be: PORT NATGW ELB ELBV1 VPN null Minimum length: 0 Maximum length: 64 Enumerated values: PORT NATGW ELB ELBV1 VPN null
associate_instance_id	String	ID of the instance bound with an EIP. 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	Network type of an EIP, including public EIP pool (for example, 5_bgp or 5_sbgp) and dedicated EIP pool. For details about the dedicated EIP pool, see the APIs about publcip_pool. Minimum length: 0 Maximum length: 64
alias	String	EIP name. Minimum length: 0 Maximum length: 64
profile	ProfileInfo object	EIP and metadata. (The parameter is not displayed by default.)
fake_network_type	Boolean	Whether an EIP can change its BGP type. If the value is true, the EIP can change its BGP type. If the value is false, the EIP cannot change its BGP type. (The parameter is not displayed by default.) Enumerated values: true false
tags	Array of strings	User tag. (The parameter is not displayed by default.)
associate_instance_metadata	String	Record the upper-level ownership of an instance. For example, if associate_instance_type is set to PORT, this parameter records the device_id and device_owner information of the port. (This parameter only records information in limited scenarios and is not displayed by default.) Minimum length: 1 Maximum length: 64
associate_mode	String	Passthrough mode. The parameter is displayed only after the passthrough mode is enabled. Minimum length: 1 Maximum length: 36
allow_share_bandwidth_types	Array of strings	Types of the shared bandwidth that an EIP can be added to. If this parameter is left blank, the EIP cannot be added to any shared bandwidth. The EIP can be added only to the shared bandwidth of these types. Maximum length: 64
cascade_delete_by_instance	Boolean	Whether an EIP can be released together with its instance. (The parameter is not displayed by default.)

Table 5 VnicInfo

Parameter	Type	Description
private_ip_address	String	Private IP address. Minimum length: 0 Maximum length: 36
device_id	String	ID of the device that a port belongs to. The system automatically sets this parameter. Minimum length: 0 Maximum length: 36
device_owner	String	Device that the port belongs to. The value can be: network:dhcp network:VIP_PORT network:router_interface_distributed network:router_centralized_snat The system automatically sets this parameter. Minimum length: 0 Maximum length: 64
vpc_id	String	VPC ID. Minimum length: 0 Maximum length: 36
port_id	String	Port ID. Minimum length: 0 Maximum length: 36
port_profile	String	Port profile. Minimum length: 0 Maximum length: 256
mac	String	Port MAC address. The system automatically sets this parameter. Minimum length: 0 Maximum length: 64
vtep	String	VTEP IP address. Minimum length: 0 Maximum length: 36
vni	String	VXLAN ID. Minimum length: 0 Maximum length: 36
instance_id	String	ID of the instance that the port belongs to, for example, RDS instance ID. The system automatically sets this parameter. Minimum length: 0 Maximum length: 36
instance_type	String	Type of the instance that the port belongs to, for example, RDS. The system automatically sets this parameter. Minimum length: 0 Maximum length: 36

Table 6 PublicipBandwidthInfo

Parameter	Type	Description
id	String	Bandwidth ID. Minimum length: 0 Maximum length: 36
size	Integer	Bandwidth size. The value ranges from 5 Mbit/s to 2000 Mbit/s by default. Minimum value: 0 Maximum value: 99999
share_type	String	Whether the bandwidth is shared or dedicated. The value can be: PER: Dedicated bandwidth WHOLE: Shared bandwidth IPv6 addresses do not support bandwidth whose type is WHOLE. Minimum length: 0 Maximum length: 36
charge_mode	String	Whether the billing is based on traffic or bandwidth. The value can be: bandwidth: billed by bandwidth traffic: billed by traffic 95peak_plus: billed by 95th percentile bandwidth (enhanced) Minimum length: 0 Maximum length: 36
name	String	Bandwidth name. The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). Minimum length: 0 Maximum length: 64
billing_info	String	Billing information. Minimum length: 0 Maximum length: 256

Table 7 ProfileInfo

Parameter	Type	Description
local_network_port	String	port_id in the 5_xxx network (for example, 5_bgp) of an EIP. Minimum length: 0 Maximum length: 36
standalone	Boolean	Whether an EIP is assigned together with a VM. If the value is true, the EIP is assigned independently. If the value is false, the EIP is assigned together with a VM.
notify_status	String	EIP assigning status. This parameter is only for internal use of the EIP service. Minimum length: 0 Maximum length: 36 Enumerated values: PENDING_CREATE PENDING_UPDATE NOTIFYING NOTIFYED NOTIFY_DELETE
create_time	String	Time when an EIP is assigned. Minimum length: 0 Maximum length: 64
fake_network_type	Boolean	Whether an EIP can change its BGP type. If the value is true, the EIP can change its BGP type. If the value is false, the EIP cannot change its BGP type. Enumerated values: true false
create_source	String	Type of the resource purchased together with an EIP. Minimum length: 0 Maximum length: 36 Enumerated value: ecs
ecs_id	String	ID of the ECS purchased together with an EIP. Minimum length: 0 Maximum length: 36
lock_status	String	Lock status of an EIP, for example, POLICE (abuse), LOCKED (common issues), ARREAR (in arrears), and DELABLE (can be deleted). Minimum length: 0 Maximum length: 36
freezed_status	String	EIP frozen status. Minimum length: 0 Maximum length: 36 Enumerated values: FREEZED UNFREEZED
bandwidth_info	BandwidthInfoResp object	Bandwidth bound to an EIP.

Table 8 BandwidthInfoResp

Parameter	Type	Description
bandwidth_name	String	Bandwidth name. Minimum length: 0 Maximum length: 256
bandwidth_number	Integer	Bandwidth size (Mbit/s). Minimum value: 0 Maximum value: 99999
bandwidth_type	String	Bandwidth type. Enumerated values: PER WHOLE
bandwidth_id	String	Bandwidth ID. Minimum length: 0 Maximum length: 36

Table 9 PageInfoOption

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.

last updated: 2024-05-17 02:48