CreateVpnGateway - - Centre de documentation Alibaba Cloud

Remarques sur l'utilisation

Avant de créer une passerelle VPN, prenez connaissance de ses limites. Pour plus d'informations, consultez la rubrique Limites des passerelles VPN.
Dans certaines régions, les passerelles VPN ne prennent en charge que les connexions IPsec-VPN en mode double tunnel. Lorsque vous appelez CreateVpnGateway dans ces régions, vous devez spécifier les paramètres VSwitchId et DisasterRecoveryVSwitchId en plus des paramètres obligatoires. Pour obtenir la liste des régions et des zones qui prennent en charge le mode double tunnel, consultez la rubrique Mettre à niveau une passerelle VPN pour activer le mode double tunnel.
L'opération CreateVpnGateway est asynchrone. Après l'envoi d'une requête, le système renvoie un ID de requête et exécute la tâche en arrière-plan. Appelez l'opération DescribeVpnGateway pour interroger l'état de la tâche.
- Si la passerelle VPN est dans l'état provisioning, elle est en cours de création.
- Si la passerelle VPN est dans l'état active, elle a été créée.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de la signature. Pour votre commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement l'exemple de code de l'opération pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	CreateVpnGateway	Opération à effectuer. Définissez la valeur sur CreateVpnGateway.
RegionId	String	Oui	cn-hangzhou	ID de région de la passerelle VPN. Appelez l'opération DescribeRegions pour obtenir la liste des régions la plus récente.
Name	String	Non	MYVPN	Nom de la passerelle VPN. La valeur par défaut correspond à l'ID 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 tirets (-) et des points (.). Les autres caractères spéciaux ne sont pas pris en charge.
VpcId	String	Oui	vpc-bp1ub1yt9cvakoelj****	ID du VPC (Virtual Private Cloud) dans lequel créer la passerelle VPN.
InstanceChargeType	String	Non	Exemple de valeur pour le site Alibaba Cloud China : PREPAY. Exemple de valeur pour le site international Alibaba Cloud : POSTPAY.	Mode de facturation de la passerelle VPN. Définissez la valeur sur POSTPAY pour utiliser la facturation au paiement à l'utilisation.
Period	Integer	Non	1	Durée de l'abonnement. Unité : mois. Valeurs valides : de 1 à 9, 12, 24 et 36.
AutoPay	Boolean	Non	false	Indique si le paiement automatique est activé pour la passerelle VPN. Valeurs valides : true false (par défaut)
Bandwidth	Integer	Oui	5	Bande passante maximale de la passerelle VPN. Unité : Mbit/s. Si vous souhaitez créer une passerelle VPN publique, les valeurs valides sont 10, 100, 200, 500 et 1000. Si vous souhaitez créer une passerelle VPN privée, 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 200 Mbit/s. Pour plus d'informations, consultez la rubrique Limites des passerelles VPN.
EnableIpsec	Boolean	Non	true	Indique si la fonctionnalité IPsec-VPN est activée. Valeurs valides : true (par défaut) false
EnableSsl	Boolean	Non	false	Indique si la fonctionnalité SSL-VPN est activée pour la passerelle VPN. Valeurs valides : true false (par défaut)
SslConnections	Integer	Non	5	Nombre maximal de clients pouvant être connectés simultanément. Valeurs valides : 5 (par défaut), 10, 20, 50, 100, 200, 500 et 1000.
VSwitchId	String	Non	vsw-bp1j5miw2bae9s2vt****	vSwitch à associer à la passerelle VPN. Si vous appelez cette opération dans une région qui prend en charge le mode double tunnel, ce paramètre est obligatoire. Vous devez spécifier un vSwitch et définir le paramètre DisasterRecoveryVSwitchId. Si vous appelez cette opération dans une région qui prend en charge le mode simple tunnel et que vous ne spécifiez pas de vSwitch, le système spécifie automatiquement un vSwitch.
VpnType	String	Non	Normal	Type de la passerelle VPN. Valeurs valides : Normal (par défaut)
ClientToken	String	Non	02fb3da4****	Jeton client utilisé pour garantir l'idempotence de la requête. Vous pouvez utiliser le client pour générer le jeton, mais assurez-vous qu'il est unique pour chaque requête. 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 l'ID de requête comme jeton client. L'ID de requête peut varier d'une requête à l'autre.
NetworkType	String	Non	public	Type de réseau de la passerelle VPN. Valeurs valides : public (par défaut) private
DisasterRecoveryVSwitchId	String	Non	vsw-p0wiz7obm0tbimu4r****	Deuxième vSwitch à associer à la passerelle VPN. Si vous appelez cette opération dans une région qui prend en charge le mode double tunnel, ce paramètre est obligatoire. Spécifiez deux vSwitches situés dans des zones différentes du VPC associé à la passerelle VPN afin de mettre en œuvre la reprise après sinistre inter-zones. Pour une région qui ne prend en charge qu'une seule zone, la reprise après sinistre inter-zones n'est pas prise en charge. Nous vous recommandons de spécifier deux vSwitches dans la zone pour mettre en œuvre la haute disponibilité. Vous pouvez spécifier le même vSwitch. Pour obtenir la liste des régions et des zones qui prennent en charge le mode double tunnel, consultez la rubrique Mettre à niveau une passerelle VPN pour activer le mode double tunnel.

