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> Virtual Private Network> Referencia de la API> API de Professional Edition VPN> Gateway de VPN> Consulta de la lista de gateway de VPN

Actualización más reciente 2023-04-04 GMT+08:00

Ver PDF

Consulta de la lista de gateway de VPN

Función

Esta API se utiliza para consultar la lista de gateway de VPN.

URI

GET /v5/{project_id}/vpn-gateways

**Tabla 1** Descripción del parámetro
Parámetro	Tipo	Obligatorio	Descripción
project_id	String	Sí	Especifica un ID de proyecto. Puede obtener el ID del proyecto haciendo referencia a Obtención del ID del proyecto.

**Tabla 2** Parámetro en una solicitud de consulta
Parámetro	Tipo	Obligatorio	Descripción
enterprise_project_id	Array	No	Especifica un ID de proyecto de empresa.

Solicitud

Parámetros de solicitud
No hay

Ejemplo de las solicitudes
1. Consultar todos los gateway de VPN.
```
GET https://{Endpoint}/v5/{project_id}/vpn-gateways
```
2. Consultar los gateway de VPN basados en un ID de proyecto de empresa especificado.
```
GET https://{Endpoint}/v5/{project_id}/vpn-gateways?enterprise_project_id={enterprise_project_id}
```

Respuesta

Parámetros de respuesta

Código de estado devuelto 200: consulta exitosa

**Tabla 3** Parámetros en el cuerpo de respuesta
Parámetro	Tipo	Descripción
vpn_gateways	Array of ResponseVpnGateway	Especifica la información del gateway.
request_id	String	Especifica un ID de solicitud.

**Tabla 4** ResponseVpnGateway
Parámetro	Tipo	Descripción
id	String	Especifica un ID de gateway de VPN. El valor es un UUID que contiene 36 caracteres.
name	String	Especifica un nombre de gateway de VPN. Si no se especifica ningún nombre de gateway de VPN, el sistema genera uno automáticamente. El valor es una cadena de 1 a 64 caracteres, que puede contener dígitos, letras, guiones bajos (_), y guiones (-).
network_type	String	Especifica el tipo de red del gateway de VPN. El valor puede ser public o private. El valor predeterminado es public.
status	String	Especifica el estado del gateway de VPN. Rango de valores: PENDING_CREATE: creando PENDING_UPDATE: actualizando PENDING_DELETE: eliminando ACTIVE: normal FAULT: anormal FREEZED: congelado
attachment_type	String	Especifica el modo de asociación. El valor puede ser vpc or er.
er_id	String	Especifica el ID de la instancia de router de empresa a la que se conecta al gateway de VPN. Este parámetro solo está disponible cuando attachment_type está establecido en er.
vpc_id	String	Cuando attachment_type se establece en vpc, vpc_id especifica el ID de la VPC de servicio asociada con el gateway de VPN. Cuando attachment_type se establece en er, vpc_id especifica el ID de la VPC de acceso utilizada por el gateway de VPN.
local_subnets	Array of String	Especifica una subred local. Esta subred es una subred del lado de la nube que necesita comunicarse con una red local a través de una VPN. Por ejemplo, una subred local puede ser 192.168.52.0/24. Este parámetro solo está disponible cuando attachment_type está establecido en vpc.
connect_subnet	String	Especifica el ID de la subred VPC utilizada por el gateway de VPN.
bgp_asn	Long	Especifica el número BGP de AS del gateway de VPN.
flavor	String	Especifica las especificaciones del gateway de VPN. Rango de valores: V1G: El ancho de banda máximo de reenvío es 1 Gbit/s. V300: El ancho de banda máximo de reenvío es 300 Mbit/s.
availability_zone_ids	Array of String	Especifica la AZ donde se despliega el gateway de VPN. Este parámetro está disponible cuando se especifica una AZ. Si no se especifica la AZ, este parámetro solo está disponible cuando el gateway de VPN está en el estado ACTIVE.
connection_number	Integer	Especifica el número máximo de conexiones VPN admitidas para el gateway de VPN
used_connection_number	Integer	Especifica el número de conexiones VPN que han utilizado el gateway de VPN.
used_connection_group	Integer	Especifica el número de grupos de conexión VPN que ha utilizado el gateway de VPN. Un grupo de conexiones consta de dos conexiones entre un gateway de cliente y un gateway de VPN. Por defecto, se incluyen 10 grupos de conexiones VPN gratuitos en la compra de un gateway de VPN.
enterprise_project_id	String	Especifica un ID de proyecto de empresa. El valor es un UUID que contiene 36 caracteres. Si no se especifica ningún ID de proyecto de empresa durante la creación del gateway de VPN, se devuelve 0 que indica que el recurso pertenece al proyecto de empresa predeterminado. Tenga en cuenta que 0 no es el ID de un proyecto de empresa existente.
master_eip	ResponseEip	Especifica la EIP activa que utiliza el gateway de VPN. Este parámetro está disponible cuando el gateway de VPN está en el estado ACTIVE.
slave_eip	ResponseEip	Especifica la EIP en espera utilizada por el gateway de VPN. Este parámetro está disponible cuando el gateway de VPN está en el estado ACTIVE.
created_at	String	Especifica la hora a la que se crea el gateway de VPN. Este parámetro está disponible cuando el gateway de VPN está en el estado ACTIVE.
updated_at	String	Especifica la hora de la última actualización. Este parámetro está disponible cuando el gateway de VPN está en el estado ACTIVE.
access_vpc_id	String	Especifica el ID de la VPC de acceso utilizada por el gateway de VPN. El valor es un UUID que contiene 36 caracteres.
access_subnet_id	String	Especifica el ID de la subred en la VPC de acceso utilizada por el gateway de VPN. El valor es un UUID que contiene 36 caracteres.
access_private_ips	Array of String	Especifica la lista de direcciones IP privadas utilizadas por el gateway de VPN para conectarse a un gateway de cliente cuando el tipo de red es una red privada. Por ejemplo, una única dirección IP privada puede ser 192.168.52.9. Este parámetro solo está disponible cuando network_type está establecido en private.

