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

Consulta informações detalhadas sobre um VPN gateway.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeVpnGateway	Operação a ser executada. Defina o valor como DescribeVpnGateway.
RegionId	String	Sim	ap-southeast-2	ID da região do VPN gateway. Chame a operação DescribeRegions para consultar a lista de regiões mais recente.
VpnGatewayId	String	Sim	vpn-bp1r3v1xqkl0w519g****	ID do VPN gateway.
IncludeReservationData	Boolean	Não	true	Especifica se os dados sobre pedidos pendentes devem ser incluídos. Valores válidos: false (padrão) true

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
VpnType	String	Normal	Tipo do VPN gateway. Valor definido como Normal, indicando um NAT gateway padrão.
Status	String	init	Status do VPN gateway. Valores válidos: init provisioning active updating deleting
VpcId	String	vpc-bp19m2yx1m5q0avyq****	ID da Virtual Private Cloud (VPC) à qual o VPN gateway pertence.
SslMaxConnections	Long	5	Número máximo de conexões SSL-VPN simultâneas.
Spec	String	5	Largura de banda máxima do VPN gateway. Unidade: Mbit/s.
InternetIp	String	47.22.XX.XX	Se o VPN gateway suportar conexões IPsec-VPN no modo de túnel único, este será o endereço IP do gateway, utilizável para criar conexões IPsec-VPN ou SSL-VPN. Caso o VPN gateway suporte conexões IPsec-VPN no modo de túnel duplo, este será o primeiro endereço IP usado para criar uma conexão IPsec-VPN. Não é possível usá-lo para criar uma conexão SSL-VPN. No modo de túnel duplo, o sistema atribui dois endereços IP ao VPN gateway para estabelecer dois túneis criptografados.
CreateTime	Long	1495382400000	Timestamp de criação do VPN gateway. Unidade: milissegundos. Valor UNIX que representa os milissegundos decorridos desde 1º de janeiro de 1970, 00:00:00 UTC.
AutoPropagate	Boolean	true	Indica se as rotas BGP são propagadas automaticamente para a VPC. Valores válidos: true false
ChargeType	String	Site da China (aliyun.com): Prepay. Site internacional (alibabacloud.com): POSTPAY.	Método de faturamento do VPN gateway. Valores válidos: POSTPAY: pagamento conforme o uso
VpnGatewayId	String	vpn-bp1r3v1xqkl0w519g****	ID do VPN gateway.
Tag	String	{\"VpnEnableBgp\":\"true\",\"VisuallySsl\":\"true\",\"PbrPriority\":\"true\",\"VpnNewImage\":\"true\",\"description\":\"forwarding1.3.7\",\"VpnVersion\":\"v1.2.4\"}	Tag gerada automaticamente para o VPN gateway. VpnEnableBgp: indica se o VPN gateway suporta BGP. Valores válidos: true false VisuallySsl: indica se o VPN gateway permite visualizar informações sobre clientes SSL conectados. Valores válidos: true false PbrPriority: indica se o VPN gateway permite configurar prioridades para rotas baseadas em políticas. Valores válidos: true false VpnNewImage: indica se o VPN gateway foi atualizado. true false description: descrição do VPN gateway. Parâmetro apenas para uso interno do sistema. VpnVersion: versão do VPN gateway.
IpsecVpn	String	enable	Indica se o recurso IPsec-VPN está ativado. Valores válidos: enable disable
EndTime	Long	1544666102000	Timestamp de expiração do VPN gateway. Unidade: milissegundos. Valor UNIX que representa os milissegundos decorridos desde 1º de janeiro de 1970, 00:00:00 UTC.
VSwitchId	String	vsw-bp1dmzugdikc6hdgx****	ID do vSwitch ao qual o VPN gateway pertence.
RequestId	String	27E4E088-8DE0-4672-BF5C-0A412389DB9E	ID da solicitação.
Description	String	vpngatewaydescription	Descrição do VPN gateway.
EnableBgp	Boolean	true	Indica se o BGP está ativado para o VPN gateway. Valores válidos: true false
BusinessStatus	String	Normal	Status de pagamento do VPN gateway. Valores válidos: Normal FinancialLocked
SslVpn	String	enable	Status do recurso SSL-VPN. Valores válidos: enable disable
Name	String	vpngatewayname	Nome do VPN gateway.
ReservationData	Object		Informações sobre pedidos pendentes. Nota Parâmetro retornado somente quando IncludeReservationData é definido como true.
Status	String	1	Status do pedido pendente. Valores válidos: 1: indica que o pedido de renovação ou 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 a expiração do upgrade temporário, o sistema restaura a especificação anterior do VPN gateway. Nesse caso, ReservationIpsec, ReservationMaxConnections, ReservationSpec e ReservationSsl indicam as especificações anteriores.
ReservationOrderType	String	TEMP_UPGRADE	Tipo do pedido pendente. Valores válidos: RENEWCHANGE: renovação com upgrade ou downgrade TEMP_UPGRADE: upgrade temporário RENEW: renovação
ReservationIpsec	String	enable	Status IPsec-VPN do pedido pendente. Valores válidos: enable disable
ReservationSpec	String	5	Especificação de largura de banda do pedido pendente. Unidade: Mbit/s.
ReservationSsl	String	enable	Status SSL-VPN do pedido pendente. Valores válidos: enable disable
ReservationMaxConnections	Integer	5	Número máximo de conexões SSL-VPN simultâneas para o pedido pendente.
ReservationEndTime	String	2020-07-20T16:00:00Z	Se o tipo de pedido for TEMP_UPGRADE (upgrade temporário), este parâmetro indica o momento em que o upgrade temporário expira. Caso o tipo de pedido seja RENEWCHANGE (alteração de especificação) ou RENEW (renovação), este parâmetro indica o momento em que a renovação ou alteração de especificação entra em vigor.
Tags	Array of Tag		Tag personalizada do VPN gateway.
Tag
Key	String	aaa	Chave da tag N.
Value	String	bbb	Valor da tag N.
NetworkType	String	public	Tipo de rede do VPN gateway. public: VPN gateway público private
DisasterRecoveryInternetIp	String	47.91.XX.XX	Segundo endereço IP atribuído pelo sistema para criar uma conexão IPsec-VPN. Parâmetro retornado somente quando o VPN gateway suporta o modo de túnel duplo.
DisasterRecoveryVSwitchId	String	vsw-p0w95ql6tmr2ludkt****	ID do segundo vSwitch associado ao VPN gateway. Parâmetro retornado somente quando o VPN gateway suporta o modo de túnel duplo.
SslVpnInternetIp	String	47.74.XX.XX	Endereço IP da conexão SSL-VPN. Parâmetro retornado somente quando o VPN gateway é público, suporta apenas o modo de túnel único e tem o recurso SSL-VPN ativado.

Exemplos

Exemplos de solicitações

http(s)://[Endpoint]/?Action=DescribeVpnGateway
&RegionId=ap-southeast-2
&VpnGatewayId=vpn-bp1r3v1xqkl0w519g****
&IncludeReservationData=true
&Common request parameters

Exemplos de respostas de sucesso

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeVpnGatewayResponse>
    <VpnType>Normal</VpnType>
    <Status>init</Status>
    <VpcId>vpc-bp19m2yx1m5q0avyq****</VpcId>
    <SslMaxConnections>5</SslMaxConnections>
    <Spec>5</Spec>
    <InternetIp>47.22.XX.XX</InternetIp>
    <CreateTime>1495382400000</CreateTime>
    <AutoPropagate>true</AutoPropagate>
    <ChargeType>Example value for Alibaba Cloud China Site: PREPAY. Example value for Alibaba Cloud International Site: POSTPAY.</ChargeType>
    <VpnGatewayId>vpn-bp1r3v1xqkl0w519g****</VpnGatewayId>
    <Tag>{\"VpnEnableBgp\":\"true\",\"VisuallySsl\":\"true\",\"PbrPriority\":\"true\",\"VpnNewImage\":\"true\",\"description\":\"forwarding1.3.7\",\"VpnVersion\":\"v1.2.4\"}</Tag>
    <IpsecVpn>enable</IpsecVpn>
    <EndTime>1544666102000</EndTime>
    <VSwitchId>vsw-bp1dmzugdikc6hdgx****</VSwitchId>
    <RequestId>27E4E088-8DE0-4672-BF5C-0A412389DB9E</RequestId>
    <Description>vpngatewaydescription</Description>
    <EnableBgp>true</EnableBgp>
    <BusinessStatus>Normal</BusinessStatus>
    <SslVpn>enable</SslVpn>
    <Name>vpngatewayname</Name>
    <DisasterRecoveryVSwitchId>vsw-p0w95ql6tmr2ludkt****</DisasterRecoveryVSwitchId>
    <DisasterRecoveryInternetIp>47.91.XX.XX</DisasterRecoveryInternetIp>
    <SslVpnInternetIp>47.74.XX.XX</SslVpnInternetIp>
    <ReservationData>
        <Status>1</Status>
        <ReservationOrderType>TEMP_UPGRADE</ReservationOrderType>
        <ReservationIpsec>enable</ReservationIpsec>
        <ReservationSpec>5</ReservationSpec>
        <ReservationSsl>enable</ReservationSsl>
        <ReservationMaxConnections>5</ReservationMaxConnections>
        <ReservationEndTime>2020-07-20T16:00:00Z</ReservationEndTime>
    </ReservationData>
    <Tags>
        <Key>aaa</Key>
        <Value>bbb</Value>
    </Tags>
    <NetworkType>public</NetworkType>
</DescribeVpnGatewayResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "VpnType" : "Normal",
  "Status" : "init",
  "VpcId" : "vpc-bp19m2yx1m5q0avyq****",
  "SslMaxConnections" : 5,
  "Spec" : "5",
  "InternetIp" : "47.22.XX.XX",
  "CreateTime" : 1495382400000,
  "AutoPropagate" : true,
  "ChargeType": Example value for Alibaba Cloud China Site: PREPAY. Example value for Alibaba Cloud International Site: POSTPAY.
  "VpnGatewayId" : "vpn-bp1r3v1xqkl0w519g****",
  "Tag" : "{\"VpnEnableBgp\":\"true\",\"VisuallySsl\":\"true\",\"PbrPriority\":\"true\",\"VpnNewImage\":\"true\",\"description\":\"forwarding1.3.7\",\"VpnVersion\":\"v1.2.4\"}",
  "IpsecVpn" : "enable",
  "EndTime" : 1544666102000,
  "VSwitchId" : "vsw-bp1dmzugdikc6hdgx****",
  "RequestId" : "27E4E088-8DE0-4672-BF5C-0A412389DB9E",
  "Description" : "vpngatewaydescription",
  "EnableBgp" : true,
  "BusinessStatus" : "Normal",
  "SslVpn" : "enable",
  "Name" : "vpngatewayname",
  "DisasterRecoveryVSwitchId" : "vsw-p0w95ql6tmr2ludkt****",
  "DisasterRecoveryInternetIp" : "47.91.XX.XX",
  "SslVpnInternetIp" : "47.74.XX.XX",
  "ReservationData" : {
    "Status" : "1",
    "ReservationOrderType" : "TEMP_UPGRADE",
    "ReservationIpsec" : "enable",
    "ReservationSpec" : "5",
    "ReservationSsl" : "enable",
    "ReservationMaxConnections" : 5,
    "ReservationEndTime" : "2020-07-20T16:00:00Z"
  },
  "Tags" : [ {
    "Key" : "aaa",
    "Value" : "bbb"
  } ],
  "NetworkType" : "public"
}

Códigos de erro

HttpCode	Código de erro	Mensagem de erro	Descrição
403	Forbbiden.SubUser	User not authorized to operate on the specified resource as your account is created by another user.	Erro retornado devido à falta de autorização para executar esta operação no recurso especificado. Adquira as permissões necessárias e tente novamente.
403	Forbidden	User not authorized to operate on the specified resource.	Erro retornado devido à falta de autorização para executar esta operação no recurso especificado. Adquira as permissões necessárias e tente novamente.
404	InvalidVpnGatewayInstanceId.NotFound	The specified vpn gateway instance id does not exist.	Erro retornado porque o VPN gateway especificado não existe. Verifique se o VPN gateway especificado é válido.

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.