Consulta da lista de monitores de conexão de VPN
Função
Esta API é usada para consultar a lista de monitores de conexão de VPN.
URI
Parâmetro |
Tipo |
Obrigatório |
Descrição |
---|---|---|---|
project_id |
String |
Sim |
Especifica um ID do projeto. Você pode obter o ID do projeto, referindo-se a Obtenção do ID do projeto. |
Parâmetro |
Tipo |
Obrigatório |
Descrição |
---|---|---|---|
vpn_connection_id |
String |
Não |
Especifica um ID de conexão de VPN. |
enterprise_project_id |
Array |
Não |
Especifica um ID do projeto empresarial. |
- Exemplo de solicitações
1. Consultar todos os monitores de conexão de VPN.
GET https://{Endpoint}/v5/{project_id}/connection-monitors
2. Consultar monitores de VPN com base em um ID de conexão de VPN especificado.GET https://{Endpoint}/v5/{project_id}/connection-monitors?vpn_connection_id={vpn_connection_id}
Resposta
- Parâmetros de resposta
Código de status 200 retornado: consulta bem-sucedida
Tabela 3 Parâmetros no corpo da resposta Parâmetro
Tipo
Descrição
connection_monitors
Array of ConnectionMonitorInfo
Especifica o objeto de connect_monitor.
request_id
String
Especifica um ID da solicitação.
Tabela 4 ConnectionMonitorInfo Parâmetro
Tipo
Descrição
id
String
- Especifica o ID de um monitor de conexão de VPN.
- O valor é um UUID contendo 36 caracteres.
status
String
vpn_connection_id
String
- Especifica o ID da conexão de VPN a ser monitorada.
- O valor é um UUID contendo 36 caracteres.
type
String
- Especifica o tipo de objetos a serem monitorados.
- O valor só pode ser gateway.
source_ip
String
Especifica o endereço de origem a ser monitorado.
destination_ip
String
Especifica o endereço de destino a ser monitorado.
proto_type
String
- Especifica o protocolo usado por NQA.
- O valor só pode ser icmp.
- Exemplo de respostas
1. Resposta à solicitação de consulta de todos os monitores de conexão de 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. Resposta à solicitação de consulta de monitores com base em um ID de conexão de 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 status
Para mais detalhes, consulte Códigos de status.