DescribeVpnGateway - VPN Gateway - Centre de documentation Alibaba Cloud

Consulte les détails d'une passerelle VPN spécifiée.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

vpc:DescribeVpnGateway

get

*VpnGateway.

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

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Oui	L'identifiant de la région de la passerelle VPN.	cn-hangzhou
VpnGatewayId	string	Oui	L'identifiant de l'instance de la passerelle VPN.	vpn-bp1r3v1xqkl0w519g****
IncludeReservationData	boolean	Non	Indique si les données de commande en attente doivent être incluses. Valeurs valides :	true

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les paramètres de réponse.
VpnType	string	Le type de la passerelle VPN. Valeur : Normal, ce qui indique une passerelle VPN standard.	Normal
Status	string	L'état de la passerelle VPN. Valeurs valides :	init
VpcId	string	L'identifiant du VPC auquel la passerelle VPN appartient.	vpc-bp19m2yx1m5q0avyq****
SslMaxConnections	integer	Le nombre maximal de connexions SSL-VPN simultanées.	5
Spec	string	La spécification de bande passante de la passerelle VPN. Unité : Mbit/s.	5
InternetIp	string	Si l'instance de passerelle VPN prend en charge la création de connexions IPsec-VPN à tunnel unique, cette adresse est l'adresse IP de l'instance de passerelle VPN et peut être utilisée pour créer des connexions IPsec-VPN ou SSL-VPN.	47.22.XX.XX
CreateTime	integer	L'horodatage de la création de la passerelle VPN. Unité : millisecondes.	1495382400000
AutoPropagate	boolean	Indique si la propagation automatique est activée pour la passerelle VPN. Valeurs valides :	true
ChargeType	string	La méthode de facturation. Valeur :	Valeur d'exemple pour le site chinois : Prepay, valeur d'exemple pour le site international : POSTPAY
VpnGatewayId	string	L'identifiant de l'instance de la passerelle VPN.	vpn-bp1r3v1xqkl0w519g****
Tag	string	Les balises générées par le système pour la passerelle VPN.	{\"VpnEnableBgp\":\"true\",\"VisuallySsl\":\"true\",\"PbrPriority\":\"true\",\"VpnNewImage\":\"true\",\"description\":\"transfert 1.3.24\",\"VpnVersion\":\"v1.2.4\",\"IDaaSNewVersion\":\"true\"}
IpsecVpn	string	Indique si la fonctionnalité IPsec-VPN est activée. Valeurs valides :	enable
EndTime	integer	L'horodatage de l'expiration de la passerelle VPN. Unité : millisecondes.	1544666102000
VSwitchId	string	L'identifiant du vSwitch auquel la passerelle VPN appartient.	vsw-bp1dmzugdikc6hdgx****
RequestId	string	L'identifiant de la requête.	27E4E088-8DE0-4672-BF5C-0A412389DB9E
Description	string	La description de la passerelle VPN.	vpngatewaydescription
EnableBgp	boolean	L'état d'activation de la fonctionnalité BGP pour la passerelle VPN. Valeurs valides :	true
BusinessStatus	string	L'état de paiement de la passerelle VPN. Valeurs valides :	Normal
SslVpn	string	L'état d'activation de la fonctionnalité SSL-VPN. Valeurs valides :	enable
Name	string	Le nom de la passerelle VPN.	vpngatewayname
ReservationData	object	Les données de commande en attente.
Status	string	L'état de la commande en attente. Valeurs valides :	1
ReservationOrderType	string	Le type de la commande en attente. Valeurs valides :	TEMP_UPGRADE
ReservationIpsec	string	L'état d'activation de la fonctionnalité IPsec-VPN pour la commande en attente. Valeurs valides :	enable
ReservationSpec	string	La spécification de bande passante de la commande en attente. Unité : Mbit/s.	5
ReservationSsl	string	L'état d'activation de la fonctionnalité SSL-VPN pour la commande en attente. Valeurs valides :	enable
ReservationMaxConnections	integer	Le nombre maximal de connexions SSL-VPN simultanées pour la commande en attente.	5
ReservationEndTime	string	Si le type de commande en attente est TEMP_UPGRADE (mise à niveau temporaire), ce paramètre indique l'heure de retour à l'état initial pour la mise à niveau temporaire.	2020-07-20T16:00:00Z
Tags	object
Tag	array<object>	La liste des balises associées à l'instance de passerelle VPN.
	object	La liste des balises associées à l'instance de passerelle VPN.
Key	string	La clé de la balise.	aaa
Value	string	La valeur de la balise.	bbb
NetworkType	string	Le type de réseau de la passerelle VPN.	public
DisasterRecoveryInternetIp	string	La deuxième adresse IP attribuée par le système à l'instance de passerelle VPN pour la création de connexions IPsec-VPN.	47.91.XX.XX
DisasterRecoveryVSwitchId	string	L'identifiant du deuxième vSwitch associé à l'instance de passerelle VPN.	vsw-p0w95ql6tmr2ludkt****
SslVpnInternetIp	string	L'adresse IP pour les connexions SSL-VPN.	47.74.XX.XX
ResourceGroupId	string	L'identifiant du groupe de ressources auquel la passerelle VPN appartient.	rg-acfmzs372yg****
EniInstanceIds	object
EniInstanceId	array	La liste des interfaces réseau élastiques (ENI) créées par le système pour l'instance de passerelle VPN.
	string	L'identifiant de l'ENI.	eni-7xvcxgmd4y2ypibn****
GatewayType	string	Le type de la passerelle VPN. Valeurs valides :	Enhanced.SiteToSite

Exemples

JSON format

{
  "VpnType": "Normal",
  "Status": "init",
  "VpcId": "vpc-bp19m2yx1m5q0avyq****",
  "SslMaxConnections": 5,
  "Spec": "5",
  "InternetIp": "47.22.XX.XX",
  "CreateTime": 1495382400000,
  "AutoPropagate": true,
  "ChargeType": "Exemple pour le site chinois : Prepay, exemple pour le site international : POSTPAY",
  "VpnGatewayId": "vpn-bp1r3v1xqkl0w519g****",
  "Tag": "{\\\"VpnEnableBgp\\\":\\\"true\\\",\\\"VisuallySsl\\\":\\\"true\\\",\\\"PbrPriority\\\":\\\"true\\\",\\\"VpnNewImage\\\":\\\"true\\\",\\\"description\\\":\\\"Forwarding 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"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidVpnGatewayInstanceId.NotFound	The specified vpn gateway instance id does not exist.	La passerelle VPN spécifiée n'existe pas. Vérifiez que la passerelle VPN est correcte.
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.	L'EIP n'appartient pas à l'appelant actuel. Vérifiez si vous disposez de l'autorisation d'utiliser cette EIP.
404	InvalidVpnGatewayInstanceId.NotFound	The specified vpn gateway instance id does not exist.

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.