ModifyVpnGatewayAttribute - VPN Gateway - Centre de documentation Alibaba Cloud

Appelle l'opération ModifyVpnGatewayAttribute pour modifier le nom, la description ou la fonctionnalité de propagation automatique des routes d'une passerelle VPN.

Description de l'opération

ModifyVpnGatewayAttribute est une opération asynchrone. Après avoir appelé cette opération, le système renvoie les informations de la passerelle VPN, mais la configuration de la passerelle VPN n'a pas encore été modifiée. La tâche de modification est toujours en cours d'exécution en arrière-plan. Vous pouvez appeler DescribeVpnGateway pour interroger l'état de modification de la configuration de la passerelle VPN :
- Si la passerelle VPN est dans l'état updating, la configuration est en cours de modification.
- Si la passerelle VPN est dans l'état active, la configuration a été modifiée.
ModifyVpnGatewayAttribute ne prend pas en charge les modifications simultanées de la configuration d'une même passerelle VPN.

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

update

*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 l'instance de passerelle VPN. Vous pouvez appeler DescribeRegions pour interroger l'identifiant de la région.	cn-hangzhou
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 que le jeton est unique pour chaque requête. La valeur de ClientToken ne peut contenir que des caractères ASCII. Remarque Si vous ne spécifiez pas ce paramètre, le système utilise le RequestId de la requête API comme ClientToken. Le RequestId peut être différent pour chaque requête API.	123e4567-e89b-12d3-a456-4266****
VpnGatewayId	string	Oui	L'identifiant de l'instance de passerelle VPN.	vpn-bp1q8bgx4xnkm2ogj****
Name	string	Non	Le nouveau nom de la passerelle VPN. Le nom doit comporter entre 2 et 100 caractères. Il ne peut pas commencer par `http://` ou `https://`. Il doit commencer par une lettre majuscule ou minuscule et peut contenir des lettres majuscules et minuscules, 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
Description	string	Non	La nouvelle description de la passerelle VPN. La description doit comporter entre 1 et 100 caractères.	test
AutoPropagate	boolean	Non	Indique si la fonctionnalité de propagation automatique des routes doit être activée pour la passerelle VPN. Valeurs valides : true : activée. Une fois la propagation automatique des routes activée, l'instance de passerelle VPN utilise l'apprentissage automatique pour obtenir les routes système à partir de la table de routage système de l'instance connectée au VPC et propage automatiquement les routes du centre de données local vers la table de routage système de l'instance connectée au VPC. false : désactivée. Avant de désactiver la propagation automatique des routes, assurez-vous que la fonctionnalité de route dynamique BGP est désactivée pour toutes les connexions IPsec-VPN sous la passerelle VPN.	true

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les paramètres de réponse.
VpcId	string	L'identifiant du VPC auquel l'instance de passerelle VPN appartient.	vpc-bp1ub1yt9cvakoel****
Status	string	L'état de la passerelle VPN. Valeurs valides : init : initialisation. provisioning : préparation. active : normal. updating : mise à jour. deleting : suppression.	active
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. Si l'instance de passerelle VPN prend en charge la création de connexions IPsec-VPN à double tunnel, cette adresse est la première adresse IP utilisée pour créer des connexions IPsec-VPN et ne peut pas être utilisée pour créer des connexions SSL-VPN. Si l'instance de passerelle VPN prend en charge la création de connexions IPsec-VPN à double tunnel, le système attribue deux adresses IP IPsec à l'instance de passerelle VPN pour la création de connexions IPsec-VPN à double tunnel.	116.62.XX.XX
Spec	string	La spécification de bande passante de l'instance de passerelle VPN. Unité : Mbit/s.	5M
CreateTime	integer	L'horodatage de la création de l'instance de passerelle VPN. 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.	1492753580000
AutoPropagate	boolean	Indique si la propagation automatique des routes est activée pour les routes BGP vers le VPC. Valeurs valides : true : la propagation automatique est activée. false : la propagation automatique n'est pas activée.	true
VpnGatewayId	string	L'identifiant de l'instance de passerelle VPN.	vpn-bp1q8bgx4xnkm2ogj****
IntranetIp	string	L'adresse IP privée du vSwitch occupé par le système lors du déploiement de l'instance de passerelle VPN. Ce paramètre n'est renvoyé que pour les instances de passerelle VPN qui prennent en charge les connexions IPsec-VPN à tunnel unique et pour lesquelles la fonctionnalité IPsec-VPN est activée.	172.16.10.46
EndTime	integer	L'horodatage de l'expiration de l'instance de passerelle VPN. 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.	1495382400000
VSwitchId	string	L'identifiant du vSwitch associé à l'instance de passerelle VPN.	vsw-bp1y9ovl1cu9ou4tv****
RequestId	string	L'identifiant de la requête.	54B48E3D-DF70-471B-AA93-08E683A1B457
Description	string	La description de l'instance de passerelle VPN.	test
EnableBgp	boolean	L'état d'activation de la fonctionnalité BGP pour la passerelle VPN. Valeurs valides : true : activée. false : non activée.	true
BusinessStatus	string	L'état de paiement de l'instance de passerelle VPN. Valeurs valides : Normal : normal. FinancialLocked : verrouillé en raison d'un retard de paiement.	Normal
Name	string	Le nom de l'instance de passerelle VPN.	test
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. Ce paramètre n'est renvoyé que pour les instances de passerelle VPN qui prennent en charge la création de connexions IPsec-VPN à double tunnel.	116.11.XX.XX
DisasterRecoveryVSwitchId	string	L'identifiant du deuxième vSwitch associé à l'instance de passerelle VPN. Ce paramètre n'est renvoyé que pour les instances de passerelle VPN qui prennent en charge la création de connexions IPsec-VPN à double tunnel.	vsw-p0w95ql6tmr2ludkt****
SslVpnInternetIp	string	L'adresse IP de la connexion SSL-VPN. Ce paramètre n'est renvoyé que lorsque la fonctionnalité SSL-VPN est activée pour une instance de passerelle VPN qui prend en charge la création de connexions IPsec-VPN à double tunnel et qui utilise le type de réseau public.	116.33.XX.XX
ResourceGroupId	string	L'identifiant du groupe de ressources auquel l'instance de passerelle VPN appartient. Vous pouvez appeler ListResourceGroups pour interroger les informations sur le groupe de ressources.	rg-acfmzs372yg****

