Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.

Central de ajuda> Virtual Private Network> Referência de API> APIs da VPN da edição profissional> Conexão de VPN> Consulta da lista de conexões de VPN

Atualizado em 2023-08-04 GMT+08:00

Ver PDF

Consulta da lista de conexões de VPN

Função

Esta API é usada para consultar a lista de conexões de VPN.

URI

GET /v5/{project_id}/vpn-connection

**Tabela 1** Descrição do parâmetro
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.

**Tabela 2** Parâmetro em uma solicitação de consulta
Parâmetro	Tipo	Obrigatório	Descrição
vgw_ip	String	Não	Especifica um ID do EIP ou um endereço IP privado do gateway de VPN.
vgw_id	String	Não	Especifica um ID de gateway de VPN.
enterprise_project_id	Array	Não	Especifica um ID do projeto empresarial.
limit	Integer	Não	Especifica o número de registros retornados em cada página durante a consulta de paginação. O valor varia de 0 a 200. O valor padrão é 200.
marker	String	Não	Especifica o sinalizador de início para consultar a página atual. Se este parâmetro for deixado em branco, a primeira página será consultada. O marker para consultar a próxima página é o next_marker no objeto page_info retornado na página atual. Este parâmetro deve ser usado junto com limit.

Solicitação

Parâmetros de solicitação
Nenhum

Exemplo de solicitações
1. Consultar todas as conexões de VPN.
```
GET https://{Endpoint}/v5/{project_id}/vpn-connection
```

2. Consultar conexões de VPN de um vgw_ip especificado.

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

3. Consultar conexões de VPN de uma instância de gateway de VPN especificada.

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

Resposta

Parâmetros de resposta

Código de status 200 retornado: operação bem-sucedida

**Tabela 3** Parâmetros no corpo da resposta
Parâmetro	Tipo	Descrição
vpn_connections	Array of ResponseVpnConnection	Especifica o objeto de conexão de VPN.
page_info	PageInfo	Especifica as informações da paginação.
request_id	String	Especifica um ID da solicitação.
total_count	Long	Especifica o número total de conexões de um locatário.

**Tabela 4** ResponseVpnConnection
Parâmetro	Tipo	Descrição
id	String	Especifica um ID de conexão de VPN. O valor é um UUID contendo 36 caracteres.
name	String	Especifica um nome de conexão de VPN. Se nenhum nome de conexão de VPN for especificado, o sistema gerará um automaticamente. O valor é uma cadeia de 1 a 64 caracteres, que pode conter dígitos, letras, sublinhados (_) e hifens (-).
status	String	Especifica o status da conexão de VPN. Intervalo de valores: ERROR: anormal ACTIVE: normal DOWN: não conectado PENDING_CREATE: criando PENDING_UPDATE: atualizando PENDING_DELETE: excluindo FREEZED: congelado
vgw_id	String	Especifica um ID de gateway de VPN. O valor é um UUID contendo 36 caracteres.
vgw_ip	String	Especifica um ID do EIP ou um endereço IP privado do gateway de VPN. O valor é um UUID contendo 36 caracteres ou um endereço IPv4 em notação decimal pontilhada (por exemplo, 192.168.45.7).
style	String	Especifica o modo de conexão. Intervalo de valores: POLICY: modo baseado em políticas STATIC: modo de roteamento estático BGP: modo de roteamento BGP
cgw_id	String	Especifica um ID de gateway de cliente. O valor é um UUID contendo 36 caracteres.
peer_subnets	Array of String	Especifica uma sub-rede de cliente. Este parâmetro não é retornado quando o modo de associação do gateway de VPN é ER e style é BGP ou POLICY.
tunnel_local_address	String	Especifica o endereço da interface de túnel configurado no gateway de VPN no modo baseado em rota. Este parâmetro é válido somente quando style é STATIC ou BGP.
tunnel_peer_address	String	Especifica o endereço da interface de túnel configurado no dispositivo de gateway de cliente no modo baseado em rota. Este parâmetro é válido somente quando style é STATIC ou BGP.
enable_nqa	Boolean	Especifica se NQA está ativada. Este parâmetro é válido somente quando style é STATIC. O valor pode ser true ou false.
policy_rules	Array of PolicyRule	Especifica regras de política. As regras de política são retornadas somente quando style é POLICY.
ikepolicy	IkePolicy	Especifica o objeto de política IKE.
ipsecpolicy	IpsecPolicy	Especifica o objecto de política IPsec.
created_at	String	Especifica a hora em que a conexão de VPN é criada.
updated_at	String	Especifica a hora da última atualização.
enterprise_project_id	String	Especifica um ID do projeto empresarial. O valor é um UUID contendo 36 caracteres. O valor deve ser o mesmo que o ID do projeto empresarial do gateway de VPN especificado por vgw_id.

