DescribeVpnConnection - - Centre de documentation Alibaba Cloud

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	DescribeVpnConnection	L'opération que vous souhaitez effectuer. Définissez la valeur sur DescribeVpnConnection.
RegionId	String	Oui	cn-hangzhou	L'ID de la région où la connexion IPsec-VPN est créée. Vous pouvez appeler l'opération DescribeRegions pour interroger la liste des régions la plus récente.
VpnConnectionId	String	Oui	vco-bp1bbi27hojx80nck****	L'ID de la connexion IPsec-VPN.

Paramètres de réponse

Paramètre	Type	Exemple	Description
Status	String	ike_sa_not_established	L'état de la connexion IPsec-VPN. Valeurs possibles : ike_sa_not_established : Les négociations de la phase 1 ont échoué. ike_sa_established : Les négociations de la phase 1 ont réussi. ipsec_sa_not_established : Les négociations de la phase 2 ont échoué. ipsec_sa_established : Les négociations de la phase 2 ont réussi.
RemoteCaCertificate	String	-----BEGIN CERTIFICATE----- MIIB7zCCAZW****	Le certificat CA du pair.
EnableNatTraversal	Boolean	true	Indique si la traversée NAT est activée pour la connexion IPsec-VPN. true false Lorsque la traversée NAT est activée, l'initiateur ne vérifie pas les ports UDP lors des négociations IKE et peut découvrir automatiquement les dispositifs de passerelle NAT le long du tunnel VPN.
CreateTime	Long	1492753817000	L'horodatage indiquant quand la connexion IPsec-VPN a été établie. Unité : millisecondes. Cette valeur est un horodatage UNIX représentant le nombre de millisecondes écoulées depuis l'époque, soit le 1er janvier 1970 à 00:00:00 UTC.
EffectImmediately	Boolean	true	Indique si les négociations IPsec démarrent immédiatement. true : Les négociations sont relancées après la modification de la configuration. false : Les négociations sont relancées lorsque du trafic est détecté.
VpnGatewayId	String	vpn-bp1q8bgx4xnkm2ogj****	L'ID de la passerelle VPN.
LocalSubnet	String	10.0.0.0/8	Le bloc CIDR côté Alibaba Cloud. Les blocs CIDR sont séparés par des virgules (,).
RequestId	String	F2310D45-BCF6-4E2E-9082-B4503844BA4C	L'ID de la requête.
VpnConnectionId	String	vco-bp1bbi27hojx80nck****	L'ID de la connexion IPsec-VPN.
RemoteSubnet	String	192.168.0.0/16	Le bloc CIDR côté centre de données. Les blocs CIDR sont séparés par des virgules (,).
CustomerGatewayId	String	cgw-bp1mvj4g9kogwwcxk****	L'ID de la passerelle client associée à la connexion IPsec-VPN.
Name	String	ipsec1	Le nom de la connexion IPsec-VPN.
EnableDpd	Boolean	true	Indique si la détection de pair inactif (DPD) est activée pour la connexion IPsec-VPN. Valeurs possibles : false true Lorsque vous activez la DPD, l'initiateur de la connexion IPsec-VPN envoie des paquets DPD pour vérifier l'existence et la disponibilité du pair. Si aucune réponse n'est reçue du pair dans un délai spécifié, la connexion échoue. Ensuite, l'association de sécurité ISAKMP, l'association de sécurité IPsec et le tunnel IPsec sont supprimés.
IkeConfig	Object		Les configurations des négociations de la phase 1.
RemoteId	String	139.34.XX.XX	L'identifiant côté centre de données.
IkeLifetime	Long	86400	La durée de vie dans la phase IKE. Unité : secondes.
IkeEncAlg	String	aes	L'algorithme de chiffrement dans la phase IKE.
LocalId	String	116.28.XX.XX	L'identifiant côté Alibaba Cloud.
IkeMode	String	main	Le mode de négociation IKE. Valeurs possibles : main : Ce mode offre une sécurité plus élevée pendant les négociations. aggressive : Ce mode est plus rapide et présente un taux de réussite plus élevé.
IkeVersion	String	ikev1	La version IKE. ikev1 ikev2 Par rapport à IKEv1, IKEv2 simplifie le processus de négociation SA et convient mieux aux scénarios utilisant plusieurs blocs CIDR.
IkePfs	String	group2	Le groupe DH dans la phase IKE.
Psk	String	pgw6dy****	La clé pré-partagée.
IkeAuthAlg	String	sha1	L'algorithme d'authentification dans la phase IKE.
IpsecConfig	Object		Les configurations des négociations de la phase 2.
IpsecAuthAlg	String	sha1	L'algorithme d'authentification dans la phase IPsec.
IpsecLifetime	Long	86400	La durée de vie dans la phase IPsec. Unité : secondes.
IpsecEncAlg	String	aes	L'algorithme de chiffrement dans la phase IPsec.
IpsecPfs	String	group2	Le groupe DH dans la phase IPsec.
VcoHealthCheck	Object		Les informations de contrôle d'intégrité de la connexion IPsec-VPN.
Status	String	failed	L'état du contrôle d'intégrité. Valeurs possibles : failed success
Dip	String	10.0.0.1	L'adresse IP de destination.
Interval	Integer	3	L'intervalle entre les tentatives de contrôle d'intégrité. Unité : secondes.
Retry	Integer	3	Le nombre maximal de tentatives de contrôle d'intégrité.
Sip	String	192.168.1.1	L'adresse IP source.
Enable	String	true	Indique si la fonction de contrôle d'intégrité est activée pour la connexion IPsec-VPN. Valeurs possibles : false true
Policy	String	revoke_route	Indique si les routes annoncées sont retirées en cas d'échec du contrôle d'intégrité. revoke_route reserve_route
VpnBgpConfig	Object		La configuration BGP de la connexion IPsec-VPN.
Status	String	success	L'état de négociation du protocole de routage BGP. success failed
PeerBgpIp	String	169.254.11.1	L'adresse IP BGP du pair.
TunnelCidr	String	169.254.11.0/30	Le bloc CIDR BGP de la connexion IPsec-VPN. Le bloc CIDR se situe dans la plage 169.254.0.0/16. Le masque du bloc CIDR est de 30 bits.
EnableBgp	String	true	L'état du protocole de routage BGP. Valeurs possibles : true false
LocalBgpIp	String	169.254.11.2	L'adresse IP BGP côté Alibaba Cloud.
PeerAsn	Long	65530	Le numéro de système autonome (ASN) du pair.
LocalAsn	Long	65531	L'ASN côté Alibaba Cloud.
AuthKey	String	AuthKey****	La clé d'authentification du protocole de routage BGP.
AttachType	String	CEN	Le type de ressource associé à la connexion IPsec-VPN. Valeurs possibles : CEN : indique que la connexion IPsec-VPN est associée à un routeur de transit d'une instance Cloud Enterprise Network (CEN). NO_ASSOCIATED : indique que la connexion IPsec-VPN n'est associée à aucune ressource. VPNGW : indique que la connexion IPsec-VPN est associée à une passerelle VPN.
NetworkType	String	public	Le type de réseau de la connexion IPsec-VPN. Valeurs possibles : public private
AttachInstanceId	String	cen-lxxpbpalc776qz****	L'ID de l'instance CEN à laquelle appartient le routeur de transit.
Spec	String	1000M	La spécification de bande passante de la connexion IPsec-VPN. Unité : Mbit/s.
State	String	attached	L'état d'association de la connexion IPsec-VPN. Valeurs possibles : active : La connexion IPsec-VPN est associée à une passerelle VPN. init : La connexion IPsec-VPN n'est associée à aucune ressource et est en cours d'initialisation. attaching : La connexion IPsec-VPN est en cours d'association à un routeur de transit. attached : La connexion IPsec-VPN est associée à un routeur de transit. detaching : La connexion IPsec-VPN est en cours de désassociation d'un routeur de transit. financialLocked : La connexion IPsec-VPN est verrouillée en raison de paiements impayés. provisioning : La connexion IPsec-VPN est en cours de préparation. updating : La connexion IPsec-VPN est en cours de mise à jour. upgrading : La connexion IPsec-VPN est en cours de mise à niveau. deleted : La connexion IPsec-VPN est supprimée.
ZoneNo	String	ap-southeast-2b	L'ID de la zone où la connexion IPsec-VPN est déployée. Vous pouvez appeler DescribeZones pour interroger les ID de zone.
InternetIp	String	47.XX.XX.162	L'adresse IP de la passerelle de la connexion IPsec-VPN.
TransitRouterId	String	tr-p0we2edef9qr44a85****	L'ID du routeur de transit auquel la connexion IPsec-VPN est associée.
TransitRouterName	String	nametest	Le nom du routeur de transit.
CrossAccountAuthorized	Boolean	false	Indique si la connexion IPsec-VPN est associée à un routeur de transit appartenant à un autre compte Alibaba Cloud. Valeurs possibles : true false
Tags	Array of Tag		La liste des tags ajoutés à la connexion IPsec-VPN.
Tag
Key	String	TagKey	La clé du tag N.
Value	String	TagValue	La valeur du tag N.
TunnelOptionsSpecification	Array of TunnelOptions		La configuration du tunnel de la connexion IPsec-VPN. Les paramètres de TunnelOptionsSpecification sont renvoyés uniquement si vous interrogez des connexions IPsec-VPN en mode double tunnel.
TunnelOptions
TunnelId	String	tun-opsqc4d97wni27****	L'ID du tunnel.
CustomerGatewayId	String	cgw-p0wy363lucf1uyae8****	L'ID de la passerelle client associée au tunnel.
EnableDpd	String	true	Indique si la DPD est activée pour le tunnel. Valeurs possibles : false true
EnableNatTraversal	String	true	Indique si la traversée NAT est activée pour le tunnel. false true
InternetIp	String	47.21.XX.XX	L'adresse IP du tunnel.
RemoteCaCertificate	String	-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE-----	Le certificat CA du pair du tunnel. Ce paramètre est renvoyé uniquement si la passerelle VPN est de type ShangMi (SM).
Role	String	master	Le rôle du tunnel. Valeurs possibles : master slave
State	String	active	L'état du tunnel. Valeurs possibles : active updating deleting
Status	String	ipsec_sa_established	L'état de la connexion IPsec-VPN. Valeurs possibles : ike_sa_not_established : Les négociations de la phase 1 ont échoué. ike_sa_established : Les négociations de la phase 1 ont réussi. ipsec_sa_not_established : Les négociations de la phase 2 ont échoué. ipsec_sa_established : Les négociations de la phase 2 ont réussi.
TunnelBgpConfig	Object		Les configurations BGP.
BgpStatus	String	success	L'état de négociation BGP. Valeurs possibles : success false
LocalAsn	String	65530	L'ASN côté Alibaba Cloud.
LocalBgpIp	String	169.254.10.1	L'adresse IP BGP côté Alibaba Cloud.
PeerAsn	String	65531	L'ASN du pair.
PeerBgpIp	String	169.254.10.2	L'adresse IP BGP du pair.
TunnelCidr	String	169.254.10.0/30	Le bloc CIDR BGP du tunnel.
TunnelIkeConfig	Object		Les configurations des négociations de la phase 1.
IkeAuthAlg	String	sha1	L'algorithme d'authentification dans la phase IKE.
IkeEncAlg	String	aes	L'algorithme de chiffrement dans la phase IKE.
IkeLifetime	String	86400	La durée de vie dans la phase IKE. Unité : secondes.
IkeMode	String	main	Le mode de négociation IKE. Valeurs possibles : main : Ce mode offre une sécurité plus élevée pendant les négociations. aggressive : Ce mode est plus rapide et présente un taux de réussite plus élevé.
IkePfs	String	group2	Le groupe DH dans la phase IKE.
IkeVersion	String	ikev1	La version IKE.
LocalId	String	47.21.XX.XX	L'identifiant côté Alibaba Cloud.
Psk	String	123456****	La clé pré-partagée.
RemoteId	String	47.42.XX.XX	L'identifiant du pair.
TunnelIpsecConfig	Object		Les configurations des négociations de la phase 2.
IpsecAuthAlg	String	sha1	L'algorithme d'authentification dans la phase IPsec.
IpsecEncAlg	String	aes	L'algorithme de chiffrement dans la phase IPsec.
IpsecLifetime	String	86400	La durée de vie dans la phase IPsec. Unité : secondes.
IpsecPfs	String	group2	Le groupe DH dans la phase IPsec.
ZoneNo	String	ap-southeast-5a	La zone où le tunnel est déployé. Vous pouvez appeler DescribeZones pour interroger les ID de zone.
EnableTunnelsBgp	Boolean	true	L'état BGP du tunnel. Valeurs possibles : true false

