ModifyVpnGatewayAttribute - - Centre de documentation Alibaba Cloud

Notes d'utilisation

ModifyVpnGatewayAttribute est une opération asynchrone. Une fois la requête envoyée, 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 updating, elle est en cours de modification.
- Si la passerelle VPN est dans l'état active, la modification est terminée.
Vous ne pouvez pas appeler ModifyVpnGatewayAttribute de manière répétée pour modifier une passerelle VPN dans un délai spécifié.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de 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	ModifyVpnGatewayAttribute	Opération à effectuer. Définissez la valeur sur ModifyVpnGatewayAttribute.
RegionId	String	Oui	ap-southeast-2	ID de la région où la passerelle VPN est créée. Appelez l'opération DescribeRegions pour interroger la liste des régions la plus récente.
ClientToken	String	Non	123e4567-e89b-12d3-a456-4266****	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.
VpnGatewayId	String	Oui	vpn-bp1q8bgx4xnkm2ogj****	ID de la passerelle VPN.
Name	String	Non	myvpn	Nouveau nom 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 ne sont pas pris en charge.
Description	String	Non	test	Nouvelle description de la passerelle VPN. La description doit comporter entre 1 et 100 caractères et ne peut pas commencer par `http://` ou `https://`.
AutoPropagate	Boolean	Non	true	Indique s'il faut annoncer automatiquement les routes BGP au cloud privé virtuel (VPC). Valeurs possibles : true false

Paramètres de réponse

Paramètre	Type	Exemple	Description
VpcId	String	vpc-bp1ub1yt9cvakoel****	ID du VPC auquel appartient la passerelle VPN.
Status	String	active	État de la passerelle VPN. init provisioning active updating deleting
InternetIp	String	116.62.XX.XX	Si la passerelle VPN prend en charge les connexions IPsec-VPN en mode tunnel unique, l'adresse correspond à l'adresse IP de la passerelle VPN et peut être utilisée pour créer une connexion IPsec-VPN ou SSL-VPN. Si la passerelle VPN prend en charge les connexions IPsec-VPN en mode double tunnel, l'adresse correspond à la première adresse IP utilisée pour créer une connexion IPsec-VPN. Cette adresse ne peut pas être utilisée pour créer une connexion SSL-VPN. Si la passerelle VPN prend en charge les connexions IPsec-VPN en mode double tunnel, le système attribue deux adresses IP à la passerelle VPN pour créer deux tunnels chiffrés.
Spec	String	5M	Bande passante maximale de la passerelle VPN. Unité : Mbit/s.
CreateTime	Long	1492753580000	Date de création de la passerelle VPN. Unité : millisecondes. Cette valeur est un horodatage UNIX représentant le nombre de millisecondes écoulées depuis le 1er janvier 1970, 00:00:00 UTC.
AutoPropagate	Boolean	true	Indique si les routes BGP sont automatiquement annoncées au VPC. Valeurs possibles : true false
VpnGatewayId	String	vpn-bp1q8bgx4xnkm2ogj****	ID de la passerelle VPN.
IntranetIp	String	172.27.30.24	Adresse IP de la passerelle VPN. Ce paramètre n'est renvoyé que lorsque la passerelle VPN est une passerelle VPN privée et ne prend en charge que le mode tunnel unique.
EndTime	Long	1495382400000	Date d'expiration de la passerelle VPN. Unité : millisecondes. Cette valeur est un horodatage UNIX représentant le nombre de millisecondes écoulées depuis le 1er janvier 1970, 00:00:00 UTC.
VSwitchId	String	vsw-bp1y9ovl1cu9ou4tv****	ID du vSwitch associé à la passerelle VPN.
RequestId	String	54B48E3D-DF70-471B-AA93-08E683A1B457	ID de la requête.
Description	String	test	Description de la passerelle VPN.
EnableBgp	Boolean	true	Indique si BGP est activé pour la passerelle VPN. Valeurs possibles : true false
BusinessStatus	String	Normal	État de paiement de la passerelle VPN. Valeurs possibles : Normal FinancialLocked
Name	String	test	Nom de la passerelle VPN.
DisasterRecoveryInternetIp	String	116.11.XX.XX	Deuxième adresse IP attribuée par le système pour créer une connexion IPsec-VPN. Ce paramètre n'est renvoyé que lorsque la passerelle VPN prend en charge le mode double tunnel.
DisasterRecoveryVSwitchId	String	vsw-p0w95ql6tmr2ludkt****	ID du deuxième vSwitch associé à la passerelle VPN. Ce paramètre n'est renvoyé que lorsque la passerelle VPN prend en charge le mode double tunnel.
SslVpnInternetIp	String	116.33.XX.XX	Adresse IP de la connexion SSL-VPN. Ce paramètre n'est renvoyé que lorsque la passerelle VPN est une passerelle VPN publique, ne prend en charge que le mode tunnel unique et a la fonctionnalité SSL-VPN activée.

