Consulta de la lista de monitores de conexión VPN
Función
Esta API se utiliza para consultar la lista de monitores de conexión VPN.
URI
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. |
Parámetro |
Tipo |
Obligatorio |
Descripción |
---|---|---|---|
vpn_connection_id |
String |
No |
Especifica un ID de conexión VPN. |
enterprise_project_id |
Array |
No |
Especifica un ID de proyecto de empresa. |
- Ejemplo de las solicitudes
1. Consultar todos los monitores de conexión VPN.
GET https://{Endpoint}/v5/{project_id}/connection-monitors
2. Consultar monitores de VPN según un ID de conexión VPN especificado.GET https://{Endpoint}/v5/{project_id}/connection-monitors?vpn_connection_id={vpn_connection_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
connection_monitors
Array of ConnectionMonitorInfo
Especifica el objeto connection_monitor.
request_id
String
Especifica un ID de solicitud.
Tabla 4 ConnectionMonitorInfo Parámetro
Tipo
Descripción
id
String
- Especifica el ID de un monitor de conexión VPN.
- El valor es un UUID que contiene 36 caracteres.
status
String
vpn_connection_id
String
- Especifica el ID de la conexión VPN que se va a supervisar.
- El valor es un UUID que contiene 36 caracteres.
type
String
- Especifica el tipo de objetos que se van a supervisar.
- El valor solo puede ser gateway.
source_ip
String
Especifica la dirección de origen que se va a supervisar.
destination_ip
String
Especifica la dirección de destino que se va a supervisar.
proto_type
String
- Especifica el protocolo utilizado por NQA.
- El valor solo puede ser icmp.
- Ejemplo de las respuestas
1. Respuesta a la solicitud de consulta de todos los monitores de conexión VPN
{ "connection_monitors":[ { "id":"76f64229-****-****-****-3907e2815b6d", "status":"ACTIVE", "vpn_connection_id":"2342adf2-****-****-****-12aq511s0917", "type":"gateway", "source_ip":"88.***.***.60", "destination_ip":"88.***.***.32", "proto_type":"icmp" }, { "id":"85t53318-****-****-****-zq9312525f6t", "status":"ACTIVE", "vpn_connection_id":"cae286f2-****-****-****-e22416ca1220", "type":"gateway", "source_ip":"89.***.***.21", "destination_ip":"88.***.***.12", "proto_type":"icmp" } ], "request_id": "531f8b2c-ec55-45d8-90a3-ede922f7d63c" }
- 2. Respuesta a la solicitud de consulta de monitores basada en un ID de conexión VPN especificado
{ "connection_monitors":[ { "id":"76f64229-****-****-****-3907e2815b6d", "status":"ACTIVE", "vpn_connection_id":"2342adf2-****-****-****-12aq511s0917", "type":"gateway", "source_ip":"88.***.***.60", "destination_ip":"88.***.***.32", "proto_type":"icmp" } ], "request_id": "05ab9b58-9b4c-4cee-8113-4b0f325f1dfc" }
Códigos de estado
Para obtener más información, véase Códigos de estado.