Updated on 2024-03-05 GMT+08:00

Querying EIPs

Function

This API is used to query EIPs.

URI

GET /v1/{project_id}/publicips

Table 1 describes the parameters.
Table 1 Parameter description

Name

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID.

marker

No

String

Specifies a resource ID for pagination query, indicating that the query starts from the next record of the specified resource ID.

This parameter can work together with the parameter limit.

  • If parameters marker and limit are not passed, resource records on the first page will be returned.
  • If the parameter marker is not passed and the value of parameter limit is set to 10, the first 10 resource records will be returned.
  • If the value of the parameter marker is set to the resource ID of the 10th record and the value of parameter limit is set to 10, the 11th to 20th resource records will be returned.
  • If the value of the parameter marker is set to the resource ID of the 10th record and the parameter limit is not passed, resource records starting from the 11th records (including 11th) will be returned.

limit

No

Integer

Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000.

limit can be used together with marker. For details, see the parameter description of marker.

Request Message

  • Request parameter

    None

  • Example request
    GET https://{Endpoint}/v1/{project_id}/publicips?limit={limit}&marker={marker}

Response Message

  • Response parameter
    Table 2 Response parameter

    Name

    Type

    Description

    publicips

    Array of publicips objects

    Specifies the EIP object. For details, see Table 3.

    Table 3 Description of the publicips 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)

    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.

    public_ip_address

    String

    Specifies the obtained EIP if only IPv4 EIPs are available.

    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
    {
        "publicips": [
            {
                "id": "6285e7be-fd9f-497c-bc2d-dd0bdea6efe0",
                "status": "DOWN",
                "alias": "tom",
                "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,
                "ip_version": 4
            },
            {
                "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,
                "ip_version": 4
            }
        ]
    }

Status Code

See Status Codes.

Error Code

See Error Codes.