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

Consulta os detalhes de um gateway VPN 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 gateway VPN.	cn-hangzhou
VpnGatewayId	string	Sim	O ID da instância do gateway VPN.	vpn-bp1r3v1xqkl0w519g****
IncludeReservationData	boolean	Não	Especifica se devem ser incluídos dados de pedidos pendentes. Valores válidos:	true

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
VpnType	string	O tipo do gateway VPN. Valor: Normal, que indica um gateway VPN padrão.	Normal
Status	string	O status do gateway VPN. Valores válidos:	init
VpcId	string	O ID da VPC à qual o gateway VPN 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 gateway VPN. Unidade: Mbit/s.	5
InternetIp	string	Se a instância do gateway VPN suportar a criação de conexões IPsec-VPN de túnel único, este endereço é o endereço IP da instância do gateway VPN e pode ser usado para criar conexões IPsec-VPN ou SSL-VPN.	47.22.XX.XX
CreateTime	integer	O timestamp de quando o gateway VPN foi criado. Unidade: milissegundos.	1495382400000
AutoPropagate	boolean	Indica se a propagação automática está ativada para o gateway VPN. Valores válidos:	true
ChargeType	string	O método de cobrança. Valor:	中国站示例值：Prepay，国际站示例值：POSTPAY
VpnGatewayId	string	O ID da instância do gateway VPN.	vpn-bp1r3v1xqkl0w519g****
Tag	string	Os rótulos gerados pelo sistema do gateway VPN.	{\"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
EndTime	integer	O timestamp de quando o gateway VPN expira. Unidade: milissegundos.	1544666102000
VSwitchId	string	O ID do vSwitch ao qual o gateway VPN pertence.	vsw-bp1dmzugdikc6hdgx****
RequestId	string	O ID da solicitação.	27E4E088-8DE0-4672-BF5C-0A412389DB9E
Description	string	A descrição do gateway VPN.	vpngatewaydescription
EnableBgp	boolean	O status de ativação do recurso BGP para o gateway VPN. Valores válidos:	true
BusinessStatus	string	O status de pagamento do gateway VPN. Valores válidos:	Normal
SslVpn	string	O status de ativação do recurso SSL-VPN. Valores válidos:	enable
Name	string	O nome do gateway VPN.	vpngatewayname
ReservationData	object	Os dados do pedido pendente.
Status	string	O status do pedido pendente. Valores válidos:	1
ReservationOrderType	string	O tipo do pedido pendente. Valores válidos:	TEMP_UPGRADE
ReservationIpsec	string	O status de ativação do recurso IPsec-VPN para o pedido pendente. Valores válidos:	enable
ReservationSpec	string	A especificação de largura de banda do pedido pendente. Unidade: Mbit/s.	5
ReservationSsl	string	O status de ativação do recurso SSL-VPN para o pedido pendente. Valores válidos:	enable
ReservationMaxConnections	integer	O número máximo de conexões SSL-VPN simultâneas do pedido pendente.	5
ReservationEndTime	string	Se o tipo de pedido pendente for TEMP_UPGRADE (upgrade temporário), este parâmetro indica o horário de reversão do upgrade temporário.	2020-07-20T16:00:00Z
Tags	object
Tag	array<object>	A lista de tags vinculadas à instância do gateway VPN.
	object	A lista de tags vinculadas à instância do gateway VPN.
Key	string	A chave da tag.	aaa
Value	string	O valor da tag.	bbb
NetworkType	string	O tipo de rede do gateway VPN.	public
DisasterRecoveryInternetIp	string	O segundo endereço IP atribuído pelo sistema à instância do gateway VPN para a criação de conexões IPsec-VPN.	47.91.XX.XX
DisasterRecoveryVSwitchId	string	O ID do segundo vSwitch associado à instância do gateway VPN.	vsw-p0w95ql6tmr2ludkt****
SslVpnInternetIp	string	O endereço IP para conexões SSL-VPN.	47.74.XX.XX
ResourceGroupId	string	O ID do grupo de recursos ao qual o gateway VPN pertence.	rg-acfmzs372yg****
EniInstanceIds	object
EniInstanceId	array	A lista de Elastic Network Interfaces (ENIs) criadas pelo sistema para a instância do gateway VPN.
	string	O ID da ENI.	eni-7xvcxgmd4y2ypibn****
GatewayType	string	O tipo do gateway VPN. Valores válidos:	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 chamar 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.