Tous les produits
Search
Centre de documentation

VPN Gateway:CreateCustomerGateway

Dernière mise à jour :Aug 18, 2026

Crée une passerelle client.

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:CreateCustomerGateway

create

*Passerelle client.

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

Aucune Aucune

Paramètres de requête

Paramètre

Type

Requis

Description

Exemple

RegionId

string

Oui

L'identifiant de la région de la passerelle client.

Vous pouvez appeler l'opération DescribeRegions pour obtenir l'identifiant de la région.

cn-shanghai

ClientToken

string

Non

Le jeton client utilisé pour garantir l'idempotence de la requête.

Vous pouvez utiliser le client pour générer le jeton, mais vous devez vous assurer qu'il est unique pour chaque requête. Le jeton ne peut contenir que des caractères ASCII et sa longueur ne peut pas dépasser 64 caractères.

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 peut être différent pour chaque requête API.

02fb3da4-130e-11e9-8e44****

IpAddress

string

Oui

L'adresse IP statique de l'équipement de passerelle dans le centre de données local.

  • Si vous souhaitez créer une connexion IPsec-VPN utilisant le type de réseau public, saisissez une adresse IP publique.

  • Si vous souhaitez créer une connexion IPsec-VPN utilisant le type de réseau privé, saisissez une adresse IP privée.

Les adresses IP suivantes ne sont pas prises en charge. Si vous utilisez ces adresses IP, la connexion IPsec-VPN ne pourra pas être établie :

  • 100.64.0.0 à 100.127.255.255

  • 127.0.0.0 à 127.255.255.255

  • 169.254.0.0 à 169.254.255.255

  • 224.0.0.0 à 239.255.255.255

  • 255.0.0.0 à 255.255.255.255

101.12.XX.XX

Name

string

Non

Le nom de la passerelle client.

Le nom doit comporter entre 1 et 100 caractères et ne peut pas commencer par http:// ou https://.

nametest

Description

string

Non

La description de la passerelle client.

La description doit comporter entre 1 et 100 caractères et ne peut pas commencer par http:// ou https://.

desctest

Asn

string

Non

Si vous prévoyez d'activer le protocole de routage dynamique BGP pour la connexion IPsec-VPN, vous devez allouer le numéro de système autonome (ASN) de l'équipement de passerelle dans le centre de données local. Valeurs valides : 1 à 4294967295. La valeur 45104 n'est pas prise en charge.

Asn est un nombre de 4 octets. Vous pouvez saisir le nombre au format à deux segments : les 16 premiers bits. Les 16 derniers bits. Chaque segment est saisi au format décimal.

Par exemple, si vous saisissez 123.456, l'ASN est 123 × 65536 + 456 = 8061384.

Remarque
  • Utilisez un ASN privé pour établir une connexion BGP avec Alibaba Cloud. Pour plus d'informations sur la plage des ASN privés, reportez-vous à la documentation correspondante.

  • 45104 est un identifiant unique alloué à Alibaba Cloud Computing Co., Ltd. par l'Internet Assigned Numbers Authority (IANA). Il est utilisé comme identifiant pour Alibaba Cloud dans le routage Internet mondial et la transmission de données.

65530

AuthKey

string

Non

La clé d'authentification du protocole de routage BGP pour l'équipement de passerelle dans le centre de données local.

La clé doit comporter entre 1 et 64 caractères et ne peut contenir que des caractères ASCII. Les espaces, les caractères chinois et les points d'interrogation demi-chasse (?) ne sont pas pris en charge.

AuthKey****

Tags

array<object>

Non

La liste des balises à ajouter à la passerelle client.

Vous pouvez ajouter jusqu'à 20 balises à une passerelle client à la fois.

object

Non

Les informations de la balise.

Key

string

Non

La clé de la balise. Si vous spécifiez ce paramètre, la valeur ne peut pas être une chaîne vide.

La clé de la balise peut comporter jusqu'à 64 caractères et ne peut pas commencer par aliyun ou acs:. Elle ne peut pas contenir http:// ou https://.

Vous pouvez spécifier jusqu'à 20 clés de balise à la fois.

TagKey

Value

string

