DescribeVpnGateway - - Centre de documentation Alibaba Cloud

Récupère les informations détaillées d’une passerelle VPN.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d’appeler cette opération dans OpenAPI Explorer pour plus de commodité. OpenAPI Explorer génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	DescribeVpnGateway	Opération à effectuer. Définissez la valeur sur DescribeVpnGateway.
RegionId	String	Oui	ap-southeast-2	ID de région de la passerelle VPN. Appelez l’opération DescribeRegions pour obtenir la liste des régions la plus récente.
VpnGatewayId	String	Oui	vpn-bp1r3v1xqkl0w519g****	ID de la passerelle VPN.
IncludeReservationData	Boolean	Non	true	Indique s’il faut inclure les données relatives aux commandes en attente. Valeurs possibles : false (par défaut) true

Paramètres de réponse

Paramètre	Type	Exemple	Description
VpnType	String	Normal	Type de la passerelle VPN. La valeur est définie sur Normal, ce qui indique une passerelle NAT standard.
Status	String	init	État de la passerelle VPN. Valeurs possibles : init provisioning active updating deleting
VpcId	String	vpc-bp19m2yx1m5q0avyq****	ID du VPC auquel appartient la passerelle VPN.
SslMaxConnections	Long	5	Nombre maximal de connexions SSL-VPN simultanées.
Spec	String	5	Bande passante maximale de la passerelle VPN. Unité : Mbit/s.
InternetIp	String	47.22.XX.XX	Si la passerelle VPN prend en charge les connexions IPsec-VPN en mode tunnel unique, l’adresse correspond à l’adresse IP de la passerelle VPN et peut servir à créer une connexion IPsec-VPN ou SSL-VPN. Si la passerelle VPN prend en charge les connexions IPsec-VPN en mode double tunnel, l’adresse correspond à la première adresse IP utilisée pour créer une connexion IPsec-VPN. Elle ne peut pas servir à créer une connexion SSL-VPN. En mode double tunnel, le système attribue deux adresses IP à la passerelle VPN pour créer deux tunnels chiffrés.
CreateTime	Long	1495382400000	Horodatage de création de la passerelle VPN. Unité : millisecondes. Cette valeur est un horodatage UNIX représentant le nombre de millisecondes écoulées depuis le 1er janvier 1970, 00:00:00 UTC.
AutoPropagate	Boolean	true	Indique si les routes BGP sont automatiquement propagées vers le VPC. Valeurs possibles : true false
ChargeType	String	Site China (aliyun.com) : Prepay. Site international (alibabacloud.com) : POSTPAY.	Méthode de facturation de la passerelle VPN. Valeurs possibles : POSTPAY : paiement à l'utilisation
VpnGatewayId	String	vpn-bp1r3v1xqkl0w519g****	ID de la passerelle VPN.
Tag	String	{\"VpnEnableBgp\":\"true\",\"VisuallySsl\":\"true\",\"PbrPriority\":\"true\",\"VpnNewImage\":\"true\",\"description\":\"forwarding1.3.7\",\"VpnVersion\":\"v1.2.4\"}	Tag généré automatiquement pour la passerelle VPN. VpnEnableBgp: indique si la passerelle VPN prend en charge BGP. Valeurs possibles : true false VisuallySsl: indique si la passerelle VPN permet de consulter les informations des clients SSL connectés. Valeurs possibles : true false PbrPriority: indique si la passerelle VPN permet de configurer les priorités des routes basées sur des stratégies. Valeurs possibles : true false VpnNewImage: indique si la passerelle VPN a été mise à niveau. true false description: description de la passerelle VPN. Ce paramètre est réservé à un usage interne du système. VpnVersion: version de la passerelle VPN.
IpsecVpn	String	enable	Indique si la fonctionnalité IPsec-VPN est activée. Valeurs possibles : enable disable
EndTime	Long	1544666102000	Horodatage d’expiration de la passerelle VPN. Unité : millisecondes. Cette valeur est un horodatage UNIX représentant le nombre de millisecondes écoulées depuis le 1er janvier 1970, 00:00:00 UTC.
VSwitchId	String	vsw-bp1dmzugdikc6hdgx****	ID du vSwitch auquel appartient la passerelle VPN.
RequestId	String	27E4E088-8DE0-4672-BF5C-0A412389DB9E	ID de la requête.
Description	String	vpngatewaydescription	Description de la passerelle VPN.
EnableBgp	Boolean	true	Indique si BGP est activé pour la passerelle VPN. Valeurs possibles : true false
BusinessStatus	String	Normal	Statut de paiement de la passerelle VPN. Valeurs possibles : Normal FinancialLocked
SslVpn	String	enable	État de la fonctionnalité SSL-VPN. Valeurs possibles : enable disable
Name	String	vpngatewayname	Nom de la passerelle VPN.
ReservationData	Object		Informations relatives aux commandes en attente. Remarque Ce paramètre n’est renvoyé que si IncludeReservationData est défini sur true.
Status	String	1	État de la commande en attente. Valeurs possibles : 1: la commande de renouvellement ou de modification de spécification n’a pas encore pris effet. 2: la commande de mise à niveau temporaire a pris effet. À l’expiration de la mise à niveau temporaire, le système restaure la spécification précédente de la passerelle VPN. Dans ce cas, ReservationIpsec, ReservationMaxConnections, ReservationSpec et ReservationSsl indiquent les spécifications précédentes.
ReservationOrderType	String	TEMP_UPGRADE	Type de la commande en attente. Valeurs possibles : RENEWCHANGE: renouvellement avec mise à niveau ou rétrogradation TEMP_UPGRADE: mise à niveau temporaire RENEW: renouvellement
ReservationIpsec	String	enable	État IPsec-VPN de la commande en attente. Valeurs possibles : enable disable
ReservationSpec	String	5	Spécification de bande passante de la commande en attente. Unité : Mbit/s.
ReservationSsl	String	enable	État SSL-VPN de la commande en attente. Valeurs possibles : enable disable
ReservationMaxConnections	Integer	5	Nombre maximal de connexions SSL-VPN simultanées pour la commande en attente.
ReservationEndTime	String	2020-07-20T16:00:00Z	Si le type de commande est TEMP_UPGRADE (mise à niveau temporaire), ce paramètre indique l’heure d’expiration de la mise à niveau temporaire. Si le type de commande est RENEWCHANGE (modification de spécification) ou RENEW (renouvellement), ce paramètre indique l’heure de prise d’effet du renouvellement ou de la modification de spécification.
Tags	Array of Tag		Tag personnalisé de la passerelle VPN.
Tag
Key	String	aaa	Clé du tag N.
Value	String	bbb	Valeur du tag N.
NetworkType	String	public	Type de réseau de la passerelle VPN. public: passerelle VPN publique private
DisasterRecoveryInternetIp	String	47.91.XX.XX	Deuxième adresse IP attribuée par le système pour créer une connexion IPsec-VPN. Ce paramètre n’est renvoyé que si la passerelle VPN prend en charge le mode double tunnel.
DisasterRecoveryVSwitchId	String	vsw-p0w95ql6tmr2ludkt****	ID du deuxième vSwitch associé à la passerelle VPN. Ce paramètre n’est renvoyé que si la passerelle VPN prend en charge le mode double tunnel.
SslVpnInternetIp	String	47.74.XX.XX	Adresse IP de la connexion SSL-VPN. Ce paramètre n’est renvoyé que si la passerelle VPN est publique, prend en charge uniquement le mode tunnel unique et a la fonctionnalité SSL-VPN activée.

Exemples

Exemples de requêtes

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

Exemples de réponses réussies

XML format

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>

JSON format

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"
}

Codes d'erreur

HttpCode	Error code	Error message	Description
403	Forbbiden.SubUser	User not authorized to operate on the specified resource as your account is created by another user.	The error message returned because you are unauthorized to perform this operation on the specified resource. Acquire the required permissions and try again.
403	Forbidden	User not authorized to operate on the specified resource.	The error message returned because you are unauthorized to perform this operation on the specified resource. Acquire the required permissions and try again.
404	InvalidVpnGatewayInstanceId.NotFound	The specified vpn gateway instance id does not exist.	The error message returned because the specified VPN gateway does not exist. Check whether the specified VPN gateway is valid.

Pour obtenir la liste des codes d’erreur, consultez les Codes d'erreur de service.