Help Center> Elastic IP> API Reference> APIs> Elastic IP> Querying an EIP
View PDF

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

    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)
      • DOWN (Unbound)
      • ACTIVE (Bound)
      • ELB (Bound to a load balancer)
      • ERROR (Exceptions)

    profile

    Object

    Specifies the additional parameters, including the order ID and product ID. For details, see Table 4.

    If profile is specified, the EIP is in yearly/monthly billing mode.

    type

    String
    • Specifies the EIP type.
    • Possible values are 5_telcom (China Telecom), 5_union (China Unicom), 5_bgp (dynamic BGP), and 5_sbgp (static BGP).
      • CN Northeast-Dalian: 5_telcom and 5_union
      • CN South-Guangzhou: 5_bgp and 5_sbgp
      • CN East-Shanghai1: 5_bgp and 5_sbgp
      • CN East-Shanghai2: 5_bgp and 5_sbgp
      • CN North-Beijing1: 5_bgp and 5_sbgp
      • AP-Hong Kong: 5_bgp
      • AP-Bangkok: 5_bgp
      • AP-Singapore: 5_bgp
      • AF-Johannesburg: 5_bgp
      • CN Southwest-Guiyang1: 5_sbgp
      • CN North-Beijing4: 5_bgp and 5_sbgp
      • LA-Santiago: 5_bgp
      • LA-Sao Paulo1: 5_bgp
      • LA-Mexico City1: 5_bgp
      • LA-Buenos Aires1: 5_bgp
      • LA-Lima1: 5_bgp
      • LA-Santiago2: 5_bgp
    • Constraints:
      • The configured value must be supported by the system.
      • publicip_id is an IPv4 port. If type is not specified, the default value is 5_bgp.

    public_ipv6_address

    String

    Specifies the obtained EIP if IPv6 EIPs are available. This parameter does not exist if only IPv4 EIPs are available.

    public_ip_address

    String

    Specifies the obtained EIP if only IPv4 EIPs are available. Specifies the IPv4 address corresponding to the IPv6 address if IPv6 EIPs are available.

    ip_version

    Integer

    Specifies the IP address version. The value can be 4 or 6.

    • 4: IPv4 address
    • 6: IPv6 address

    private_ip_address

    String
    • Specifies the private IP address bound to the EIP.
    • This parameter is returned only when a 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.

    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
    • IPv6 addresses do not support bandwidth whose type is WHOLE.

    bandwidth_name

    String

    Specifies the bandwidth name.

    enterprise_project_id

    String
    • Specifies the enterprise project ID. The value can contain a maximum of 36 characters. It is string "0" or in UUID format with hyphens (-).
    • When assigning an EIP, you need to associate an enterprise project ID with the EIP.
    Table 4 Description of the profile field

    Name

    Type

    Description

    order_id

    String

    Specifies the order ID.

    product_id

    String

    Specifies the product ID.

    region_id

    String

    Specifies the region ID.

    user_id

    String

    Specifies the user ID.
  • Example response 
    {
    "publicip": {
        "id": "2ec9b78d-9368-46f3-8f29-d1a95622a568",
        "status": "DOWN",
        "profile": {
          "user_id": "35f2b308f5d64441a6fa7999fbcd4321",
          "product_id": "00301-48027-0--0",
          "region_id": "xxx",
          "order_id": "xxxxxxxxx"
        },
        "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.
        "bandwidth_name": "bandwidth-test",
        "enterprise_project_id":"b261ac1f-2489-4bc7-b31b-c33c3346a439",
        "ip_version": 4
    }
}

Status Code

See Status Codes.

Error Code

See Error Codes.

Parent topic: Elastic IP