Paramètres de réponse

Paramètre	Type	Exemple	Description
VpnGatewayId	String	vpn-uf68lxhgr7ftbqr3p****	ID de la passerelle VPN.
RequestId	String	EB2C156A-41F8-49CC-A756-D55AFC8BFD69	ID de la requête.
Name	String	MYVPN	Nom de la passerelle VPN.
OrderId	Long	208240895400460	ID de la commande. Si le paiement automatique est désactivé, effectuez manuellement le paiement de la passerelle VPN dans la console de gestion Alibaba Cloud.

Exemples

Exemple de requête

http(s)://[Endpoint]/?Action=CreateVpnGateway
&RegionId=cn-hangzhou
&Name=MYVPN
&VpcId=vpc-bp1ub1yt9cvakoelj****
&InstanceChargeType=PREPAY
&Period=1
&AutoPay=false
&Bandwidth=5
&EnableIpsec=true
&EnableSsl=true
&SslConnections=5
&VSwitchId=vsw-bp1j5miw2bae9s2vt****
&VpnType=Normal
&ClientToken=02fb3da4****
&NetworkType=public
&Common request parameters

Exemple de réponse réussie

Format XML

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

<CreateVpnGatewayResponse>
    <VpnGatewayId>vpn-uf68lxhgr7ftbqr3p****</VpnGatewayId>
    <RequestId>EB2C156A-41F8-49CC-A756-D55AFC8BFD69</RequestId>
    <Name>MYVPN</Name>
    <OrderId>208240895400460</OrderId>
</CreateVpnGatewayResponse>

Format JSON

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

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

Codes d'erreur

HttpCode

Code d'erreur

Message d'erreur

Description

400

Resource.QuotaFull

The quota of resource is full

Le quota de ressources est épuisé.

400

OperationFailed.SslNotSupport

Enable ssl vpn with private networkType is unsupported.

Vous ne pouvez pas activer la fonctionnalité SSL pour une passerelle VPN privée.

400

Forbidden.TagKey.Duplicated

The specified tag key already exists.

Les ressources de tag sont en double.

400

SizeLimitExceeded.TagNum

The maximum number of tags is exceeded.

Le nombre de tags a atteint la limite supérieure.

400

InvalidParameter.TagValue

The specified parameter TagValue is invalid.

La valeur de tag spécifiée n'est pas valide.

400

InvalidParameter.TagKey

The specified parameter TagKey is invalid.

La clé de tag spécifiée n'est pas valide.

400

Duplicated.TagKey

The specified parameter TagKey is duplicated.

La clé de tag spécifiée existe déjà.

400

InternalError

The request processing has failed due to some unknown error, exception or failure.

Une erreur interne s'est produite.

404

InvalidRegionId.NotFound

The specified region is not found during access authentication.

La zone spécifiée est introuvable lors de l'authentification.

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