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

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeVpnGateways	A operação a ser executada. Defina o valor como DescribeVpnGateways.
RegionId	String	Sim	ap-southeast-2	ID da região onde o gateway VPN foi criado. Chame a operação DescribeRegions para consultar a lista mais recente de regiões.
VpcId	String	Não	vpc-bp1m3i0kn1nd4wiw9****	ID da Virtual Private Cloud (VPC) à qual o gateway VPN pertence.
VpnGatewayId	String	Não	vpn-bp17lofy9fd0dnvzv****	ID do gateway VPN.
Status	String	Não	active	Status do gateway VPN. Valores válidos: init provisioning active updating deleting
BusinessStatus	String	Não	Normal	Status de pagamento do gateway VPN. Valores válidos: Normal FinancialLocked
PageNumber	Integer	Não	1	Número da página a ser retornada. Valor padrão: 1.
PageSize	Integer	Não	10	Quantidade de entradas a serem retornadas em cada página. Valores válidos: 1 a 50. Valor padrão: 10.
IncludeReservationData	Boolean	Não	true	Especifica se devem ser retornadas informações sobre pedidos pendentes. Valores válidos: false (padrão) true
Tag.N.Key	String	Não	FinanceDept	Chave da tag N. A chave da tag não pode ser uma string vazia. Pode ter até 64 caracteres e não pode conter `http://` ou `https://`. Não pode começar com `aliyun` ou `acs:`. É possível especificar até 20 chaves de tag em cada chamada.
Tag.N.Value	String	Não	FinanceJoshua	Valor da tag N. O valor da tag pode ser uma string vazia e não pode exceder 128 caracteres. Não pode começar com `aliyun` ou `acs:`, e não pode conter `http://` ou `https://`. Cada chave de tag corresponde a um valor de tag. É possível especificar até 20 valores de tag em cada chamada.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
PageSize	Integer	10	Quantidade de entradas retornadas por página.
RequestId	String	DF11D6F6-E35A-41C3-9B20-6FC8A901FE65	ID da solicitação.
PageNumber	Integer	1	Número da página retornada.
TotalCount	Integer	1	Quantidade total de entradas retornadas.
VpnGateways	Array of VpnGateway		Lista de gateways VPN.
VpnGateway
VpnType	String	Normal	Tipo do gateway VPN. O valor é definido como Normal, que indica um gateway NAT padrão.
Status	String	active	Status do gateway VPN. init provisioning active updating deleting
VpcId	String	vpc-bp1m3i0kn1nd4wiw9****	ID da VPC à qual o gateway VPN pertence.
SslMaxConnections	Long	5	Quantidade de conexões SSL-VPN suportadas pelo gateway VPN.
Spec	String	5M	Largura de banda máxima do gateway VPN. M indica Mbit/s.
InternetIp	String	47.12.XX.XX	Se o gateway VPN suportar conexões IPsec-VPN no modo de túnel único, o endereço será o endereço IP do gateway VPN e poderá ser usado para criar uma conexão IPsec-VPN ou SSL-VPN. Se o gateway VPN suportar conexões IPsec-VPN no modo de túnel duplo, o endereço será o primeiro endereço IP usado para criar uma conexão IPsec-VPN. Este endereço não pode ser usado para criar uma conexão SSL-VPN. No modo de túnel duplo, o sistema atribui dois endereços IP ao gateway VPN para criar dois túneis criptografados.
CreateTime	Long	1515383700000	Timestamp de criação do gateway VPN. Unidade: milissegundos. Este valor é um timestamp UNIX que representa o número de 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	Valor de exemplo para o site da China (aliyun.com): Prepay. Valor de exemplo para o site Internacional (alibabacloud.com): POSTPAY.	Método de faturamento do gateway VPN. Apenas POSTPAY pode ser retornado, indicando o método de pagamento conforme o uso.
VpnGatewayId	String	vpn-bp17lofy9fd0dnvzv****	ID do gateway VPN.
Tag	String	{\"VpnEnableBgp\":\"true\",\"VisuallySsl\":\"true\",\"PbrPriority\":\"true\",\"VpnNewImage\":\"true\",\"description\":\"forwarding1.3.7\",\"VpnVersion\":\"v1.2.4\"}	Tag gerada automaticamente do gateway VPN. VpnEnableBgp: indica se o gateway VPN suporta BGP. Valores válidos: true false VisuallySsl: indica se o gateway VPN permite visualizar informações sobre clientes SSL conectados. true false PbrPriority: indica se o gateway VPN permite configurar prioridades para rotas baseadas em política. true false VpnNewImage: indica se o gateway VPN foi atualizado. true false description: descrição do gateway VPN. Este parâmetro é apenas para uso interno do sistema. VpnVersion: versão do gateway VPN.
IpsecVpn	String	enable	Indica se o IPsec-VPN está ativado para o gateway VPN. enable disable
EndTime	Long	1518105600000	Timestamp de expiração do gateway VPN. Unidade: milissegundos. Este valor é um timestamp UNIX que representa o número de milissegundos decorridos desde a época 1º de janeiro de 1970, 00:00:00 UTC.
VSwitchId	String	vsw-bp15lbk8sgtr6r5b0****	ID do vSwitch ao qual o gateway VPN pertence.
Description	String	test	Descrição do gateway VPN.
EnableBgp	Boolean	true	Status BGP do gateway VPN. true false
BusinessStatus	String	Normal	Status de pagamento do gateway VPN. Normal FinancialLocked
SslVpn	String	enable	Indica se o SSL-VPN está ativado para o gateway VPN. enable disable
Name	String	test	Nome do gateway VPN.
NetworkType	String	public	Tipo de rede do gateway VPN. public private
Tags	Array of Tag		Lista de tags adicionadas ao gateway VPN.
Tag
Key	String	FinanceDept	Chave da tag.
Value	String	FinanceJoshua	Valor da tag.
ReservationData	Object		Informações sobre pedidos pendentes. Nota Este parâmetro é retornado apenas quando IncludeReservationData é definido como true.
Status	String	1	Status do pedido pendente. 1: indica que o pedido é de renovação ou renovação com alteração de especificação e ainda não entrou em vigor. 2: indica que o pedido é de upgrade temporário e já entrou em vigor. Após a expiração do upgrade temporário, o sistema restaura o gateway VPN para suas especificações anteriores. Neste caso, ReservationIpsec, ReservationMaxConnections, ReservationSpec e ReservationSsl indicam a especificação anterior.
ReservationOrderType	String	TEMP_UPGRADE	Tipo do pedido que ainda não entrou em vigor. Valores válidos: RENEWCHANGE: renovação com alteração de especificação TEMP_UPGRADE: upgrade temporário RENEW: renovação
ReservationIpsec	String	enable	Status IPsec-VPN do pedido que ainda não entrou em vigor. Valores válidos: enable disable
ReservationSpec	String	5	Largura de banda do pedido pendente. Unidade: Mbit/s.
ReservationSsl	String	enable	Status SSL-VPN do pedido que ainda não entrou em vigor. Valores válidos: enable disable
ReservationMaxConnections	Integer	5	Número máximo de conexões SSL-VPN simultâneas do pedido pendente.
ReservationEndTime	String	2021-07-20T16:00:00Z	Se o tipo de pedido for TEMP_UPGRADE (upgrade temporário), este parâmetro especifica o momento em que o upgrade temporário expira. Se o tipo de pedido for RENEWCHANGE (renovação com alteração de especificação) ou RENEW (renovação), este parâmetro indica o momento em que a renovação ou a renovação com alteração de especificação entra em vigor.
DisasterRecoveryInternetIp	String	47.91.XX.XX	Segundo endereço IP atribuído pelo sistema para criar uma conexão IPsec-VPN. Este parâmetro é retornado apenas quando o gateway VPN suporta o modo de túnel duplo.
DisasterRecoveryVSwitchId	String	vsw-p0w95ql6tmr2ludkt****	ID do segundo vSwitch associado ao gateway VPN. Este parâmetro é retornado apenas quando o gateway VPN suporta o modo de túnel duplo.
SslVpnInternetIp	String	47.74.XX.XX	Endereço IP da conexão SSL-VPN. Este parâmetro é retornado apenas quando o gateway VPN é público e suporta exclusivamente o modo de túnel único. Além disso, o recurso SSL-VPN deve estar ativado no gateway VPN.

Exemplos

Exemplos de solicitações

http(s)://[Endpoint]/?Action=DescribeVpnGateways
&RegionId=ap-southeast-2
&VpcId=vpc-bp1m3i0kn1nd4wiw9****
&VpnGatewayId=vpn-bp17lofy9fd0dnvzv****
&Status=active
&BusinessStatus=Normal
&PageNumber=1
&PageSize=10
&IncludeReservationData=true
&Tag=[{"Key":"FinanceDept","Value":"FinanceJoshua"}]
&Common request parameters

Exemplos de respostas de sucesso

XML formato

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

<DescribeVpnGatewaysResponse>
    <PageSize>10</PageSize>
    <RequestId>DF11D6F6-E35A-41C3-9B20-6FC8A901FE65</RequestId>
    <PageNumber>1</PageNumber>
    <TotalCount>1</TotalCount>
    <VpnGateways>
        <VpnType>Normal</VpnType>
        <Status>Active</Status>
        <VpcId>vpc-bp1m3i0kn1nd4wiw9****</VpcId>
        <SslMaxConnections>5</SslMaxConnections>
        <Spec>5M</Spec>
        <InternetIp>47.12.XX.XX</InternetIp>
        <CreateTime>1515383700000</CreateTime>
        <AutoPropagate>true</AutoPropagate>
        <ChargeType>Example value for China site (aliyun.com): Prepay. Example value for International site (alibabacloud.com): POSTPAY.</ChargeType>
        <VpnGatewayId>vpn-bp17lofy9fd0dnvzv****</VpnGatewayId>
        <Tag>{\"VpnEnableBgp\":\"true\",\"VisuallySsl\":\"true\",\"PbrPriority\":\"true\",\"VpnNewImage\":\"true\",\"description\":\"forwarding1.3.7\",\"VpnVersion\":\"v1.2.4\"}</Tag>
        <IpsecVpn>enable</IpsecVpn>
        <EndTime>1518105600000</EndTime>
        <VSwitchId>vsw-bp15lbk8sgtr6r5b0****</VSwitchId>
        <Description>test</Description>
        <EnableBgp>true</EnableBgp>
        <BusinessStatus>Normal</BusinessStatus>
        <SslVpn>enable</SslVpn>
        <Name>test</Name>
        <NetworkType>public</NetworkType>
        <DisasterRecoveryVSwitchId>vsw-p0w95ql6tmr2ludkt****</DisasterRecoveryVSwitchId>
        <DisasterRecoveryInternetIp>47.91.XX.XX</DisasterRecoveryInternetIp>
        <SslVpnInternetIp>47.74.XX.XX</SslVpnInternetIp>
        <Tags>
            <Key>FinanceDept</Key>
            <Value>FinanceJoshua</Value>
        </Tags>
        <ReservationData>
            <Status>1</Status>
            <ReservationOrderType>TEMP_UPGRADE</ReservationOrderType>
            <ReservationIpsec>enable</ReservationIpsec>
            <ReservationSpec>5</ReservationSpec>
            <ReservationSsl>enable</ReservationSsl>
            <ReservationMaxConnections>5</ReservationMaxConnections>
            <ReservationEndTime>2021-07-20T16:00:00Z</ReservationEndTime>
        </ReservationData>
    </VpnGateways>
</DescribeVpnGatewaysResponse>

JSON formato

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

{
  "PageSize" : 10,
  "RequestId" : "DF11D6F6-E35A-41C3-9B20-6FC8A901FE65",
  "PageNumber" : 1,
  "TotalCount" : 1,
  "VpnGateways" : [ {
    "VpnType" : "Normal",
    "Status" : "Active",
    "VpcId" : "vpc-bp1m3i0kn1nd4wiw9****",
    "SslMaxConnections" : 5,
    "Spec" : "5M",
    "InternetIp" : "47.12.XX.XX",
    "CreateTime" : 1515383700000,
    "AutoPropagate" : true,
    "ChargeType": Example value for  China site (aliyun.com): Prepay. Example value for International site (alibabacloud.com): POSTPAY.
    "VpnGatewayId" : "vpn-bp17lofy9fd0dnvzv****",
    "Tag" : "{\"VpnEnableBgp\":\"true\",\"VisuallySsl\":\"true\",\"PbrPriority\":\"true\",\"VpnNewImage\":\"true\",\"description\":\"forwarding1.3.7\",\"VpnVersion\":\"v1.2.4\"}",
    "IpsecVpn" : "enable",
    "EndTime" : 1518105600000,
    "VSwitchId" : "vsw-bp15lbk8sgtr6r5b0****",
    "Description" : "test",
    "EnableBgp" : true,
    "BusinessStatus" : "Normal",
    "SslVpn" : "enable",
    "Name" : "test",
    "NetworkType" : "public",
    "DisasterRecoveryVSwitchId" : "vsw-p0w95ql6tmr2ludkt****",
    "DisasterRecoveryInternetIp" : "47.91.XX.XX",
    "SslVpnInternetIp" : "47.74.XX.XX",
    "Tags" : [ {
      "Key" : "FinanceDept",
      "Value" : "FinanceJoshua"
    } ],
    "ReservationData" : {
      "Status" : "1",
      "ReservationOrderType" : "TEMP_UPGRADE",
      "ReservationIpsec" : "enable",
      "ReservationSpec" : "5",
      "ReservationSsl" : "enable",
      "ReservationMaxConnections" : 5,
      "ReservationEndTime" : "2021-07-20T16:00:00Z"
    }
  } ]
}

Códigos de erro

HttpCode	Código de erro	Mensagem de erro	Descrição
400	InvalidParameter.TagKey	The specified parameter TagKey is invalid.	A chave de tag especificada é inválida.
400	InvalidParameter.TagValue	The specified parameter TagValue is invalid.	O valor de tag especificado é inválido.
400	Duplicated.TagKey	The specified parameter TagKey is duplicated.	A chave de tag especificada já existe.
400	InternalError	The request processing has failed due to some unknown error, exception or failure.	Ocorreu um erro interno.
403	Forbidden.SubUser	User not authorized to operate on the specified resource as your account is created by another user.	Você não tem autorização para executar esta operação no recurso especificado. Solicite as permissões necessárias e tente novamente.
403	Forbidden	User not authorized to operate on the specified resource.	Você não tem autorização para executar esta operação no recurso especificado. Obtenha as permissões necessárias e tente novamente.

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