**Tabela 5** PolicyRule
Parâmetro	Tipo	Descrição
rule_index	Integer	Especifica um ID de regra. O valor varia de 0 a 50.
source	String	Especifica um bloco CIDR de origem.
destination	Array of String	Especifica um bloco CIDR de destino. Por exemplo, um bloco CIDR de destino pode ser 192.168.52.0/24. Um máximo de 50 blocos CIDR de destino pode ser retornado para cada regra de política.

**Tabela 6** IkePolicy
Parâmetro	Tipo	Descrição
ike_version	String	Especifica a versão do IKE. O valor pode ser v1 ou v2.
phase1_negotiation_mode	String	Especifica o modo de negociação. Esse parâmetro está disponível somente quando a versão do IKE é v1. Intervalo de valores: main: garante alta segurança durante a negociação. aggressive: garante negociação rápida e uma alta taxa de sucesso de negociação.
authentication_algorithm	String	Especifica um algoritmo de autenticação. O valor pode ser sha2-512, sha2-384, sha2-256, sha1 ou md5.
encryption_algorithm	String	Especifica um algoritmo de criptografia. O valor pode ser aes-256-gcm-16, aes-128-gcm-16, aes-256, aes-192, aes-128 ou 3des.
dh_group	String	Especifica o grupo de DH usado para troca de chaves na fase 1. O valor pode ser group1, group2, group5, group14, group15, group16, group19, group20 ou group21.
authentication_method	String	Especifica o método de autenticação usado durante a negociação IKE. Intervalo de valores: pre-share: chave pré-compartilhada
lifetime_seconds	Integer	Especifica o tempo de vida da associação de segurança. Quando o tempo de vida expira, uma associação de segurança do IKE é atualizada automaticamente. O valor varia de 60 a 604800, em segundos.
local_id_type	String	Especifica o tipo de ID local. O valor pode ser ip ou fqdn.
local_id	String	Especifica o ID local. Quando local_id_type é definido como ip, o endereço IP do gateway de VPN correspondente à conexão de VPN é retornado. Quando local_id_type é definido como fqdn, o ID local especificado durante a criação ou atualização da conexão de VPN é retornado.
peer_id_type	String	Especifica o tipo de ID de par. O valor pode ser ip, fqdn ou any.
peer_id	String	Especifica o ID de par. Quando peer_id_type é definido como ip, o endereço IP do gateway de cliente é retornado. Quando peer_id_type é definido como fqdn, o ID de par especificado durante a criação ou atualização da conexão de VPN é retornado. Quando peer_id_type é definido como any, nenhum dado é retornado.
dpd	Dpd	Especifica o objeto da DPD.

**Tabela 7** Dpd
Parâmetro	Tipo	Descrição
timeout	Integer	Especifica o intervalo para retransmissão de pacotes da DPD. O valor varia de 2 a 60, em segundos.
interval	Integer	Especifica o período de tempo limite de inatividade da DPD. O valor varia de 10 a 3600, em segundos.
msg	String	Especifica o formato dos pacotes da DPD. Intervalo de valores: seq-hash-notify: indica que a carga útil de pacotes da DPD está na sequência de hash-notify. seq-notify-hash: indica que a carga útil de pacotes da DPD está na sequência de notify-hash.

**Tabela 8** IpsecPolicy
Parâmetro	Tipo	Descrição
authentication_algorithm	String	Especifica um algoritmo de autenticação. O valor pode ser sha2-512, sha2-384, sha2-256, sha1 ou md5.
encryption_algorithm	String	Especifica um algoritmo de criptografia. O valor pode ser aes-256-gcm-16, aes-128-gcm-16, aes-256, aes-192, aes-128 ou 3des.
pfs	String	Especifica o grupo de chaves DH usado pelo PFS. O valor pode ser group1, group2, group5, group14, group15, group16, group19, group20, group21 ou disable.
transform_protocol	String	Especifica o protocolo de transferência. Intervalo de valores: esp: encapsulamento de protocolo de carga útil de segurança
lifetime_seconds	Integer	Especifica o tempo de vida de um túnel estabelecido através de uma conexão IPsec. O valor varia de 30 a 604800, em segundos.
encapsulation_mode	String	Especifica o modo de encapsulamento de pacotes. Intervalo de valores: tunnel: encapsula pacotes em modo de túnel.

**Tabela 9** PageInfo
Parâmetro	Tipo	Descrição
next_marker	String	Especifica o marcador da próxima página. O valor é o momento em que o último recurso na última resposta de consulta foi criado.
current_count	Integer	Especifica o número de recursos na lista. Se o valor de current_count for menor que o valor de limit na solicitação de consulta, a página atual será a última página.

Exemplo de respostas

1. Resposta à solicitação de consultar todos os monitores de conexão de 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. Resposta à solicitação de consultar conexões de VPN com um 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. Resposta à solicitação de consultar conexões de VPN de uma instância 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
}