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> Conexión VPN> Consulta de la lista de conexiones VPN

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

Ver PDF

Consulta de la lista de conexiones VPN

Función

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

URI

GET /v5/{project_id}/vpn-connection

**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
vgw_ip	String	No	Especifica un ID de EIP o una dirección IP privada del gateway de VPN.
vgw_id	String	No	Especifica un ID de gateway de VPN.
enterprise_project_id	Array	No	Especifica un ID de proyecto de empresa.
limit	Integer	No	Especifica el número de registros devueltos en cada página durante la consulta de paginación. El valor varía de 0 a 200. El valor predeterminado es 200.
marker	String	No	Especifica el indicador de inicio para consultar la página actual. Si este parámetro se deja en blanco, se consulta la primera página. El marker para consultar la página siguiente es el next_marker del objeto page_info devuelto en la página actual. Este parámetro debe usarse junto con limit.

Solicitud

Parámetros de solicitud
No hay

Ejemplo de las solicitudes
1. Consultar todas las conexiones VPN.
```
GET https://{Endpoint}/v5/{project_id}/vpn-connection
```

2. Consultar las conexiones VPN de un vgw_ip especificado.

GET https://{Endpoint}/v5/{project_id}/vpn-connection?vgw_ip={vgw_ip}&limit={limit}&marker={marker}

3. Consultar las conexiones VPN de una instancia del gateway de VPN especificada.

GET https://{Endpoint}/v5/{project_id}/vpn-connection?vgw_id={vgw_id}&limit={limit}&marker={marker}

Respuesta

Parámetros de respuesta

Código de estado devuelto 200: operación exitosa

**Tabla 3** Parámetros en el cuerpo de respuesta
Parámetro	Tipo	Descripción
vpn_connections	Array of ResponseVpnConnection	Especifica el objeto de conexión VPN.
page_info	PageInfo	Especifica la información de paginación.
request_id	String	Especifica un ID de solicitud.
total_count	Long	Especifica el número total de conexiones de un tenant.

**Tabla 4** ResponseVpnConnection
Parámetro	Tipo	Descripción
id	String	Especifica un ID de conexión VPN. El valor es un UUID que contiene 36 caracteres.
name	String	Especifica un nombre de conexión VPN. Si no se especifica ningún nombre de conexión 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 (-).
status	String	Especifica el estado de la conexión VPN. Rango de valores: ERROR: anormal ACTIVE: normal DOWN: sin conexión PENDING_CREATE: creando PENDING_UPDATE: actualizando PENDING_DELETE: eliminando FREEZED: congelado
vgw_id	String	Especifica un ID de gateway de VPN. El valor es un UUID que contiene 36 caracteres.
vgw_ip	String	Especifica un ID de EIP o una dirección IP privada del gateway de VPN. El valor es un UUID que contiene 36 caracteres o una dirección IPv4 en notación decimal con puntos (por ejemplo, 192.168.45.7).
style	String	Especifica el modo de conexión. Rango de valores: POLICY: modo basado en políticas STATIC: modo de enrutamiento estático BGP: Modo de enrutamiento de BGP
cgw_id	String	Especifica un ID de gateway de cliente. El valor es un UUID que contiene 36 caracteres.
peer_subnets	Array of String	Especifica una subred de cliente. Este parámetro no se devuelve cuando el modo de asociación del gateway de VPN es ER y style es BGP o POLICY.
tunnel_local_address	String	Especifica la dirección de la interfaz de túnel configurada en el gateway VPN en modo basado en ruta. Este parámetro solo es válido cuando style es STATIC o BGP.
tunnel_peer_address	String	Especifica la dirección de la interfaz de túnel configurada en el dispositivo de gateway del cliente en modo basado en ruta. Este parámetro solo es válido cuando style es STATIC o BGP.
enable_nqa	Boolean	Especifica si NQA está habilitado. Este parámetro solo es válido cuando style es STATIC. El valor puede ser true o false.
policy_rules	Array of PolicyRule	Especifica reglas de política. Las reglas de política solo se devuelven cuando style tiene un valor de POLICY.
ikepolicy	IkePolicy	Especifica el objeto de política IKE.
ipsecpolicy	IpsecPolicy	Especifica el objeto de política IPsec.
created_at	String	Especifica la hora a la que se crea la conexión VPN.
updated_at	String	Especifica la hora de la última actualización.
enterprise_project_id	String	Especifica un ID de proyecto de empresa. El valor es un UUID que contiene 36 caracteres. El valor debe ser el mismo que el ID del proyecto de empresa del gateway VPN especificada por vgw_id.