Exemples

Exemple de requête

http(s)://[Endpoint]/?Action=ModifyVpnGatewayAttribute
&RegionId=ap-southeast-2
&ClientToken=123e4567-e89b-12d3-a456-4266****
&VpnGatewayId=vpn-bp1q8bgx4xnkm2ogj****
&Name=myvpn
&Description=test
&AutoPropagate=true
&Common request parameters

Exemple de réponse réussie

Format XML

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

<ModifyVpnGatewayAttributeResponse>
    <VpcId>vpc-bp1ub1yt9cvakoel****</VpcId>
    <Status>active</Status>
    <InternetIp>116.62.XX.XX</InternetIp>
    <Spec>5M</Spec>
    <CreateTime>1492753580000</CreateTime>
    <AutoPropagate>true</AutoPropagate>
    <VpnGatewayId>vpn-bp1q8bgx4xnkm2ogj****</VpnGatewayId>
    <EndTime>1495382400000</EndTime>
    <VSwitchId>vsw-bp1y9ovl1cu9ou4tv****</VSwitchId>
    <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B457</RequestId>
    <Description>test</Description>
    <EnableBgp>true</EnableBgp>
    <BusinessStatus>Normal</BusinessStatus>
    <DisasterRecoveryVSwitchId>vsw-p0w95ql6tmr2ludkt****</DisasterRecoveryVSwitchId>
    <DisasterRecoveryInternetIp>116.11.XX.XX</DisasterRecoveryInternetIp>
    <SslVpnInternetIp>116.33.XX.XX</SslVpnInternetIp>
    <Name>test</Name>
</ModifyVpnGatewayAttributeResponse>

Format JSON

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

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

Codes d'erreur

HttpCode

Code d'erreur

Message d'erreur

Description

400

InvalidName

The name is not valid

Le format du nom n'est pas valide.

400

InvalidDescription

The description is not valid

Le format de la description n'est pas valide.

400

OperationUnsupported.EnableBgp

Current version of the VPN does not support enable BGP.

La version actuelle de la passerelle VPN ne prend pas en charge BGP.

400

OperationFailed.VpnConnectionExist

Auto propagate cannot be closed when VPN connections with BGP enabled exist.

Vous ne pouvez pas désactiver l'annonce automatique des routes lorsqu'une connexion VPN existante a BGP activé.

400

InvalidVpnGatewayInstanceId.NotFound

The specified vpn gateway instance id does not exist.

La passerelle VPN spécifiée n'existe pas. Vérifiez si la passerelle VPN spécifiée est valide.

400

VpnGateway.Configuring

The specified service is configuring.

L'opération n'est pas autorisée lorsque le service spécifié est en cours de configuration. Réessayez ultérieurement.

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.

Vous ne pouvez pas activer BGP pour une passerelle VPN lorsque le mode FULL est activé pour l'instance Cloud Enterprise Network (CEN) à laquelle le VPC de la passerelle VPN est attaché.

403

Forbidden.SubUser

User not authorized to operate on the specified resource as your account is created by another user.

Vous n'avez pas les autorisations nécessaires pour effectuer cette opération sur la ressource spécifiée. Obtenez les autorisations requises et réessayez.

403

Forbidden

User not authorized to operate on the specified resource.

Vous n'avez pas les autorisations nécessaires pour effectuer l'opération sur la ressource spécifiée. Obtenez les autorisations requises et réessayez.

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