CreateVpnGateway - VPN Gateway - Centre de documentation Alibaba Cloud

Crée une passerelle VPN.

Description de l'opération

Avant de créer une passerelle VPN, consultez les limites des passerelles VPN. Pour plus d'informations, consultez Limites des passerelles VPN.
Dans certaines régions, les instances de passerelle VPN ne prennent en charge par défaut que la création de connexions IPsec-VPN en mode double tunnel. Lorsque vous appelez l'opération CreateVpnGateway pour créer une instance de passerelle VPN dans ces régions, vous devez spécifier les paramètres VSwitchId et DisasterRecoveryVSwitchId en plus des paramètres requis. Pour plus d'informations sur les régions et les zones qui prennent en charge les connexions IPsec-VPN en mode double tunnel, consultez Mettre à niveau une connexion IPsec-VPN vers le mode double tunnel.
L'opération CreateVpnGateway est asynchrone. Le système renvoie un identifiant d'instance, mais la passerelle VPN n'est pas encore créée et la tâche de création est toujours en cours d'exécution en arrière-plan. Vous pouvez appeler l'opération DescribeVpnGateway pour interroger l'état de création de la passerelle VPN :
- Si la passerelle VPN est à l'état provisioning, la passerelle VPN est en cours de création.
- Si la passerelle VPN est à l'état active, la passerelle VPN est créé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:CreateVpnGateway

create

