UpdateIpsecServer - VPN Gateway - Centre de documentation Alibaba Cloud

Appelle l'opération UpdateIpsecServer pour mettre à jour la configuration d'un serveur IPsec.

Description de l'opération

Si vous modifiez uniquement le paramètre IpsecServerName du serveur IPsec, cette opération est synchrone. Si vous modifiez des configurations autres que IpsecServerName, cette opération est asynchrone.
Lorsque UpdateIpsecServer est une opération asynchrone, le système renvoie d'abord un identifiant de requête, mais la configuration du serveur IPsec n'a pas encore été modifiée car 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 l'instance de passerelle VPN afin de déterminer l'état de modification de la configuration du serveur IPsec :
- Si l'instance de passerelle VPN est dans l'état updating, la configuration du serveur IPsec est en cours de modification.
- Si l'instance de passerelle VPN est dans l'état active, la configuration du serveur IPsec a été modifiée.
L'opération UpdateIpsecServer ne prend pas en charge les modifications simultanées des configurations de serveur IPsec sous la 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:UpdateIpsecServer

update

*All Resource.

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Oui	L'identifiant de la région du serveur IPsec. Vous pouvez appeler l'opération DescribeRegions pour obtenir l'identifiant de la région.	cn-shanghai
IpsecServerId	string	Oui	L'identifiant du serveur IPsec.	iss-bp1bo3xuvcxo7ixll****
LocalSubnet	string	Non	Le bloc CIDR local, qui est le bloc CIDR côté VPC devant communiquer avec le bloc CIDR client. Séparez plusieurs blocs CIDR par des virgules (,). Exemple : 192.168.1.0/24,192.168.2.0/24.	192.168.0.0/24,172.17.0.0/16
ClientIpPool	string	Non	Le bloc CIDR client, qui est le bloc CIDR à partir duquel les adresses IP sont attribuées aux interfaces réseau virtuelles (NIC) du client. Remarque Le bloc CIDR client ne doit pas entrer en conflit avec le bloc CIDR du VPC.	10.0.0.0/24
IpsecServerName	string	Non	Le nom du serveur IPsec. Le nom doit comporter de 1 à 100 caractères.	test
EffectImmediately	boolean	Non	Indique s'il faut supprimer le tunnel IPsec actuellement négocié et relancer la négociation. Valeurs valides : true : la négociation est lancée immédiatement une fois la configuration terminée. false : la négociation est lancée lorsqu'un trafic entrant est détecté.	false
IkeConfig	string	Non	La configuration des paramètres de négociation de phase 1. Valeurs valides : IkeVersion : la version du protocole Internet Key Exchange. Valeurs valides : ikev1 ou ikev2. IkeMode : le mode de négociation de la version IKE. Valeur par défaut : main. IkeEncAlg : l'algorithme de chiffrement utilisé dans la négociation de phase 1. Valeur par défaut : aes. IkeAuthAlg : l'algorithme d'authentification utilisé dans la négociation de phase 1. Valeur par défaut : sha1. IkePfs : l'algorithme d'échange de clés Diffie-Hellman utilisé dans la négociation de phase 1. Valeur par défaut : group2. IkeLifetime : la durée de vie de l'association de sécurité (SA) établie lors de la négociation de phase 1. Unité : secondes. Valeurs valides : 0 à 86400. Valeur par défaut : 86400. LocalId : l'identifiant du serveur IPsec. Les formats FQDN et adresse IP sont pris en charge. RemoteId : l'identifiant du pair. Les formats FQDN et adresse IP sont pris en charge.	{"IkeVersion":"ikev2","IkeMode":"main","IkeEncAlg":"aes","IkeAuthAlg":"sha1","IkePfs":"group2","IkeLifetime":86400}
IpsecConfig	string	Non	Les paramètres de négociation de phase 2. Valeurs valides : IpsecEncAlg : l'algorithme de chiffrement utilisé dans la négociation de phase 2. Valeur par défaut : aes. IpsecAuthAlg : l'algorithme d'authentification utilisé dans la négociation de phase 2. Valeur par défaut : sha1. IpsecPfs : transfère tous les paquets de protocole. L'algorithme d'échange de clés Diffie-Hellman utilisé dans la négociation de phase 2. Valeur par défaut : group2. IpsecLifetime : la durée de vie de la SA générée lors de la négociation de phase 2. Unité : secondes. Valeurs valides : 0 à 86400. Valeur par défaut : 86400.	{"IpsecEncAlg":"aes","IpsecAuthAlg":"sha1","IpsecPfs":"group2","IpsecLifetime":86400}
PskEnabled	boolean	Non	Indique si l'authentification par clé prépartagée doit être activée. Valeurs valides : true, ce qui indique que l'authentification par clé prépartagée est activée.	true
Psk	string	Non	La clé prépartagée. La clé prépartagée est utilisée pour l'authentification d'identité entre le serveur IPsec et le client. La clé doit comporter de 1 à 100 caractères. Vous pouvez appeler l'opération ListIpsecServers pour obtenir la clé générée par le système. Remarque La clé prépartagée du serveur IPsec doit être identique à la clé d'authentification du client. Sinon, une connexion ne peut pas être établie entre le serveur IPsec et le client.	Cfd123****
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. Le jeton 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 peut être différent pour chaque requête API.	e4567-e89b-12d3-a456-42665544****
DryRun	string	Non	Indique si un test à blanc doit être effectué. Valeurs valides : true : effectue un test à blanc sans mettre à jour la configuration du serveur IPsec. Le système vérifie si les paramètres requis sont spécifiés, si le format de la requête est valide et si les restrictions métier sont respectées. Si la vérification échoue, le message d'erreur correspondant est renvoyé. Si la vérification réussit, `DryRunOperation` est renvoyé. false (par défaut) : effectue un test à blanc et envoie la requête. Une fois la vérification réussie, la configuration du serveur IPsec est mise à jour.	false