Non

La valeur de la balise.

La valeur de la balise peut comporter jusqu'à 128 caractères et peut être une chaîne vide. Elle ne peut pas commencer par aliyun ou acs: et ne peut pas contenir http:// ou https://.

Chaque clé de balise correspond à une valeur de balise. Vous pouvez spécifier jusqu'à 20 valeurs de balise à la fois.

TagValue

ResourceGroupId

string

Non

L'identifiant du groupe de ressources auquel la passerelle client appartient.

  • Vous pouvez appeler l'opération ListResourceGroups pour obtenir l'identifiant du groupe de ressources.

  • Si vous ne spécifiez pas de groupe de ressources, la passerelle client appartient au groupe de ressources par défaut après sa création.

rg-aek2qo2h4jy****

Éléments de réponse

Élément

Type

Description

Exemple

object

Les paramètres de réponse.

RequestId

string

L'identifiant de la requête.

D32B3C26-6C6C-4988-93E9-D2A6444CE6AE

IpAddress

string

L'adresse IP statique de l'équipement de passerelle dans le centre de données local.

101.12.XX.XX

Description

string

La description de la passerelle client.

desctest

CustomerGatewayId

string

L'identifiant d'instance de la passerelle client.

cgw-bp1jrawp82av6bws9****

CreateTime

integer

L'horodatage de la création de la passerelle client. Unité : millisecondes.

L'horodatage est au format UNIX et représente le nombre de millisecondes écoulées depuis le 1er janvier 1970 à 00:00:00 UTC.

1493363486000

Name

string

Le nom de la passerelle client.

nametest

Exemples

JSON format

{
  "RequestId": "D32B3C26-6C6C-4988-93E9-D2A6444CE6AE",
  "IpAddress": "101.12.XX.XX",
  "Description": "desctest",
  "CustomerGatewayId": "cgw-bp1jrawp82av6bws9****",
  "CreateTime": 1493363486000,
  "Name": "nametest"
}

Codes d'erreur

Code de statut HTTP

Code d'erreur

Message d'erreur

Description

400 InvalidAuthkey.Malformed The specified BGP authentication key (%s) is malformed. La clé d'authentification BGP n'est pas valide.
400 InvalidIpAddress.AlreadyExist Specified IpAddress is already exist. L'adresse IP existe déjà. L'adresse IP doit être unique pour le même utilisateur au sein de la même région.
400 InvalidIpAddress.WrongFormat Specified IpAddress is invalid.
400 InvalidName The name is not valid
400 InvalidDescription The description is not valid
400 Resource.QuotaFull The quota of resource is full
400 IllegalParam.Asn The specified Asn is invalid. L'ASN spécifié n'est pas conforme aux spécifications.
400 OperationDenied.MissingAsn The autonomous system number of the customer gateway is mandatory when BGP authentication key is specified. Lorsque la clé d'authentification BGP de la passerelle client est spécifiée, le numéro de système autonome doit également être spécifié.
400 InvalidParameter.TagValue The specified parameter TagValue is invalid. Le paramètre TagValue spécifié n'est pas valide.
400 SizeLimitExceeded.TagNum The maximum number of tags is exceeded. Le nombre de balises a dépassé la limite.
400 Forbidden.TagKey.Duplicated The specified tag key already exists. La ressource de balise est dupliquée.
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 OperationFailed.NoRamPermission Vpn Service has no permission to operate your IDaaS instances. Le service VPN ne dispose pas des autorisations nécessaires pour effectuer des opérations sur votre instance IDaaS.
400 CreateVpnUserGatewayQuotaFull.QuotaFull The number of created VPN customer gateways exceeds the quota. Le nombre de passerelles client VPN dépasse la limite du quota.
403 Forbidden.SubUser User not authorized to operate on the specified resource as your account is created by another user. Vous ne disposez pas de l'autorisation nécessaire pour effectuer des opérations sur cette ressource. Demandez l'autorisation requise et réessayez.
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.
409 OperationConflict The operation against this instance is too frequent, please try again later. Un conflit de requête s'est produit. Réessayez plus tard.

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

Notes de version

Consultez Notes de version pour la liste complète.