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.
Atualizado em 2023-08-04 GMT+08:00

Consulta de um gateway de VPN especificado

Função

Esta API é usada para consultar um gateway de VPN com um ID de gateway especificado.

URI

GET /v5/{project_id}/vpn-gateways/{vgw_id}
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.

vgw_id

String

Sim

Especifica um ID de gateway de VPN.

Solicitação

  • Parâmetros de solicitação

    Nenhum

  • Exemplo de solicitação
    GET https://{Endpoint}/v5/{project_id}/vpn-gateways/{vgw_id}

Resposta

  • Parâmetros de resposta

    Código de status 200 retornado: consulta bem-sucedida

    Tabela 2 Parâmetros no corpo da resposta

    Parâmetro

    Tipo

    Descrição

    vpn_gateway

    ResponseVpnGateway

    Especifica o objeto de gateway de VPN.

    request_id

    String

    Especifica um ID da solicitação.

    Tabela 3 ResponseVpnGateway

    Parâmetro

    Tipo

    Descrição

    id

    String

    • Especifica um ID de gateway de VPN.
    • O valor é um UUID contendo 36 caracteres.

    name

    String

    • Especifica um nome de gateway de VPN. Se nenhum nome de gateway de VPN for especificado, o sistema gera um automaticamente.
    • O valor é uma cadeia de 1 a 64 caracteres, que pode conter dígitos, letras, sublinhados (_) e hifens (-).

    network_type

    String

    • Especifica o tipo de rede do gateway de VPN.
    • O valor pode ser public ou private.
    • O valor padrão é public.

    status

    String

    • Especifica o status do gateway de VPN.
    • Intervalo de valores:

      PENDING_CREATE: criando

      PENDING_UPDATE: atualizando

      PENDING_DELETE: excluindo

      ACTIVE: normal

      FAULT: anormal

      FREEZED: congelado

    attachment_type

    String

    • Especifica o modo de associação.
    • O valor pode ser vpc ou er.

    er_id

    String

    Especifica o ID da instância do roteador empresarial à qual o gateway de VPN se conecta. Este parâmetro está disponível somente quando attachment_type é definido como er.

    vpc_id

    String

    Quando attachment_type é definido como vpc, vpc_id especifica o ID do serviço VPC associado ao gateway de VPN.

    Quando attachment_type é definido como er, vpc_id especifica o ID da VPC de acesso usada pelo gateway de VPN.

    local_subnets

    Array of String

    Especifica uma sub-rede local. Essa sub-rede é uma sub-rede do lado da nuvem que precisa se comunicar com uma rede local por meio de uma VPN. Por exemplo, uma sub-rede local pode ser 192.168.52.0/24. Esse parâmetro está disponível somente quando attachment_type é definido como vpc.

    connect_subnet

    String

    Especifica o ID da sub-rede da VPC usada pelo gateway de VPN.

    bgp_asn

    Long

    Especifica o número do SA do BGP do gateway de VPN.

    flavor

    String

    • Especifica as especificações do gateway de VPN.
    • Intervalo de valores:

      V1G: a largura de banda máxima de encaminhamento é de 1 Gbit/s.

      V300: a largura de banda máxima de encaminhamento é de 300 Mbit/s.

    availability_zone_ids

    Array of String

    Especifica a AZ em que o gateway de VPN é implementado. Este parâmetro está disponível quando uma AZ é especificada. Se nenhuma AZ for especificada, esse parâmetro estará disponível somente quando o gateway de VPN estiver no estado ACTIVE.

    connection_number

    Integer

    Especifica o número máximo de conexões de VPN suportadas para o gateway de VPN

    used_connection_number

    Integer

    Especifica o número de conexões de VPN que foram usadas pelo gateway de VPN.

    used_connection_group

    Integer

    Especifica o número de grupos de conexão de VPN que foram usados pelo gateway de VPN. Um grupo de conexão consiste em duas conexões entre um gateway de cliente e um gateway de VPN. Por padrão, 10 grupos de conexão de VPN são incluídos gratuitamente com a compra de um gateway de VPN.

    enterprise_project_id

    String

    • Especifica um ID do projeto empresarial.
    • O valor é um UUID contendo 36 caracteres. Se nenhum ID de projeto empresarial for especificada durante a criação do gateway de VPN, 0 será retornado, indicando que o recurso pertence ao projeto empresarial padrão.

      Observe que 0 não é o ID de um projeto empresarial existente.

    master_eip

    ResponseEip

    Especifica o EIP ativo usado pelo gateway de VPN. Este parâmetro está disponível quando o gateway de VPN está no estado ACTIVE.

    slave_eip

    ResponseEip

    Especifica o EIP em espera usado pelo gateway de VPN. Este parâmetro está disponível quando o gateway de VPN está no estado ACTIVE.

    created_at

    String

    Especifica a hora em que o gateway de VPN é criado. Este parâmetro está disponível quando o gateway de VPN está no estado ACTIVE.

    updated_at

    String

    Especifica a hora da última atualização. Este parâmetro está disponível quando o gateway de VPN está no estado ACTIVE.

    access_vpc_id

    String

    • Especifica o ID da VPC de acesso usado pelo gateway de VPN.
    • O valor é um UUID contendo 36 caracteres.

    access_subnet_id

    String

    • Especifica o ID da sub-rede na VPC de acesso usada pelo gateway de VPN.
    • O valor é um UUID contendo 36 caracteres.

    access_private_ips

    Array of String

    Especifica a lista de endereços IP privados utilizados pelo gateway de VPN para ligar a um gateway de cliente quando o tipo de rede é rede privada. Dois endereços IP serão retornados.

    Por exemplo, um único endereço IP privado pode ser 192.168.52.9. Este parâmetro só está disponível quando network_type está definido como private.

    Tabela 4 ResponseEip

    Parâmetro

    Tipo

    Descrição

    id

    String

    • Especifica um ID do EIP.
    • O valor é um UUID contendo 36 caracteres. Se o projeto da empresa padrão for usado, 0 será retornado.

    ip_version

    Integer

    • Especifica a versão do EIP.
    • O valor só pode ser 4, indicando endereço IPv4.

    ip_billing_info

    String

    • Especifica as informações do perdido do EIP. Este parâmetro está disponível apenas para EIPs anuais/mensais.
    • O valor está no formato order_id:product_id:region_id:project_id, por exemplo:

      CS22********LIBIV:00301-******-0--0:br-iaas-odin1:0605768a************c006c7e484aa

    type

    String

    • Especifica o tipo do EIP.
    • Para o intervalo de valores, consulte o campo type na Tabela 7 em Atribuição de um EIP.

    ip_address

    String

    • Especifica um EIP, ou seja, um endereço IPv4 público.
    • O valor é um endereço IPv4, por exemplo, 88.***.***.11.

    charge_mode

    String

    • Especifica o modo de cobrança de largura de banda de um EIP.
    • Intervalo de valores:

      bandwidth: cobrado pela largura de banda

      traffic: cobrado pelo tráfego

    bandwidth_id

    String

    • Especifica o ID de largura de banda de um EIP.
    • O valor é um UUID contendo 36 caracteres.

    bandwidth_size

    Integer

    • Especifica a largura de banda (Mbit/s) de um EIP. A largura de banda máxima do EIP varia de acordo com as regiões e depende do serviço EIP. Você pode enviar um tíquete de serviço para aumentar a largura de banda máxima do EIP em sua conta.
    • O valor pode ser 5, 10, 20, 50, 100, 200, 300, 500 ou 1000.

    bandwidth_name

    String

    • Especifica o nome da largura de banda de um EIP.
    • O valor é uma cadeia de 1 a 64 caracteres que pode conter dígitos, letras, sublinhados (_), hifens (-) e pontos (.).

    bandwidth_billing_info

    String

    • Especifica as informações do perdido da largura de banda do EIP. Este parâmetro está disponível apenas para EIPs anuais/mensais.
    • O valor está no formato order_id:product_id:region_id:project_id, por exemplo:

      CS22********LIBIV:00301-******-0--0:br-iaas-odin1:0605768a************c006c7e484aa

  • Exemplo de resposta à solicitação de consultar um gateway de VPN público associado a um roteador empresarial
    {
        "vpn_gateway": {
            "id": "66ddeacb-****-****-****-9a414b5bd7d5",
            "name": "vpngw-5bd6",
            "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": "28b795f8-d431-4f1e-93ab-1c401a82b799"
    }
  • Exemplo de resposta à solicitação de consultar um gateway de VPN privado associado a uma VPC
    {
        "vpn_gateway": {
            "id": "66ddeacb-****-****-****-9a414b5bd7d5",
            "name": "vpngw-5bd6",
            "network_type": "private"
            "status": "ACTIVE",
            "attachment_type": "vpc",
            "vpc_id": "91a74241-****-****-****-9b5f98c66c8c",
            "local_subnets": ["192.168.0.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",
            "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",
            "access_private_ips": ["192.168.146.45", "192.168.146.77"]
        },
        "request_id": "28b795f8-d431-4f1e-93ab-1c401a82b799"
    }

Códigos de status

Para mais detalhes, consulte Códigos de status.