• Virtual Private Cloud

vpc
  1. Help Center
  2. Virtual Private Cloud
  3. API Reference
  4. APIs
  5. Elastic IP Address
  6. Querying EIPs

Querying EIPs

Function

This interface is used to query EIPs.

URI

GET /v1/{project_id}/publicips

Example:
/v1/{project_id}/publicips?limit=10&marker=4779ab1c-7c1a-44b1-a02e-93dfc361b32d
Table 1 Parameter description

Name

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

marker

No

String

Specifies the start resource ID of pagination query. If the parameter is left blank, only resources on the first page are queried.

limit

No

int

  • Specifies the number of records returned on each page.
  • The value ranges from 0 to intmax.

Request Message

  • Request parameter

    None

  • Example request

    None

Response Message

  • Response parameter
    Table 2 Response parameter

    Name

    Type

    Description

    publicips

    List data structure

    Specifies the EIP object.

    Table 3 Description of the publicips field

    Name

    Type

    Description

    id

    String

    Specifies the unique identifier of the 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)
      • NOTIFYING (Assigning)
      • NOTIFY_DELETE (Releasing)
      • PENDING_UPDATE (Updating)
      • DOWN (Unbound)
      • ACTIVE (Bound)
      • ELB (Bound to a load balancer)
      • ERROR (Failed)

    type

    String

    Specifies the EIP type.

    public_ip_address

    String

    Specifies the obtained EIP if only IPv4 EIPs are available.

    private_ip_address

    String

    • Specifies the private IP address bound with the EIP.
    • This parameter is returned only when a private IP address is bound with the EIP.

    port_id

    String

    • Specifies the port ID.
    • This parameter is returned only when a private IP address is bound with the EIP.

    tenant_id

    String

    Specifies the project ID.

    create_time

    String

    Specifies the time (UTC time) when the EIP was assigned.

    bandwidth_id

    String

    Specifies the ID of the bandwidth associated with the EIP.

    bandwidth_size

    int

    Specifies the bandwidth size.

    bandwidth_share_type

    String

    Specifies the dedicated bandwidth.

  • Example response
    {
        "publicips": [
            {
                "id": "6285e7be-fd9f-497c-bc2d-dd0bdea6efe0",
                "status": "DOWN",
                "type": "5_bgp",
                "public_ip_address": "161.xx.xx.9",
                "private_ip_address": "192.168.10.5",
                "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c",
                "create_time": "2015-07-16 04:22:32",
                "bandwidth_id": "3fa5b383-5a73-4dcb-a314-c6128546d855",
                "bandwidth_share_type": "PER",
                "bandwidth_size": 5
                
                
            },
            {
                "id": "80d5b82e-43b9-4f82-809a-37bec5793bd4",
                "status": "DOWN",
                "type": "5_bgp",
                "public_ip_address": "161.xx.xx.10",
                "private_ip_address": "192.168.10.6",
                "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c",
                "create_time": "2015-07-16 04:23:03",
                "bandwidth_id": "a79fd11a-047b-4f5b-8f12-99c178cc780a",
                "bandwidth_share_type": "PER",
                "bandwidth_size": 5
                
                
            }
        ]
    }

Status Codes

For details, see section Status Codes.

Error Codes

For details, see section Error Codes.