*VpnGateway.

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

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. Vous pouvez appeler l'opération DescribeRegions pour interroger les identifiants de région.	cn-hangzhou
Name	string	Non	Le nom de la passerelle VPN. Valeur par défaut : l'identifiant de la passerelle VPN. Le nom doit comporter entre 2 et 100 caractères et ne peut pas commencer par `http://` ou `https://`. Il doit commencer par une lettre et peut contenir des lettres, des chiffres, des traits de soulignement (_), des traits d'union (-) et des points (.). Les autres caractères spéciaux ne sont pas pris en charge.	MYVPN
VpcId	string	Oui	L'identifiant du VPC auquel appartient la passerelle VPN.	vpc-bp1ub1yt9cvakoelj****
InstanceChargeType	string	Non	Le mode de facturation de la passerelle VPN. Valeur valide : POSTPAY (mode de facturation à l'usage).	Example value for the China site: PREPAY. Example value for the international site: POSTPAY
Period	integer	Non	La durée de l'abonnement. Unité : mois. Valeurs valides : 1 à 9, 12, 24 et 36.	1
AutoPay	boolean	Non	Indique si le paiement de la facture de la passerelle VPN est effectué automatiquement. Valeurs valides : true : paie automatiquement la facture de la passerelle VPN. false (par défaut) : ne paie pas automatiquement la facture de la passerelle VPN. Remarque Pour créer la passerelle VPN avec succès, activez le paiement automatique. Si vous désactivez le paiement automatique, vous devez régler manuellement la facture pour créer la passerelle VPN.	false
Bandwidth	integer	Oui	La bande passante de la passerelle VPN. Unité : Mbit/s. Si vous souhaitez créer une passerelle VPN publique Internet, les valeurs valides sont 10, 100, 200, 500 et 1000. Si vous souhaitez créer une passerelle VPN publique interne, les valeurs valides sont 200 et 1000. Remarque Dans certaines régions, la bande passante maximale prise en charge par une passerelle VPN est de 500 Mbit/s. Pour plus d'informations, consultez Limites des passerelles VPN.	5
EnableIpsec	boolean	Non	Indique si la fonctionnalité IPsec-VPN est activée. Valeurs valides : true (par défaut) : active la fonctionnalité IPsec-VPN. false : désactive la fonctionnalité IPsec-VPN.	true
EnableSsl	boolean	Non	Indique si la fonctionnalité SSL-VPN est activée. Valeurs valides : true : active la fonctionnalité SSL-VPN. false (par défaut) : désactive la fonctionnalité SSL-VPN.	false
SslConnections	integer	Non	Le nombre maximal de connexions SSL-VPN simultanées. Valeurs valides : 5 (par défaut), 10, 20, 50, 100, 200, 500 et 1000.	5
VSwitchId	string	Non	L'identifiant du vSwitch auquel la passerelle VPN est connectée. Dans les régions qui prennent en charge les connexions IPsec-VPN en mode double tunnel, ce paramètre est requis. Vous devez spécifier un vSwitch et également spécifier le paramètre DisasterRecoveryVSwitchId. Dans les régions qui prennent en charge les connexions IPsec-VPN en mode tunnel unique, si vous ne spécifiez pas de vSwitch, le système sélectionne automatiquement un vSwitch dans le VPC.	vsw-bp1j5miw2bae9s2vt****
VpnType	string	Non	Le type de la passerelle VPN. Valeurs valides : Normal (par défaut) : standard.	Normal
ClientToken	string	Non	Le jeton client utilisé pour garantir l'idempotence de la requête. Vous pouvez utiliser le client pour générer la valeur, mais vous devez vous assurer qu'elle est unique parmi les différentes requêtes. Le jeton client ne peut contenir que des caractères ASCII. Remarque Si vous ne spécifiez pas ce paramètre, le système utilise automatiquement le RequestId de la requête API comme ClientToken. Le RequestId de chaque requête API est unique.	02fb3da4****
NetworkType	string	Non	Le type de réseau de la passerelle VPN. Valeurs valides : public (par défaut) : passerelle VPN publique Internet. private : passerelle VPN publique interne.	public
DisasterRecoveryVSwitchId	string	Non	L'identifiant du vSwitch secondaire associé à l'instance de passerelle VPN. Ce paramètre est requis si la région actuelle prend en charge les connexions IPsec-VPN en mode double tunnel. Vous devez spécifier deux vSwitch déployés dans différentes zones au sein du VPC associé à l'instance de passerelle VPN afin de mettre en œuvre la reprise sur sinistre au niveau de la zone pour la connexion IPsec-VPN. Pour les régions qui ne prennent en charge qu'une seule zone, la reprise sur sinistre au niveau de la zone n'est pas prise en charge. Nous vous recommandons de spécifier deux vSwitch différents dans la zone pour assurer la haute disponibilité de la connexion IPsec-VPN. Vous pouvez également spécifier le même vSwitch. Pour plus d'informations sur les régions et les zones qui prennent en charge les connexions IPsec-VPN en mode double tunnel, consultez Mettre à niveau une connexion IPsec-VPN vers le mode double tunnel.	vsw-p0wiz7obm0tbimu4r****
ResourceGroupId	string	Non	L'identifiant du groupe de ressources auquel appartient la passerelle VPN. Vous pouvez appeler l'opération ListResourceGroups pour interroger les identifiants de groupe de ressources. Si vous ne spécifiez pas d'identifiant de groupe de ressources, la passerelle VPN appartient au groupe de ressources par défaut après sa création. Après la création de la passerelle VPN, si vous créez un serveur SSL, un certificat client SSL, un serveur IPsec ou une connexion IPsec-VPN (applicable aux scénarios où la connexion IPsec-VPN est associée à la passerelle VPN) sous la passerelle VPN, ces ressources appartiennent automatiquement au groupe de ressources de la passerelle VPN et ne peuvent pas être modifiées. Si vous modifiez le groupe de ressources de la passerelle VPN, les groupes de ressources des ressources susmentionnées sont également modifiés.	rg-acfmzs372yg****

Éléments de réponse

Élément	Type	Description	Exemple
	object	La structure de la réponse.
VpnGatewayId	string	L'identifiant de l'instance de passerelle VPN.	vpn-uf68lxhgr7ftbqr3p****
RequestId	string	L'identifiant de la requête.	EB2C156A-41F8-49CC-A756-D55AFC8BFD69
Name	string	Le nom de la passerelle VPN.	MYVPN
OrderId	integer	L'identifiant de la commande. Si vous n'avez pas activé le paiement automatique pour la passerelle VPN, rendez-vous sur la console Dépenses et coûts pour effectuer le paiement.	208240895400460

Exemples

JSON format

{
  "VpnGatewayId": "vpn-uf68lxhgr7ftbqr3p****",
  "RequestId": "EB2C156A-41F8-49CC-A756-D55AFC8BFD69",
  "Name": "MYVPN",
  "OrderId": 208240895400460
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidVpcId.NotFound	The specified VPC id does not exist in our records.
400	InvalidName	The specified value of Name not supported.
400	InvalidSpec.NotFound	The specified Spec does not exist in our records.
400	InvalidPeriod	The specified period is not valid
400	ChargeType.NotSupport	The specified charge type is not support.
400	InventoryNotEnough	The inventory is not enough.
400	UnnecessarySslConnection	The SSL connection is unnecessary for ssl vpn disabled.
400	InvalidVpnEnable	Either IPsec or SSL VPN must be set enable.
400	Resource.QuotaFull	The quota of resource is full
400	InvalidVSwitchId.NotFound	The specified vswitchId is not found.
400	OperationFailed.InventoryNotEnough	No enough available resource. Try another vswitch with different available zone.
400	Forbidden.OperateShareResource	Operating shared resources is forbidden.
400	OperationFailed.IpNotEnough	Operation failed because private ip address of the virtual switch is not enough.
400	Forbidden.NoSLRPermission	User not authorized to create service linked role.
400	OperationFailed.VSwitchConflict	The vswitch can't create vpn. Try another vswitch.
400	OperationFailed.AzNotSupport	Current available zone can't create vpn. Try another vswitch with different available zone.
400	OperationFailed.NetworkTypeNotMatch	Create NationalStandard vpn with private networkType is unsupported.
400	OperationFailed.SslNotSupport	Enable ssl vpn with private networkType is unsupported.	Une passerelle VPN de type réseau privé ne prend pas en charge l'activation de la fonctionnalité SSL.
400	Forbidden.TagKey.Duplicated	The specified tag key already exists.	Des ressources de balise en double existent.
400	SizeLimitExceeded.TagNum	The maximum number of tags is exceeded.	Le nombre de balises a dépassé la limite.
400	InvalidParameter.TagValue	The specified parameter TagValue is invalid.	Le paramètre TagValue spécifié n'est pas valide.
400	InvalidParameter.TagKey	The specified parameter TagKey is invalid.	Le paramètre TagKey spécifié n'est pas valide.
400	Duplicated.TagKey	The specified parameter TagKey is duplicated.	Le paramètre TagKey spécifié est en double.
400	InternalError	The request processing has failed due to some unknown error, exception or failure.
400	InvalidVSwitchId.FirstVswitchNotSupport	The available zone of vswitch1 not supported.	La zone où se trouve le vSwitch principal n'est pas prise en charge.
400	InvalidVSwitchId.VswitchIdShouldDifferent	The VSwitch ids should be different.	La zone principale et la zone secondaire ne peuvent pas être identiques.
400	InvalidVSwitchId.FirstVswitchIpNotEnough	The ip of vswitch1 not enough.	Le nombre d'adresses IP actives dans le vSwitch principal est insuffisant.
400	InvalidVSwitchId.SecondVswitchIpNotEnough	The ip of vswitch2 not enough.	Le nombre d'adresses IP disponibles dans le vSwitch secondaire est insuffisant.
400	InvalidVSwitchId.ZoneIdShouldDifferent	Two vSwitches should belong to different Availability Zones.	Les deux commutateurs virtuels spécifiés lors de la création d'un VPN à double tunnel doivent appartenir à des zones différentes.
400	MissingParam.VSwitchId	The parameter VSwitchId is missing.	Le paramètre VSwitchId est manquant.
400	MissingParam.DisasterRecoveryVSwitchId	The parameter DisasterRecoveryVSwitchId is missing.	Le paramètre DisasterRecoveryVSwitchId est manquant.
400	InvalidDisasterRecoveryVSwitchId.NotFound	The specified DisasterRecoveryVSwitchId does not exist in the specified region.	Le vSwitch spécifié n'existe pas dans la région.
400	InvalidVSwitchId.SecondVswitchNotSupport	The zone of the DisasterRecoveryVSwitch does not support creating a ha-tunnel VPN.	La zone où se trouve le vSwitch secondaire n'est pas prise en charge.
404	InvalidRegionId.NotFound	The specified region is not found during access authentication.	Le RegionId spécifié n'existe pas. Vérifiez si ce service est disponible dans la région spécifiée.

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

Notes de version

Consultez Notes de version pour la liste complète.