Exemples

Exemples de requêtes

http(s)://[Endpoint]/?Action=DescribeVpnConnection
&RegionId=cn-hangzhou
&VpnConnectionId=vco-bp1bbi27hojx80nck****
&Common request parameters

Exemples de réponses réussies

Format XML

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

<DescribeVpnConnectionResponse>
    <Status>ike_sa_not_established</Status>
    <RemoteCaCertificate>-----BEGIN CERTIFICATE----- MIIB7zCCAZW****</RemoteCaCertificate>
    <EnableNatTraversal>true</EnableNatTraversal>
    <CreateTime>1492753817000</CreateTime>
    <EffectImmediately>true</EffectImmediately>
    <VpnGatewayId>vpn-bp1q8bgx4xnkm2ogj****</VpnGatewayId>
    <State>active</State>
    <LocalSubnet>10.0.0.0/8</LocalSubnet>
    <RequestId>F2310D45-BCF6-4E2E-9082-B4503844BA4C</RequestId>
    <VpnConnectionId>vco-bp1bbi27hojx80nck****</VpnConnectionId>
    <RemoteSubnet>192.168.0.0/16</RemoteSubnet>
    <CustomerGatewayId>cgw-bp1mvj4g9kogwwcxk****</CustomerGatewayId>
    <Name>ipsec1</Name>
    <EnableDpd>true</EnableDpd>
    <IkeConfig>
        <RemoteId>139.34.XX.XX</RemoteId>
        <IkeLifetime>86400</IkeLifetime>
        <IkeEncAlg>aes</IkeEncAlg>
        <LocalId>116.28.XX.XX</LocalId>
        <IkeMode>main</IkeMode>
        <IkeVersion>ikev1</IkeVersion>
        <IkePfs>group2</IkePfs>
        <Psk>pgw6dy****</Psk>
        <IkeAuthAlg>sha1</IkeAuthAlg>
    </IkeConfig>
    <IpsecConfig>
        <IpsecAuthAlg>sha1</IpsecAuthAlg>
        <IpsecLifetime>86400</IpsecLifetime>
        <IpsecEncAlg>aes</IpsecEncAlg>
        <IpsecPfs>group2</IpsecPfs>
    </IpsecConfig>
    <VcoHealthCheck>
        <Status>failed</Status>
        <Dip>10.0.0.1</Dip>
        <Interval>3</Interval>
        <Retry>3</Retry>
        <Sip>192.168.1.1</Sip>
        <Enable>true</Enable>
    </VcoHealthCheck>
    <VpnBgpConfig>
        <Status>success</Status>
        <PeerBgpIp>169.254.11.1</PeerBgpIp>
        <TunnelCidr>169.254.11.0/30</TunnelCidr>
        <EnableBgp>true</EnableBgp>
        <LocalBgpIp>169.254.11.2</LocalBgpIp>
        <PeerAsn>65530</PeerAsn>
        <LocalAsn>65531</LocalAsn>
        <AuthKey>AuthKey****</AuthKey>
    </VpnBgpConfig>