É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.	B61C08E5-403A-46A2-96C1-F7B1216DB10C

Exemples

JSON format

{
  "RequestId": "B61C08E5-403A-46A2-96C1-F7B1216DB10C"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	VpnGateway.Configuring	The specified service is configuring.
400	VpnGateway.FinancialLocked	The specified service is financial locked.
400	OperationUnsupported.IpsecPfs	The specified IPsec Pfs is unsupported.	Le PFS IPsec spécifié n'est pas pris en charge.
400	IllegalParam.AuthMethod	One authentication method (Psk or IDaaS) should be specified at least.	Au moins une méthode d'authentification (Psk ou IDaaS) doit être spécifiée.
400	IllegalParam.LocalSubnet	The specified "LocalSubnet" (%s) is invalid.	Le bloc CIDR local (%s) n'est pas valide.
400	IllegalParam.ClientIpPool	The specified "ClientIpPool" (%s) is invalid.
400	MissingParam.IDaaSInstanceId	The input parameter IDaaSInstanceId is mandatory when enable multi-factor authentication.	L'identifiant de l'instance IDaaS est requis lorsque l'authentification à deux facteurs est activée.
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	OperationFailed.AddVpcRoute	It's failed to add VPC route after this operation.
400	ClientIpPool.NetmaskInvalid	The netmask length of client IP pool must be greater than or equal to 16 and less than or equal to 29.	La longueur du masque de réseau du pool d'adresses IP clientes doit être supérieure ou égale à 16 et inférieure ou égale à 29.
400	VpnRouteEntry.Conflict	The specified client IP pool conflicts with VPN connection or SSL server.	Le pool d'adresses IP client spécifié est en conflit avec une connexion VPN ou un serveur SSL.
400	ClientIpPool.SubnetInvalid	The specified client IP pool cannot be used.	Le bloc CIDR client spécifié n'est pas disponible.
400	InvalidClientIpPool.Conflict	The specified client IP pool conflicts with other resources in the same VPC.	Le bloc CIDR client est en conflit avec d'autres ressources dans le VPC.
400	SystemBusy	The system is busy. Please try again later.
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	InvalidIpsecServerId.NotFound	The specified IPsec server ID (%s) does not exist.
404	InvalidIDaaSInstanceId.NotFound	The specified IDaaS instance ID does not exist.	L'identifiant de l'instance IDaaS spécifié n'existe pas.
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.