ModifyTunnelAttribute - VPN Gateway - Centre de documentation Alibaba Cloud

Appelle l'opération ModifyTunnelAttribute pour modifier la configuration du tunnel d'un VPN hautement disponible.

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

update

*VpnConnection

acs:vpc:{#regionId}:{#accountId}:vpnconnection/{#VpnConnectionId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
ClientToken	string	Non	Le jeton client utilisé pour garantir l'idempotence de la requête.	02fb3da4-130e-11e9-8e44-0016e04115b
TunnelOptionsSpecification	object	Non	La configuration du tunnel à modifier.
EnableDpd	boolean	Non	Indique si la fonctionnalité Dead Peer Detection (DPD) doit être activée. Valeurs valides :	true
EnableNatTraversal	boolean	Non	Indique si la traversée NAT doit être activée. Valeurs valides :	true
RemoteCaCertificate	string	Non	Le certificat CA du pair lorsque la connexion IPsec-VPN est associée à une passerelle VPN conforme à l'autorité de certification de Chine (China CA).	-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE-----
TunnelBgpConfig	object	Non	La configuration BGP du tunnel à modifier.
LocalAsn	integer	Non	Le numéro de système autonome (ASN) de l'extrémité locale du tunnel. Valeurs valides : 1 à 4294967295.	65530
LocalBgpIp	string	Non	L'adresse IP BGP de l'extrémité locale du tunnel. Cette adresse doit être une adresse IP comprise dans la plage TunnelCidr.	169.254.11.1
TunnelCidr	string	Non	Le bloc CIDR de l'adresse IP BGP à l'extrémité locale du tunnel.	169.254.11.0/30
TunnelIkeConfig	object	Non	La configuration de la phase IKE (phase 1) du tunnel à modifier.
IkeAuthAlg	string	Non	L'algorithme d'authentification utilisé dans la négociation de la phase 1.	sha1
IkeEncAlg	string	Non	L'algorithme de chiffrement utilisé dans la négociation de la phase 1.	aes
IkeLifetime	integer	Non	La durée de vie de la SA négociée dans la phase 1. Unité : secondes. Valeurs valides : 0 à 86400.	86400
IkeMode	string	Non	Le mode de négociation de la version IKE. Valeurs valides :	main
IkePfs	string	Non	L'algorithme d'échange de clés Diffie-Hellman utilisé dans la négociation de la phase 1. Valeurs valides : group1, group2, group5, group14.	group2
IkeVersion	string	Non	La version du protocole IKE. Valeurs valides : ikev1 ou ikev2.	ikev2
LocalId	string	Non	L'identifiant de l'extrémité locale du tunnel. La valeur peut contenir jusqu'à 100 caractères et ne peut pas contenir d'espaces. La valeur prend en charge les formats FQDN et IP. La valeur par défaut est l'adresse IP du tunnel.	47.XX.XX.87
Psk	string	Non	La clé pré-partagée utilisée pour l'authentification d'identité entre le tunnel et le pair.	123456****
RemoteId	string	Non	L'identifiant de l'extrémité distante du tunnel. La valeur peut contenir jusqu'à 100 caractères et ne peut pas contenir d'espaces. La valeur prend en charge les formats FQDN et IP. La valeur par défaut est l'adresse IP de l'instance de passerelle client associée au tunnel.	47.XX.XX.207
TunnelIpsecConfig	object	Non	La configuration de la phase IPsec (phase 2) du tunnel à modifier.
IpsecAuthAlg	string	Non	L'algorithme d'authentification utilisé dans la négociation de la phase 2.	sha1
IpsecEncAlg	string	Non	L'algorithme de chiffrement utilisé dans la négociation de la phase 2.	aes
IpsecLifetime	integer	Non	La durée de vie de la SA négociée dans la phase 2. Unité : secondes. Valeurs valides : 0 à 86400.	86400
IpsecPfs	string	Non	L'algorithme d'échange de clés Diffie-Hellman utilisé dans la négociation de la phase 2. Valeurs valides : disabled, group1, group2, group5, group14.	group2
CustomerGatewayId	string	Non	L'identifiant de l'instance de la passerelle client associée au tunnel.	cgw-1nmwbpgrp7ssqm1yn****
RegionId	string	Non	L'identifiant de la région de la connexion IPsec-VPN.	cn-hangzhou
VpnConnectionId	string	Oui	L'identifiant de la connexion IPsec-VPN.	vco-gw69vm1i71y354****
TunnelId	string	Oui	L'identifiant du tunnel.	tun-gbyz2e070xzo93****

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les paramètres de réponse.
TunnelId	string	L'identifiant du tunnel.	tun-gbyz2e070xzo93****
RequestId	string	L'identifiant de la requête.	E6F36FF0-9544-3AEE-8673-A4647D50064C
TunnelIkeConfig	object	La configuration de la phase IKE (phase 1) du tunnel.
IkeAuthAlg	string	L'algorithme d'authentification IKE.	sha1
IkeEncAlg	string	L'algorithme de chiffrement IKE.	aes
IkeLifetime	integer	La durée de vie IKE. Unité : secondes.	86400
IkeMode	string	Le mode de négociation IKE.	main
IkePfs	string	Le groupe DH.	group2
IkeVersion	string	La version du protocole IKE.	ikev2
LocalId	string	L'identifiant de l'extrémité locale du tunnel. La valeur prend en charge les formats FQDN et IP. La valeur par défaut est l'adresse IP du tunnel.	47.XX.XX.87
Psk	string	La clé pré-partagée.	123456****
RemoteId	string	L'identifiant de l'extrémité distante du tunnel. La valeur prend en charge les formats FQDN et IP. La valeur par défaut est l'adresse IP de l'instance de passerelle client associée au tunnel.	47.XX.XX.207
TunnelIpsecConfig	object	La configuration de la phase IPsec (phase 2) du tunnel.
IpsecAuthAlg	string	L'algorithme d'authentification IPsec.	sha1
IpsecEncAlg	string	L'algorithme de chiffrement IPsec.	aes
IpsecLifetime	integer	La durée de vie IPsec. Unité : secondes.	86400
IpsecPfs	string	Le groupe DH.	group2
TunnelBgpConfig	object	La configuration BGP du tunnel.
EnableBgp	boolean	L'état d'activation du BGP.	true
LocalAsn	integer	Le numéro de système autonome (ASN) de l'extrémité locale du tunnel.	65530
LocalBgpIp	string	L'adresse IP BGP de l'extrémité locale du tunnel.	169.254.11.1
PeerAsn	integer	Le numéro de système autonome (ASN) de l'extrémité distante du tunnel.	65531
PeerBgpIp	string	L'adresse IP BGP de l'extrémité distante du tunnel.	169.254.11.2
TunnelCidr	string	Le bloc CIDR de l'adresse IP BGP du tunnel.	169.254.11.0/30
EnableNatTraversal	boolean	Indique si la traversée NAT est activée. Valeurs valides :	true
EnableDpd	boolean	Indique si la fonctionnalité Dead Peer Detection (DPD) est activée.	true
RemoteCaCertificate	string	Le certificat CA du pair lorsque la connexion IPsec-VPN est créée avec une passerelle VPN conforme à China CA.	-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE-----
CustomerGatewayId	string	L'identifiant de l'instance de la passerelle client associée au tunnel.	cgw-p0wx48ayhrygitm80****
Role	string	Le rôle du tunnel.	master
ZoneNo	string	La zone du tunnel.	cn-hangzhou-h
InternetIp	string	L'adresse IP du tunnel.	47.XX.XX.87
State	string	L'état du tunnel.	active

Exemples

JSON format

{
  "TunnelId": "tun-gbyz2e070xzo93****",
  "RequestId": "E6F36FF0-9544-3AEE-8673-A4647D50064C",
  "TunnelIkeConfig": {
    "IkeAuthAlg": "sha1",
    "IkeEncAlg": "aes",
    "IkeLifetime": 86400,
    "IkeMode": "main",
    "IkePfs": "group2",
    "IkeVersion": "ikev2",
    "LocalId": "47.XX.XX.87",
    "Psk": "123456****",
    "RemoteId": "47.XX.XX.207"
  },
  "TunnelIpsecConfig": {
    "IpsecAuthAlg": "sha1",
    "IpsecEncAlg": "aes",
    "IpsecLifetime": 86400,
    "IpsecPfs": "group2"
  },
  "TunnelBgpConfig": {
    "EnableBgp": true,
    "LocalAsn": 65530,
    "LocalBgpIp": "169.254.11.1",
    "PeerAsn": 65531,
    "PeerBgpIp": "169.254.11.2",
    "TunnelCidr": "169.254.11.0/30"
  },
  "EnableNatTraversal": true,
  "EnableDpd": true,
  "RemoteCaCertificate": "-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE-----",
  "CustomerGatewayId": "cgw-p0wx48ayhrygitm80****",
  "Role": "master",
  "ZoneNo": "cn-hangzhou-h",
  "InternetIp": "47.XX.XX.87",
  "State": "active"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur
400	VpnGateway.Configuring	The specified service is configuring.
400	VpnGateway.FinancialLocked	The specified service is financial locked.
400	InvalidName	The name is not valid
400	VpnRouteEntry.AlreadyExists	The specified route entry is already exist.
400	VpnRouteEntry.Conflict	The specified route entry has conflict.
400	NotSupportVpnConnectionParameter.IpsecPfs	The specified vpn connection ipsec Ipsec Pfs is not support.
400	NotSupportVpnConnectionParameter.IpsecAuthAlg	The specified vpn connection ipsec Auth Alg is not support.
400	VpnConnectionParamInvalid.SameVpnAndCgwDifferentIkeConfigs	IPSec connections associated with the same user gateway and VPN gateway should have the same pre-shared key and IKE configuration.
400	VpnConnectionParamInvalid.SameVpnAndCgwTrafficSelectorOverlap	Traffic selectors of IPSec connections associated with the same user gateway and VPN gateway should not overlap.
400	IllegalParam.LocalAsn	The param of LocalAsn is illegal
400	IllegalParam.LocalBgpIp	The specified LocalBgpIp is invalid.
400	VpnGateway.task.conflict	The VPN is in the configuration state, please wait a while before operating.
400	ModifyIkeV1WithMultiRoutes.Invalid	Failed to modify VPN connection parameters. Multi-network is configured while using IkeV1 protocol.
400	EncAlgInvalid.DesIncompatible	Des/3des in IkeEncAlg and IpsecEncAlg does not support multi algorithm.
400	IkeVersionInvalid.GcmIncompatible	Ikev1 does not support IkeEncAlg of gcm16.
400	CustomerGateway.ConflictVpnIp	The specified customer gateway has conflict with vpn gateway ip.
400	CustomerGateway.AsnNotConfigured	ASN of CustomerGateway is required when enabling BGP on an IPSec connection.
403	Forbbiden.SubUser	User not authorized to operate on the specified resource as your account is created by another user.
403	Forbidden	User not authorized to operate on the specified resource.
404	InvalidVpnConnectionInstanceId.NotFound	The specified vpn connection 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.