DescribeVpnGateway - VPN Gateway: Central de Documentação do Alibaba Cloud

Chama a API DescribeVpnGateway para consultar os detalhes de um VPN gateway especificado.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

vpc:DescribeVpnGateway

get

*VpnGateway

acs:vpc:{#regionId}:{#accountId}:vpngateway/{#VpnGatewayId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região do VPN gateway. Você pode chamar a API DescribeRegions para obter o ID da região.	cn-hangzhou
VpnGatewayId	string	Sim	O ID da instância do VPN gateway.	vpn-bp1r3v1xqkl0w519g****
IncludeReservationData	boolean	Não	Especifica se os dados de pedidos pendentes devem ser incluídos. Valores válidos: false (padrão): Não inclui dados de pedidos pendentes. true: Inclui dados de pedidos pendentes.	true

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
VpnType	string	O tipo do VPN gateway. Valor: Normal, indicando um tipo padrão.	Normal
Status	string	O status do VPN gateway. Valores válidos: init: Inicializando. provisioning: Preparando. active: Normal. updating: Atualizando. deleting: Excluindo.	init
VpcId	string	O ID da VPC à qual o VPN gateway pertence.	vpc-bp19m2yx1m5q0avyq****
SslMaxConnections	integer	O número máximo de conexões SSL-VPN simultâneas.	5
Spec	string	A especificação de largura de banda do VPN gateway. Unidade: Mbps.	5
InternetIp	string	Em cenários onde a instância do VPN gateway suporta a criação de conexões IPsec-VPN no modo de túnel único, este endereço é o endereço IP da instância do VPN gateway e pode ser usado para criar conexões IPsec-VPN ou conexões SSL-VPN. Em cenários onde a instância do VPN gateway suporta a criação de conexões IPsec-VPN no modo de túnel duplo, este endereço é o primeiro endereço IP usado para criar conexões IPsec-VPN e não pode ser usado para criar conexões SSL-VPN. Em cenários onde a instância do VPN gateway suporta a criação de conexões IPsec-VPN no modo de túnel duplo, o sistema atribui dois endereços IPsec à instância do VPN gateway para a criação de conexões IPsec-VPN no modo de túnel duplo.	47.22.XX.XX
CreateTime	integer	O timestamp de quando o VPN gateway foi criado. Unidade: milissegundos. O timestamp está no formato Unix, representando o número total de milissegundos decorridos desde 1º de janeiro de 1970, 00:00:00 UTC até o momento da criação do VPN gateway.	1495382400000
AutoPropagate	boolean	Indica se o recurso de propagação automática de rotas está ativado para o VPN gateway. Valores válidos: true: Ativado. false: Desativado.	true
ChargeType	string	O método de cobrança. Valores válidos: POSTPAY: Pós-pago.	中国站示例值：Prepay，国际站示例值：POSTPAY
VpnGatewayId	string	O ID da instância do VPN gateway.	vpn-bp1r3v1xqkl0w519g****
Tag	string	As tags geradas pelo sistema do VPN gateway. VpnEnableBgp: Indica se o VPN gateway suporta o recurso BGP. true: Suportado. false: Não suportado. VisuallySsl: Indica se o VPN gateway suporta a visualização de informações de conexão de clientes SSL. true: Suportado. false: Não suportado. PbrPriority: Indica se o VPN gateway suporta a configuração de prioridades de políticas para rotas baseadas em políticas. true: Suportado. false: Não suportado. VpnNewImage: Indica se o VPN gateway é um VPN gateway de nova geração. true: Sim. false: Não. description: A descrição do VPN gateway, usada apenas para fins internos do sistema. VpnVersion: O número da versão do VPN gateway. IDaaSNewVersion: Indica se o VPN gateway suporta vinculação a instâncias EIAM 2.0. true: Suportado. false: Não suportado.	{\"VpnEnableBgp\":\"true\",\"VisuallySsl\":\"true\",\"PbrPriority\":\"true\",\"VpnNewImage\":\"true\",\"description\":\"转发1.3.24\",\"VpnVersion\":\"v1.2.4\",\"IDaaSNewVersion\":\"true\"}
IpsecVpn	string	Indica se o recurso IPsec-VPN está ativado. Valores válidos: enable: Ativado. disable: Desativado.	enable
EndTime	integer	O timestamp de expiração do VPN gateway. Unidade: milissegundos. O timestamp está no formato Unix, representando o número total de milissegundos decorridos desde 1º de janeiro de 1970, 00:00:00 UTC até o momento da expiração do VPN gateway.	1544666102000
VSwitchId	string	O ID do vSwitch ao qual o VPN gateway pertence.	vsw-bp1dmzugdikc6hdgx****
RequestId	string	O ID da solicitação.	27E4E088-8DE0-4672-BF5C-0A412389DB9E
Description	string	A descrição do VPN gateway.	vpngatewaydescription
EnableBgp	boolean	O status do recurso BGP do VPN gateway. Valores válidos: true: Ativado. false: Desativado.	true
BusinessStatus	string	O status de cobrança do VPN gateway. Valores válidos: Normal: Normal. FinancialLocked: Bloqueado devido a pagamento em atraso.	Normal
SslVpn	string	O status do recurso SSL-VPN. Valores válidos: enable: Ativado. disable: Desativado.	enable
Name	string	O nome do VPN gateway.	vpngatewayname
ReservationData	object	Os dados do pedido pendente. Nota Este parâmetro é retornado apenas quando IncludeReservationData está definido como true.
Status	string	O status do pedido pendente. Valores válidos: 1: Indica que o pedido de renovação ou renovação com alteração de especificação ainda não entrou em vigor. 2: Indica que o pedido de upgrade temporário entrou em vigor. Após o horário de restauração ser atingido, o sistema restaurará a especificação do VPN gateway para a especificação anterior ao upgrade temporário. Neste caso, ReservationIpsec, ReservationMaxConnections, ReservationSpec e ReservationSsl representam as especificações anteriores ao upgrade temporário do VPN gateway.	1
ReservationOrderType	string	O tipo do pedido pendente. Valores válidos: RENEWCHANGE: Renovação com alteração de especificação. TEMP_UPGRADE: Upgrade temporário. RENEW: Renovação.	TEMP_UPGRADE
ReservationIpsec	string	O status do recurso IPsec-VPN do pedido pendente. Valores válidos: enable: Ativado. disable: Desativado.	enable
ReservationSpec	string	A especificação de largura de banda do pedido pendente. Unidade: Mbps.	5
ReservationSsl	string	O status do recurso SSL-VPN do pedido pendente. Valores válidos: enable: Ativado. disable: Desativado.	enable
ReservationMaxConnections	integer	O número máximo de conexões SSL-VPN simultâneas do pedido pendente.	5
ReservationEndTime	string	Se o tipo do pedido pendente for TEMP_UPGRADE (upgrade temporário), este parâmetro indica o horário de restauração do upgrade temporário. Se o tipo do pedido pendente for RENEWCHANGE (renovação com alteração de especificação) ou RENEW (renovação), este parâmetro indica o horário em que a renovação ou renovação com alteração de especificação entra em vigor.	2020-07-20T16:00:00Z
Tags	object
Tag	array<object>	A lista de tags vinculadas à instância do VPN gateway.
	object	A lista de tags vinculadas à instância do VPN gateway.
Key	string	A chave da tag.	aaa
Value	string	O valor da tag.	bbb
NetworkType	string	O tipo de rede do VPN gateway. public: VPN gateway público. private: VPN gateway privado.	public
DisasterRecoveryInternetIp	string	O segundo endereço IP atribuído pelo sistema à instância do VPN gateway para a criação de conexões IPsec-VPN. Este parâmetro é retornado apenas para instâncias de VPN gateway que suportam a criação de conexões IPsec-VPN no modo de túnel duplo.	47.91.XX.XX
DisasterRecoveryVSwitchId	string	O ID do segundo vSwitch associado à instância do VPN gateway. Este parâmetro é retornado apenas para instâncias de VPN gateway que suportam a criação de conexões IPsec-VPN no modo de túnel duplo.	vsw-p0w95ql6tmr2ludkt****
SslVpnInternetIp	string	O endereço IP para conexões SSL-VPN. Este parâmetro é retornado apenas quando o SSL-VPN está ativado em uma instância de VPN gateway de rede pública que suporta a criação de conexões IPsec-VPN no modo de túnel duplo.	47.74.XX.XX
ResourceGroupId	string	O ID do grupo de recursos ao qual o VPN gateway pertence. Você pode chamar a API ListResourceGroups para consultar informações do grupo de recursos.	rg-acfmzs372yg****
EniInstanceIds	object
EniInstanceId	array	A lista de Elastic Network Interfaces (ENIs) criadas pelo sistema para a instância do VPN gateway.
	string	O ID da ENI. Este parâmetro é retornado apenas para instâncias de VPN gateway que suportam a criação de conexões IPsec-VPN no modo de túnel duplo.	eni-7xvcxgmd4y2ypibn****
GatewayType	string	O tipo do VPN gateway. Valores válidos: Traditional: VPN gateway tradicional, abrangendo os recursos IPsec e SSL. Enhanced.SiteToSite: VPN aprimorada site-to-cloud, abrangendo apenas os recursos IPsec.	Enhanced.SiteToSite

Exemplos

Resposta de sucesso

JSON formato

{
  "VpnType": "Normal",
  "Status": "init",
  "VpcId": "vpc-bp19m2yx1m5q0avyq****",
  "SslMaxConnections": 5,
  "Spec": "5",
  "InternetIp": "47.22.XX.XX",
  "CreateTime": 1495382400000,
  "AutoPropagate": true,
  "ChargeType": "中国站示例值：Prepay，国际站示例值：POSTPAY",
  "VpnGatewayId": "vpn-bp1r3v1xqkl0w519g****",
  "Tag": "{\\\"VpnEnableBgp\\\":\\\"true\\\",\\\"VisuallySsl\\\":\\\"true\\\",\\\"PbrPriority\\\":\\\"true\\\",\\\"VpnNewImage\\\":\\\"true\\\",\\\"description\\\":\\\"转发1.3.24\\\",\\\"VpnVersion\\\":\\\"v1.2.4\\\",\\\"IDaaSNewVersion\\\":\\\"true\\\"}",
  "IpsecVpn": "enable",
  "EndTime": 1544666102000,
  "VSwitchId": "vsw-bp1dmzugdikc6hdgx****",
  "RequestId": "27E4E088-8DE0-4672-BF5C-0A412389DB9E",
  "Description": "vpngatewaydescription",
  "EnableBgp": true,
  "BusinessStatus": "Normal",
  "SslVpn": "enable",
  "Name": "vpngatewayname",
  "ReservationData": {
    "Status": "1",
    "ReservationOrderType": "TEMP_UPGRADE",
    "ReservationIpsec": "enable",
    "ReservationSpec": "5",
    "ReservationSsl": "enable",
    "ReservationMaxConnections": 5,
    "ReservationEndTime": "2020-07-20T16:00:00Z"
  },
  "Tags": {
    "Tag": [
      {
        "Key": "aaa",
        "Value": "bbb"
      }
    ]
  },
  "NetworkType": "public",
  "DisasterRecoveryInternetIp": "47.91.XX.XX",
  "DisasterRecoveryVSwitchId": "vsw-p0w95ql6tmr2ludkt****",
  "SslVpnInternetIp": "47.74.XX.XX",
  "ResourceGroupId": "rg-acfmzs372yg****",
  "EniInstanceIds": {
    "EniInstanceId": [
      "eni-7xvcxgmd4y2ypibn****"
    ]
  },
  "GatewayType": "Enhanced.SiteToSite"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidVpnGatewayInstanceId.NotFound	The specified vpn gateway instance id does not exist.	O gateway VPN especificado não existe. Verifique se o gateway VPN está correto.
403	Forbbiden.SubUser	User not authorized to operate on the specified resource as your account is created by another user.
403	Forbidden	User not authorized to operate on the specified resource.	O EIP não pertence ao chamador atual. Verifique se você tem permissão para operar este EIP.
404	InvalidVpnGatewayInstanceId.NotFound	The specified vpn gateway instance id does not exist.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.