**Tabla 5** PolicyRule
Parámetro	Tipo	Descripción
rule_index	Integer	Especifica un ID de regla. El valor varía de 0 a 50.
source	String	Especifica un bloque CIDR de origen.
destination	Array of String	Especifica un bloque CIDR de destino. Por ejemplo, un bloque CIDR de destino puede ser 192.168.52.0/24. Se puede devolver un máximo de 50 bloques CIDR de destino para cada regla de política.

**Tabla 6** IkePolicy
Parámetro	Tipo	Descripción
ike_version	String	Especifica la versión de IKE. El valor puede ser v1 o v2.
phase1_negotiation_mode	String	Especifica el modo de negociación. Este parámetro solo está disponible cuando la versión de IKE es v1. Rango de valores: main: asegura una alta seguridad durante la negociación. aggressive: asegura una negociación rápida y una alta tasa de éxito de la negociación.
authentication_algorithm	String	Especifica un algoritmo de autenticación. El valor puede ser sha2-512, sha2-384, sha2-256, sha1 o md5.
encryption_algorithm	String	Especifica un algoritmo de encriptación. El valor puede ser aes-256-gcm-16, aes-128-gcm-16, aes-256, aes-192, aes-128 o 3des.
dh_group	String	Especifica el grupo DH utilizado para el intercambio de claves en la fase 1. El valor puede ser group1, group2, group5, group14, group15, group16, group19, group20 o group21.
authentication_method	String	Especifica el método de autenticación utilizado durante la negociación IKE. Rango de valores: pre-share: clave precompartida
lifetime_seconds	Integer	Especifica la duración de la SA. Cuando expira la vida útil, una SA de IKE se actualiza automáticamente. El valor varía de 60 a 604800, en segundos.
local_id_type	String	Especifica el tipo de ID local. El valor puede ser ip o fqdn.
local_id	String	Especifica el ID local. Cuando local_id_type se establece en ip se devuelve la dirección IP del gateway de VPN correspondiente a la conexión VPN. Cuando local_id_type se establece en fqdn, se devuelve el ID local especificado durante la creación o actualización de la conexión VPN.
peer_id_type	String	Especifica el tipo de ID emparejado. El valor puede ser ip, fqdn o any.
peer_id	String	Especifica el ID emparejado. Cuando peer_id_type se establece en ip, se devuelve la dirección IP del gateway del cliente. Cuando peer_id_type se establece en fqdn, se devuelve el ID emparejado especificado durante la creación o actualización de la conexión VPN. Cuando peer_id_type se establece en any, no se devuelve ningún dato.
dpd	Dpd	Especifica el objeto DPD.

**Tabla 7** Dpd
Parámetro	Tipo	Descripción
timeout	Integer	Especifica el intervalo para retransmitir los paquetes de DPD. El valor varía de 2 a 60, en segundos.
interval	Integer	Especifica el período de tiempo de espera inactivo del DPD. El valor varía de 10 a 3600, en segundos.
msg	String	Especifica el formato de los paquetes de DPD. Rango de valores: seq-hash-notify: indica que la carga útil de los paquetes de DPD está en la secuencia de notificación-hash. seq-notify-hash: indica que la carga útil de los paquetes de DPD está en la secuencia de hash - notificación.