**Tabla 5** ResponseEip
Parámetro	Tipo	Descripción
id	String	Especifica un ID de EIP. El valor es un UUID que contiene 36 caracteres. Si se utiliza el proyecto de empresa predeterminado, se devuelve 0.
ip_version	Integer	Especifica la versión de EIP. El valor solo puede ser 4 que indica la dirección IPv4.
ip_billing_info	String	Especifica la información del pedido de EIP. Este parámetro solo está disponible para las EIP anuales/mensuales. El valor tiene el formato de order_id:product_id:region_id:project_id, por ejemplo: CS22******LIBIV:00301-**-0--0:br-iaas-odin1:0605768a**********c006c7e484aa
type	String	Especifica el tipo de la EIP. Para el rango de valores, consulte el campo de type en la Tabla 7 en Asignar una EIP.
ip_address	String	Especifica una EIP, es decir, una dirección IPv4 pública. El valor es una dirección IPv4, por ejemplo, 88.*.*.11.
charge_mode	String	Especifica el modo de facturación del ancho de banda de una EIP. Rango de valores: bandwidth: facturado por ancho de banda traffic: facturado por tráfico
bandwidth_id	String	Especifica el ID de ancho de banda de una EIP. El valor es un UUID que contiene 36 caracteres.
bandwidth_size	Integer	Especifica el ancho de banda (Mbit/s) de una EIP. El ancho de banda máximo de EIP varía según las regiones y depende del servicio de EIP. Puede enviar un ticket de servicio para aumentar el ancho de banda máximo de EIP en su cuenta. El valor puede ser 5, 10, 20, 50, 100, 200, 300, 500 o 1000.
bandwidth_name	String	Especifica el nombre de ancho de banda de una EIP. El valor es una string de 1 a 64 caracteres, que puede contener dígitos, letras, guiones bajos (_), guiones (-) y puntos (.).
bandwidth_billing_info	String	Especifica la información del pedido del ancho de banda de EIP. Este parámetro solo está disponible para las EIP anuales/mensuales. El valor tiene el formato de order_id:product_id:region_id:project_id, por ejemplo: CS22******LIBIV:00301-**-0--0:br-iaas-odin1:0605768a**********c006c7e484aa

Ejemplo de las respuestas

1. Responder a la solicitud de consulta de todos los gateway de VPN