</DescribeVpnConnectionResponse>

Format JSON

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

{
  "Status" : "ike_sa_not_established",
  "RemoteCaCertificate" : "-----BEGIN CERTIFICATE----- MIIB7zCCAZW****",
  "EnableNatTraversal" : true,
  "CreateTime" : 1492753817000,
  "EffectImmediately" : true,
  "VpnGatewayId" : "vpn-bp1q8bgx4xnkm2ogj****",
  "State" : "active",
  "LocalSubnet" : "10.0.0.0/8",
  "RequestId" : "F2310D45-BCF6-4E2E-9082-B4503844BA4C",
  "VpnConnectionId" : "vco-bp1bbi27hojx80nck****",
  "RemoteSubnet" : "192.168.0.0/16",
  "CustomerGatewayId" : "cgw-bp1mvj4g9kogwwcxk****",
  "Name" : "ipsec1",
  "EnableDpd" : true,
  "IkeConfig" : {
    "RemoteId" : "139.34.XX.XX",
    "IkeLifetime" : 86400,
    "IkeEncAlg" : "aes",
    "LocalId" : "116.28.XX.XX",
    "IkeMode" : "main",
    "IkeVersion" : "ikev1",
    "IkePfs" : "group2",
    "Psk" : "pgw6dy****",
    "IkeAuthAlg" : "sha1"
  },
  "IpsecConfig" : {
    "IpsecAuthAlg" : "sha1",
    "IpsecLifetime" : 86400,
    "IpsecEncAlg" : "aes",
    "IpsecPfs" : "group2"
  },
  "VcoHealthCheck" : {
    "Status" : "failed",
    "Dip" : "10.0.0.1",
    "Interval" : 3,
    "Retry" : 3,
    "Sip" : "192.168.1.1",
    "Enable" : "true"
  },
  "VpnBgpConfig" : {
    "Status" : "success",
    "PeerBgpIp" : "169.254.11.1",
    "TunnelCidr" : "169.254.11.0/30",
    "EnableBgp" : "true",
    "LocalBgpIp" : "169.254.11.2",
    "PeerAsn" : 65530,
    "LocalAsn" : 65531,
    "AuthKey" : "AuthKey****"
  }
}

Codes d'erreur

Code HTTP	Code d'erreur	Message d'erreur	Description
403	Forbbiden.SubUser	User not authorized to operate on the specified resource as your account is created by another user.	Vous n'êtes pas autorisé à effectuer cette opération sur la ressource spécifiée. Vous pouvez demander les autorisations requises et réessayer.
403	Forbidden	User not authorized to operate on the specified resource.	Vous n'êtes pas autorisé à effectuer cette opération sur la ressource spécifiée. Vous pouvez demander les autorisations requises et réessayer.
404	InvalidVpnConnectionInstanceId.NotFound	The specified vpn connection instance id does not exist.	La connexion IPsec spécifiée n'existe pas. Vérifiez si l'ID de la connexion IPsec est valide.

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