**Tabla 8** IpsecPolicy
Parámetro	Tipo	Descripción
authentication_algorithm	String	Especifica un algoritmo de autenticación. El valor puede ser sha2-512, sha2-384, sha2-256, sha1 o md5.
encryption_algorithm	String	Especifica un algoritmo de encriptación. El valor puede ser aes-256-gcm-16, aes-128-gcm-16, aes-256, aes-192, aes-128 o 3des.
pfs	String	Especifica el grupo de claves DH que utiliza PFS. El valor puede ser group1, group2, group5, group14, group15, group16, group19, group20, group21 o disable.
transform_protocol	String	Especifica el protocolo de transferencia. Rango de valores: esp: protocolo de carga útil de seguridad encapsulado
lifetime_seconds	Integer	Especifica la duración de un túnel establecido a través de una conexión IPsec. El valor oscila entre 30 y 604800, en segundos.
encapsulation_mode	String	Especifica el modo de encapsulación de paquetes. Rango de valores: tunnel: encapsula paquetes en modo túnel.

**Tabla 9** PageInfo
Parámetro	Tipo	Descripción
next_marker	String	Especifica el marcador de la página siguiente. El valor es la hora en que se creó el último recurso de la última respuesta a la consulta.
current_count	Integer	Especifica el número de recursos de la lista. Si el valor de current_count es menor que el valor de limit en la solicitud de consulta, la página actual será la última página.

Ejemplo de las respuestas

1. Responder a la solicitud de consulta de todas las conexiones VPN

{
    "vpn_connections": [{
            "id": "228a68f0-****-****-****-a9919a3ea3de",
            "name": "vpn-56ea",
            "status": "DOWN",
            "vgw_id": "ba90819b-****-****-****-3a01622856a5",
            "vgw_ip": "3ea3b006-****-****-****-ae180ae07885",
            "style": "STATIC",
            "cgw_id": "537d9c26-****-****-****-99364a410f00",
            "peer_subnets": [
                "192.168.1.0/24"
            ],
            "tunnel_local_address": "169.254.149.2/30",
            "tunnel_peer_address": "169.254.149.1/30",
            "enable_nqa": true,
            "ikepolicy": {
                "ike_version": "v2",
                "authentication_algorithm": "sha2-256",
                "encryption_algorithm": "aes-128",
                "dh_group": "group14",
                "authentication_method": "pre-share",
                "lifetime_seconds": 86400,
                "local_id_type": "ip",
                "local_id": "10.1.1.216",
                "peer_id_type": "ip",
                "peer_id": "10.0.1.67",
                "dpd": {
                    "timeout": 15,
                    "interval": 30,
                    "msg": "seq-hash-notify"
                }
            },
            "ipsecpolicy": {
                "authentication_algorithm": "sha2-256",
                "encryption_algorithm": "aes-128",
                "pfs": "group14",
                "transform_protocol": "esp",
                "lifetime_seconds": 3600,
                "encapsulation_mode": "tunnel"
            },
            "created_at": "2022-12-11T13:59:59.633Z",
            "updated_at": "2022-12-11T13:59:59.633Z",
            "enterprise_project_id": "0"
        },
        {
            "id": "a4df33ca-****-****-****-410a7dd6973f",
            "name": "vpn-15ea",
            "status": "DOWN",
            "vgw_id": "02217fb1-****-****-****-806ea291a8f2",
            "vgw_ip": "f5acac2c-****-****-****-72b819a5f525",
            "style": "POLICY",
            "cgw_id": "10a4496f-****-****-****-7510f4b2af33",
            "tunnel_local_address": "169.254.77.169/30",
            "tunnel_peer_address": "169.254.77.170/30",
            "enable_nqa": false,
            "policy_rules": [{
                "rule_index": 1,
                "source": "10.0.0.0/24",
                "destination": [
                    "192.168.44.0/24"
                ]
            }],
            "ikepolicy": {
                "ike_version": "v2",
                "authentication_algorithm": "sha2-256",
                "encryption_algorithm": "aes-128",
                "dh_group": "group14",
                "authentication_method": "pre-share",
                "lifetime_seconds": 3600,
                "local_id_type": "ip",
                "local_id": "88.88.201.167",
                "peer_id_type": "ip",
                "peer_id": "10.111.222.21",
                "dpd": {
                    "interval": 30,
                    "timeout": 15,
                    "msg": "seq-hash-notify"
                }
            },
            "ipsecpolicy": {
                "authentication_algorithm": "sha2-256",
                "encryption_algorithm": "aes-128",
                "pfs": "group14",
                "transform_protocol": "esp",
                "lifetime_seconds": 3600,
                "encapsulation_mode": "tunnel"
            },
            "created_at": "2022-12-09T07:24:27.674Z",
            "updated_at": "2022-12-09T07:24:27.674Z",
            "enterprise_project_id": "0"
        }
    ],
    "page_info": {
        "next_marker": "2022-12-09T07:24:27.674Z",
        "current_count": 2
    },
    "request_id": "1d94a4e8-fdc2-7bfd-943e-19bfa9b234ac",
    "total_count": 2
}

