Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.

Centro de ayuda> Elastic IP> Referencia de la API> Las API> Elastic IP> Consulta de los EIP

Actualización más reciente 2022-11-08 GMT+08:00

Ver PDF

Consulta de los EIP

Función

Esta API se utiliza para consultar los EIP.

URI

GET /v1/{project_id}/publicips

Tabla 1 describe los parámetros.

**Tabla 1** Descripción del parámetro
Nombre	Obligatorio	Tipo	Descripción
project_id	Sí	String	Especifica el ID del proyecto.
marker	No	String	Especifica un ID de recurso para la consulta de paginación, que indica que la consulta comienza desde el siguiente registro del ID de recurso especificado. Este parámetro puede funcionar junto con el límite de parámetro. Si no se pasan los parámetros de marcador y límite, se devolverán los registros de recursos de la primera página. Si el marcador de parámetro no se pasa y el valor del límite de parámetro se establece en 10, se devolverán los primeros 10 registros de recursos. Si el valor del marcador de parámetro se establece en el ID de recurso del 10º registro y el valor del límite de parámetro se establece en 10, se devolverán los registros de recursos del 11º al 20º. Si el valor del marcador de parámetro se establece en el ID de recurso del 10º registro y no se pasa el límite de parámetro, se devolverán los registros de recursos que comienzan desde el 11º registro (incluido el 11º).
limit	No	Integer	Especifica el número de registros que se devolverán en cada página. El valor es de 0 a intmax. se puede utilizar junto con el marcador. Para obtener más información, consulte la descripción de parámetros del marcador.
port_id	No	Array of strings	Especifica el ID de puerto del EIP.
public_ip_address	No	Array of strings	Especifica el EIP obtenido si sólo están disponibles los EIP IPv4 o el EIP IPv4 correspondiente al EIP IPv6 si están disponibles los EIP IPv6.
private_ip_address	No	Array of strings	Especifica la dirección IP privada enlazada al EIP. Este parámetro se devuelve solo si la dirección IP privada está enlazada al EIP.
id	No	Array of strings	Especifica el ID del EIP, que identifica de forma exclusiva al EIP.

Mensaje de solicitud

Parámetro de solicitud

**Tabla 2** Parámetro de cabecera de solicitud
Parámetro	Obligatorio	Tipo	Descripción
X-Auth-Token	Sí	String	Especifica el token de usuario. El token se puede obtener llamando a la API de IAM utilizada para obtener un token de usuario. El valor de X-Subject-Token en el encabezado de respuesta es el token de usuario.

Ejemplo de la solicitud

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

Mensaje de la respuesta

Parámetro de respuesta

**Tabla 3** Parámetro de respuesta
Nombre	Tipo	Descripción
publicips	Array of publicips objects	Especifica el objeto EIP. Para más detalles, consulte Tabla 4.

**Tabla 4** Descripción del campo **publicips**
Nombre	Tipo	Descripción
id	String	Especifica el identificador único de un EIP.
status	String	Especifica el estado de EIP. Los valores posibles son los siguientes: FREEZED (Congelado) BIND_ERROR (Error de enlace) BINDING (Encuadernación) PENDING_DELETE (Liberación) PENDING_CREATE (Asignación) PENDING_UPDATE (Actualización) DOWN (sin consolidar) ACTIVE (Enlazado) ELB (Unido a un balanceador de carga) ERROR (Excepciones)
profile	Object	Especifica los parámetros adicionales, incluidos el ID de pedido y el ID de producto. Para más detalles, consulte Tabla 5.
type	String	Especifica el tipo de EIP. El valor puede ser 5_bgp (BGP dinámico) o 5_sbgp (BGP estático). CN South-Guangzhou: 5_bgp y 5_sbgp CN East-Shanghai1: 5_bgp y 5_sbgp CN East-Shanghai2: 5_bgp y 5_sbgp CN North-Beijing1: 5_bgp y 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 y 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 Restricciones: El valor configurado debe ser compatible con el sistema. publicip_id es un puerto IPv4. Si no se especifica publicip_type, el valor predeterminado es 5_bgp.
public_ip_address	String	Especifica el EIP obtenido si sólo están disponibles los EIP IPv4.Specifies the IPv4 address corresponding to the IPv6 address if IPv6 EIPs are available.
public_ipv6_address	String	Especifica el EIP obtenido si los EIP IPv6 están disponibles. Este parámetro no existe si solo están disponibles EIP IPv4.
ip_version	Integer	Especifica la versión de la dirección IP. El valor puede ser 4 o 6. 4: IPv4 6: IPv6
private_ip_address	String	Especifica la dirección IP privada enlazada al EIP. Este parámetro se devuelve solo si la dirección IP privada está enlazada al EIP.
port_id	String	Especifica el ID de puerto. Este parámetro se devuelve solo cuando un puerto está asociado con el EIP.
tenant_id	String	Especifica el ID del proyecto.
create_time	String	Especifica la hora (UTC) cuando se asigna el EIP.
bandwidth_id	String	Especifica el ID del ancho de banda EIP.
bandwidth_size	Integer	Especifica el ancho de banda (Mbit/s).
bandwidth_share_type	String	Especifica el tipo de ancho de banda EIP. El valor puede ser PER o WHOLE. PER: Ancho de banda dedicado WHOLE: Ancho de banda compartido
bandwidth_name	String	Especifica el nombre del ancho de banda.
alias	String	Especifica el nombre de EIP.
enterprise_project_id	String	Especifica el ID del proyecto de empresa. El valor es 0 o una string que contiene un máximo de 36 caracteres en formato UUID con guiones (-). Al asignar un EIP, debe asociar un ID de proyecto de empresa con el EIP. Si no se especifica este parámetro, el valor predeterminado es 0, que indica que se utiliza el proyecto de empresa predeterminado. NOTA: Para obtener más información acerca de los proyectos de empresa y cómo obtener los ID de proyecto de empresa, consulte la Guía del usuario de Enterprise Management.
public_border_group	String	Especifica si se encuentra en una ubicación central o en una ubicación de borde. Valores: center Edge site name Este recurso solo puede asociarse con un EIP de la misma región.
allow_share_bandwidth_types	Array of strings	Especifica los tipos de ancho de banda compartido al que se puede agregar el EIP. Si la lista está vacía, el EIP no se puede agregar a ningún ancho de banda compartido. El EIP solo se puede agregar al ancho de banda compartido de estos tipos.

**Tabla 5** Descripción del campo **profile**
Nombre	Tipo	Descripción
order_id	String	Especifica el ID de pedido.
product_id	String	Especifica el ID del producto.
region_id	String	Especifica el ID de la región.
user_id	String	Especifica el ID de usuario.

Ejemplo de la respuesta

{
    "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
        }
    ]
}