{
    "vpn_gateways": [{
        "id": "8e1d0686-****-****-****-91f32fa1dfc8",
        "name": "vpngw-1af3",
        "network_type": "public",
        "status": "ACTIVE",
        "attachment_type": "vpc",
        "vpc_id": "91a74241-****-****-****-9b5f98c66c8c",
        "local_subnets": ["192.168.15.0/24"],
        "connect_subnet": "f5741286-****-****-****-2c82bd9ee114",
        "bgp_asn": 64512,
        "flavor": "V300",
        "availability_zone_ids": ["cn-south-1f", "cn-south-1e"],
        "connection_number": 200,
        "used_connection_number": 0,
        "used_connection_group": 0,
        "enterprise_project_id": "0",
        "master_eip": {
            "id": "8ff5d6b5-****-****-****-b9d598033153",
            "ip_version": 4,
            "type": "5_bgp",
            "ip_address": "88.***.***.111",
            "charge_mode": "bandwidth",
            "bandwidth_id": "aa62f8f2-****-****-****-b05b2b999715",
            "bandwidth_size": 300,
            "bandwidth_name": "vpngw-bandwidth-13a3"
        },
        "slave_eip": {
            "id": "08e7e927-****-****-****-26a6394021eb",
            "ip_version": 4,
            "type": "5_bgp",
            "ip_address": "88.***.***.199",
            "charge_mode": "bandwidth",
            "bandwidth_id": "887d61f7-****-****-****-38ee8232e27c",
            "bandwidth_size": 300,
            "bandwidth_name": "vpngw-bandwidth-1afb"
        },
        "created_at": "2022-11-28T02:36:16.834Z",
        "updated_at": "2022-11-28T02:36:16.834Z",
        "access_vpc_id": "91a74241-****-****-****-9b5f98c66c8c",
        "access_subnet_id": "f5741286-****-****-****-2c82bd9ee114",
    }, {
        "id": "66ddeacb-****-****-****-9a414b5bd7d5",
        "name": "vpngw-2be4",
        "network_type": "public",
        "status": "ACTIVE",
        "attachment_type": "er",
        "er_id": "c62fad0d-****-****-****-e06c4c351b9f",
        "bgp_asn": 64512,
        "flavor": "V300",
        "availability_zone_ids": ["cn-south-1f", "cn-south-1e"],
        "connection_number": 200,
        "used_connection_number": 0,
        "used_connection_group": 0,
        "enterprise_project_id": "0",
        "master_eip": {
            "id": "0f6d1415-****-****-****-edb2ee97c9cc",
            "ip_version": 4,
            "type": "5_bgp",
            "ip_address": "88.***.***.251",
            "charge_mode": "bandwidth",
            "bandwidth_id": "e93767cc-****-****-****-bac2987f90a4",
            "bandwidth_size": 300,
            "bandwidth_name": "vpngw-bandwidth-10c3"
        },
        "slave_eip": {
            "id": "7b46b62f-****-****-****-6b8e44312416",
            "ip_version": 4,
            "type": "5_bgp",
            "ip_address": "88.***.***.102",
            "charge_mode": "bandwidth",
            "bandwidth_id": "bde3557e-****-****-****-629a3754ae07",
            "bandwidth_size": 300,
            "bandwidth_name": "vpngw-bandwidth-18bd",
        },
        "created_at": "2022-11-28T02:22:27.24Z",
        "updated_at": "2022-11-28T02:22:27.24Z",
        "access_vpc_id": "0cf79a3f-****-****-****-d7ace626b0fa",
        "access_subnet_id": "f5741286-****-****-****-2c82bd9ee114",
    }],
    "request_id": "de1b6caf-d024-4dac-850e-645af40c84f3"
}

2. Responder a la solicitud de consulta de los gateway de VPN basados en un ID de proyecto de empresa especificado

{
    "vpn_gateways": [{
        "id": "8e1d0686-****-****-****-91f32fa1dfc8",
        "name": "vpngw-1af3",
        "network_type": "public",
        "status": "ACTIVE",
        "attachment_type": "vpc",
        "vpc_id": "91a74241-****-****-****-9b5f98c66c8c",
        "local_subnets": ["192.168.15.0/24"],
        "connect_subnet": "f5741286-****-****-****-2c82bd9ee114",
        "bgp_asn": 64512,
        "flavor": "V300",
        "availability_zone_ids": ["cn-south-1f", "cn-south-1e"],
        "connection_number": 200,
        "used_connection_number": 0,
        "used_connection_group": 0,
        "enterprise_project_id": "7354dda9-****-****-****-a6b08fb92043",
        "master_eip": {
            "id": "8ff5d6b5-****-****-****-b9d598033153",
            "ip_version": 4,
            "type": "5_bgp",
            "ip_address": "88.***.***.111",
            "charge_mode": "bandwidth",
            "bandwidth_id": "aa62f8f2-****-****-****-b05b2b999715",
            "bandwidth_size": 300,
            "bandwidth_name": "vpngw-bandwidth-13a3"
        },
        "slave_eip": {
            "id": "08e7e927-****-****-****-26a6394021eb",
            "ip_version": 4,
            "type": "5_bgp",
            "ip_address": "88.***.***.199",
            "charge_mode": "bandwidth",
            "bandwidth_id": "887d61f7-****-****-****-38ee8232e27c",
            "bandwidth_size": 300,
            "bandwidth_name": "vpngw-bandwidth-1afb"
        },
        "created_at": "2022-11-28T02:36:16.834Z",
        "updated_at": "2022-11-28T02:36:16.834Z",
        "access_vpc_id": "91a74241-****-****-****-9b5f98c66c8c",
        "access_subnet_id": "f5741286-****-****-****-2c82bd9ee114"
    }, {
        "id": "66ddeacb-****-****-****-9a414b5bd7d5",
        "name": "vpngw-2be4",
        "network_type": "private",
        "status": "ACTIVE",
        "attachment_type": "er",
        "er_id": "c62fad0d-****-****-****-e06c4c351b9f",
        "bgp_asn": 64512,
        "flavor": "V300",
        "availability_zone_ids": ["cn-south-1f", "cn-south-1e"],
        "connection_number": 200,
        "used_connection_number": 0,
        "used_connection_group": 0,
        "enterprise_project_id": "7354dda9-****-****-****-a6b08fb92043",
        "access_private_ips": [ "192.168.4.7", "192.168.4.99" ],
        "created_at": "2022-11-28T02:22:27.24Z",
        "updated_at": "2022-11-28T02:22:27.24Z",
        "access_vpc_id": "0cf79a3f-****-****-****-d7ace626b0fa",
        "access_subnet_id": "f5741286-****-****-****-2c82bd9ee114"
    }],
    "request_id": "bfa819a1-e824-4799-8e72-21a35dad97c9"
}