2. Responder a la solicitud de consulta de conexiones VPN con un vgw_ip especificado

{
    "vpn_connections": [
        {
            "id": "8fa335dd-****-****-****-78bb55a8bb04",
            "name": "vpn-2acd",
            "status": "DOWN",
            "vgw_id": "02217fb1-****-****-****-806ea291a8f2",
            "vgw_ip": "f5acac2c-****-****-****-72b819a5f525",
            "style": "STATIC",
            "cgw_id": "eba04567-****-****-****-5b0352f89af0",
            "peer_subnets": [
                "192.168.44.0/24"
            ],
            "tunnel_local_address": "169.254.58.225/30",
            "tunnel_peer_address": "169.254.58.226/30",
            "enable_nqa": false,
            "ikepolicy": {
                "ike_version": "v2",
                "authentication_algorithm": "sha2-256",
                "encryption_algorithm": "aes-128",
                "dh_group": "group14",
                "authentication_method": "pre-share",
                "lifetime_seconds": 3600,
                "local_id_type": "ip",
                "local_id": "88.***.***.167",
                "peer_id_type": "ip",
                "peer_id": "10.***.***.9",
                "dpd": {
                    "timeout": 15,
                    "interval": 30,
                    "msg": "seq-hash-notify"
                }
            },
            "ipsecpolicy": {
                "authentication_algorithm": "sha2-256",
                "encryption_algorithm": "aes-128",
                "pfs": "group14",
                "transform_protocol": "esp",
                "lifetime_seconds": 3600,
                "encapsulation_mode": "tunnel"
            },
            "created_at": "2022-12-11T14:24:25.115Z",
            "updated_at": "2022-12-11T14:24:25.115Z",
            "enterprise_project_id": "0"
        },
        {
            "id": "a4df33ca-****-****-****-410a7dd6973f",
            "name": "vpn-15ea",
            "status": "DOWN",
            "vgw_id": "02217fb1-****-****-****-806ea291a8f2",
            "vgw_ip": "f5acac2c-****-****-****-72b819a5f525",
            "style": "POLICY",
            "cgw_id": "10a4496f-****-****-****-7510f4b2af33",
            "tunnel_local_address": "169.254.77.169/30",
            "tunnel_peer_address": "169.254.77.170/30",
            "enable_nqa": false,
            "policy_rules": [
                {
                    "rule_index": 1,
                    "source": "10.0.0.0/24",
                    "destination": [
                        "192.168.44.0/24"
                    ]
                }
            ],
            "ikepolicy": {
                "ike_version": "v2",
                "authentication_algorithm": "sha2-256",
                "encryption_algorithm": "aes-128",
                "dh_group": "group14",
                "authentication_method": "pre-share",
                "lifetime_seconds": 3600,
                "local_id_type": "ip",
                "local_id": "88.88.201.167",
                "peer_id_type": "ip",
                "peer_id": "10.111.222.21",
                "dpd": {
                    "interval": 30,
                    "timeout": 15,
                    "msg": "seq-hash-notify"
                }
            },
            "ipsecpolicy": {
                "authentication_algorithm": "sha2-256",
                "encryption_algorithm": "aes-128",
                "pfs": "group14",
                "transform_protocol": "esp",
                "lifetime_seconds": 3600,
                "encapsulation_mode": "tunnel"
            },
            "created_at": "2022-12-11T13:59:59.633Z",
            "updated_at": "2022-12-11T13:59:59.633Z",
            "enterprise_project_id": "0"
        }
    ],
    "page_info": {
        "next_marker": "2022-12-11T13:59:59.633Z",
        "current_count": 2
    },
    "request_id": "1d94a4e8-fdc2-7bfd-943e-19bfa9b234ac",
    "total_count": 12
}

