Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.
Atualizado em 2024-09-25 GMT+08:00

Querying EIPs

Function

This API is used to query EIPs.

URI

GET /v1/{project_id}/publicips

Tabela 1 describes the parameters.
Tabela 1 Parameter description

Name

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

marker

No

String

Especifica um ID de recurso para consulta de paginação, indicando que a consulta começa a partir do próximo registro do ID de recurso especificado.

Este parâmetro pode trabalhar em conjunto com o parâmetro limit.

  • Se os parâmetros marker e limit não forem passados, os registros de recursos na primeira página serão retornados.
  • Se o parâmetro marker não for passado e o valor do parâmetro limit for definido como 10, os primeiros 10 registros de recurso serão devolvidos.
  • Se o valor do parâmetro marker for definido como o ID de recurso do 10º registro e o valor do parâmetro limit for definido como 10, os registros de recurso do 11º ao 20º serão retornados.
  • Se o valor do parâmetro marker for definido como o ID do recurso do 10º registro e o parâmetro limit não for passado, os registros de recursos a partir do 11º registro (incluindo o 11º) serão retornados.

limit

No

Integer

Especifica o número de registros que serão retornados em cada página. O valor é de 0 a intmax.

limit pode ser usado em conjunto com o marker. Para obter detalhes, consulte a descrição do parâmetro de marker.

port_id

No

Array of strings

Specifies the port ID of the EIP.

public_ip_address

No

Array of strings

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

private_ip_address

No

Array of strings

  • Specifies the private IP address bound to the EIP.
  • This parameter is returned only if the private IP address is bound to the EIP.

id

No

Array of strings

Specifies the ID of the EIP, which uniquely identifies the EIP.

Request Message

  • Request parameter
    Tabela 2 Request header parameter

    Parameter

    Mandatory

    Type

    Description

    X-Auth-Token

    Yes

    String

    Specifies the user token. The token can be obtained by calling the IAM API used for obtaining a user token. The value of X-Subject-Token in the response header is the user token.

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

Response Message

  • Response parameter
    Tabela 3 Response parameter

    Name

    Type

    Description

    publicips

    Array of publicips objects

    Specifies the EIP object. For details, see Tabela 4.

    Tabela 4 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)

    profile

    Object

    Specifies the additional parameters, including the order ID and product ID. For details, see Tabela 5.

    type

    String

    • Specifies the EIP type.
    • The value can be 5_bgp (dynamic BGP) or 5_sbgp (static BGP).
      • 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
      • CN-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 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.

    public_ipv6_address

    String

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

    ip_version

    Integer

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

    • 4: IPv4
    • 6: IPv6

    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.

    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

    bandwidth_name

    String

    Specifies the bandwidth name.

    alias

    String

    Specifies the EIP name.

    enterprise_project_id

    String

    • Specifies the enterprise project ID. The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-).
    • When assigning an EIP, you need to associate an enterprise project ID with the EIP.
    • If this parameter is not specified, the default value is 0, which indicates that the default enterprise project is used.

    public_border_group

    String

    Specifies whether it is in a central site or an edge site.

    Values:

    • center
    • Edge site name

    This resource can only be associated with an EIP of the same region.

    allow_share_bandwidth_types

    Array of strings

    • Specifies the types of the shared bandwidth to which the EIP can be added.
    • If the list is empty, the EIP cannot be added to any shared bandwidth.
    • The EIP can be added only to the shared bandwidth of these types.
    Tabela 5 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
    {
        "publicips": [
            {
                "id": "6285e7be-fd9f-497c-bc2d-dd0bdea6efe0",
                "status": "DOWN",
                "profile": {
                "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,
                "bandwidth_name": "bandwidth-test",
                "enterprise_project_id":"b261ac1f-2489-4bc7-b31b-c33c3346a439",
                "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,
                "bandwidth_name": "bandwidth-test1",
                "enterprise_project_id":"0",
                "ip_version": 4
            }
        ]
    }