Querying an EIP

Function

This API is used to query a specific EIP.

URI

GET /v1/{project_id}/publicips/{publicip_id}

Table 1 describes the parameters.

**Table 1** Parameter description
Name	Mandatory	Description
project_id	Yes	Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID.
publicip_id	Yes	Specifies the unique identifier of an EIP.

Request Message

Request parameter
None

Example request

Get https://{Endpoint}/v1/{project_id}/publicips/{publicip_id}

Response Message

Response parameter

**Table 2** Response parameter
Name	Type	Description
publicip	publicip object	Specifies the EIP object. For details, see Table 3.

**Table 3** Description of the **publicip** field
Name	Type	Description
id	String	Specifies the unique identifier of an EIP.
status	String	Specifies the EIP status. Possible values are as follows: FREEZED (Frozen) BIND_ERROR (Binding failed) BINDING (Binding) PENDING_DELETE (Releasing) PENDING_CREATE (Assigning) PENDING_UPDATE (Updating) NOTIFYING (Assigning) NOTIFY_DELETE (Releasing) DOWN (Unbound) ACTIVE (Bound) ELB (Bound to a load balancer) VPN (Bound to a VPN) ERROR (Exceptions)
type	String	Specifies the EIP type. Constraints: The configured value must be supported by the system. publicip_id is an IPv4 port. If publicip_type is not specified, the default value is 5_bgp.
private_ip_address	String	Specifies the private IP address bound to the EIP. This parameter is returned only if the private IP address is bound to the EIP.
port_id	String	Specifies the port ID. This parameter is returned only when a port is associated with the EIP.
tenant_id	String	Specifies the project ID.
create_time	String	Specifies the time (UTC) when the EIP is assigned. Format: yyyy-MM-dd HH:mm:ss
bandwidth_id	String	Specifies the ID of the EIP bandwidth.
bandwidth_size	Integer	Specifies the bandwidth (Mbit/s).
bandwidth_share_type	String	Specifies the EIP bandwidth type. The value can be PER or WHOLE. PER: Dedicated bandwidth WHOLE: Shared bandwidth
alias	String	Specifies the EIP name.
public_border_group	String	Specifies whether it is in a central site or an edge site. The value can be: center Edge site name An EIP can only be bound to a resource of the same region.

Example response

{
    "publicip": {
        "id": "2ec9b78d-9368-46f3-8f29-d1a95622a568",
        "status": "DOWN",
        "alias": "tom",
        "type": "5_bgp",
        "public_ip_address": "161.xx.xx.12",
        "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c",
        "private_ip_address": "192.168.10.5",
        "create_time": "2015-07-16 04:32:50",
        "bandwidth_id": "49c8825b-bed9-46ff-9416-704b96d876a2",
        "bandwidth_share_type": "PER",
"bandwidth_size": 10,    //The EIP bandwidth size is 10 Mbit/s.
        "ip_version": 4
    }
}