3. Responder a la solicitud de consulta de conexiones VPN de una instancia de gateway de VPN especificada

{
    "vpn_connections": [
        {
            "id": "8fa335dd-****-****-****-78bb55a8bb04",
            "name": "vpn-2acd",
            "status": "DOWN",
            "vgw_id": "02217fb1-****-****-****-806ea291a8f2",
            "vgw_ip": "f5acac2c-****-****-****-72b819a5f525",
            "style": "STATIC",
            "cgw_id": "eba04567-****-****-****-5b0352f89af0",
            "peer_subnets": [
                "192.168.44.0/24"
            ],
            "tunnel_local_address": "169.254.58.225/30",
            "tunnel_peer_address": "169.254.58.226/30",
            "enable_nqa": false,
            "ikepolicy": {
                "ike_version": "v2",
                "authentication_algorithm": "sha2-256",
                "encryption_algorithm": "aes-128",
                "dh_group": "group14",
                "authentication_method": "pre-share",
                "lifetime_seconds": 3600,
                "local_id_type": "ip",
                "local_id": "88.***.***.167",
                "peer_id_type": "ip",
                "peer_id": "10.***.***.9",
                "dpd": {
                    "timeout": 15,
                    "interval": 30,
                    "msg": "seq-hash-notify"
                }
            },
            "ipsecpolicy": {
                "authentication_algorithm": "sha2-256",
                "encryption_algorithm": "aes-128",
                "pfs": "group14",
                "transform_protocol": "esp",
                "lifetime_seconds": 3600,
                "encapsulation_mode": "tunnel"
            },
            "created_at": "2022-12-11T14:24:25.115Z",
            "updated_at": "2022-12-11T14:24:25.115Z",
            "enterprise_project_id": "0"
        },
        {
            "id": "a4df33ca-****-****-****-410a7dd6973f",
            "name": "vpn-15ea",
            "status": "DOWN",
            "vgw_id": "02217fb1-****-****-****-806ea291a8f2",
            "vgw_ip": "f5acac2c-****-****-****-72b819a5f525",
            "style": "POLICY",
            "cgw_id": "10a4496f-****-****-****-7510f4b2af33",
            "tunnel_local_address": "169.254.77.169/30",
            "tunnel_peer_address": "169.254.77.170/30",
            "enable_nqa": false,
            "policy_rules": [
                {
                    "rule_index": 1,
                    "source": "10.0.0.0/24",
                    "destination": [
                        "192.168.44.0/24"
                    ]
                }
            ],
            "ikepolicy": {
                "ike_version": "v2",
                "authentication_algorithm": "sha2-256",
                "encryption_algorithm": "aes-128",
                "dh_group": "group14",
                "authentication_method": "pre-share",
                "lifetime_seconds": 3600,
                "local_id_type": "ip",
                "local_id": "88.88.201.167",
                "peer_id_type": "ip",
                "peer_id": "10.111.222.21",
                "dpd": {
                    "interval": 30,
                    "timeout": 15,
                    "msg": "seq-hash-notify"
                }
            },
            "ipsecpolicy": {
                "authentication_algorithm": "sha2-256",
                "encryption_algorithm": "aes-128",
                "pfs": "group14",
                "transform_protocol": "esp",
                "lifetime_seconds": 3600,
                "encapsulation_mode": "tunnel"
            },
            "created_at": "2022-12-11T13:59:59.633Z",
            "updated_at": "2022-12-11T13:59:59.633Z",
            "enterprise_project_id": "0"
        }
    ],
    "page_info": {
        "next_marker": "2022-12-11T13:59:59.633Z",
        "current_count": 2
    },
    "request_id": "1d94a4e8-fdc2-7bfd-943e-19bfa9b234ac",
    "total_count": 12
}