Exemples

JSON format

{
  "VpcId": "vpc-bp1ub1yt9cvakoel****",
  "Status": "active",
  "InternetIp": "116.62.XX.XX",
  "Spec": "5M",
  "CreateTime": 1492753580000,
  "AutoPropagate": true,
  "VpnGatewayId": "vpn-bp1q8bgx4xnkm2ogj****",
  "IntranetIp": "172.16.10.46",
  "EndTime": 1495382400000,
  "VSwitchId": "vsw-bp1y9ovl1cu9ou4tv****",
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B457",
  "Description": "test",
  "EnableBgp": true,
  "BusinessStatus": "Normal",
  "Name": "test",
  "DisasterRecoveryInternetIp": "116.11.XX.XX",
  "DisasterRecoveryVSwitchId": "vsw-p0w95ql6tmr2ludkt****",
  "SslVpnInternetIp": "116.33.XX.XX",
  "ResourceGroupId": "rg-acfmzs372yg****"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidName	The name is not valid
400	InvalidDescription	The description is not valid
400	OperationUnsupported.EnableBgp	Current version of the VPN does not support enable BGP.	La région actuelle ne prend pas en charge l'activation de BGP.
400	OperationFailed.VpnConnectionExist	Auto propagate cannot be closed when VPN connections with BGP enabled exist.	La propagation automatique des routes ne peut pas être désactivée lorsqu'une connexion VPN avec BGP activé est présente.
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.
400	VpnGateway.Configuring	The specified service is configuring.
400	OperationFailed.CenLevelNotSupport	When the VPC to which the VPN gateway belongs is attached to a FULL-mode CEN, the VPN gateway cannot enable BGP.	BGP ne peut pas être activé sur la passerelle VPN lorsque le VPC auquel appartient la passerelle VPN a rejoint une instance Cloud Enterprise Network (CEN) avec la synchronisation des routes activée.
400	OperationFailed.VpcRoutePropagationDisable	The VPC system routing table does not enable the acceptance of propagated routes.	La propagation des routes n'est pas activée pour la table de routage système du VPC.
400	OperationFailed.VpcRoutePublishEnabledInTR	A VPC supports at most one dynamic route learning source. In the forwarding router, disable route synchronization for the VPC.	Un VPC ne prend en charge qu'une seule source d'apprentissage de routes dynamiques. Désactivez la synchronisation des routes pour ce VPC dans le routeur de transit.
400	OperationFailed.VpcRoutePublishEnabledInECR	VPC supports only one dynamic route learning source at most. Please remove the VPC from ECR.	Un VPC ne prend en charge qu'une seule source d'apprentissage de routes dynamiques. Retirez le VPC de l'ECR.
400	OperationFailed.BondingVpnNotSupportBGP	The architecture does not support BGP capabilities (single tunnel bonding architecture VPN gateway).	L'architecture ne prend pas en charge les fonctionnalités BGP (passerelle VPN avec architecture de liaison de tunnel unique).
400	OperationFailed.StaleBGPRoutes	BGP routes are still there and automatic route propagation cannot be disabled.	Des routes BGP existent encore. La propagation automatique ne peut pas être désactivée.
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.
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.