DescribeVpnGateways - - Centre de documentation Alibaba Cloud

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'utiliser OpenAPI Explorer pour appeler cette opération. OpenAPI Explorer génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	DescribeVpnGateways	Opération à effectuer. Définissez la valeur sur DescribeVpnGateways.
RegionId	String	Oui	ap-southeast-2	ID de la région où la passerelle VPN est créée. Appelez l'opération DescribeRegions pour obtenir la liste des régions.
VpcId	String	Non	vpc-bp1m3i0kn1nd4wiw9****	ID du VPC auquel appartient la passerelle VPN.
VpnGatewayId	String	Non	vpn-bp17lofy9fd0dnvzv****	ID de la passerelle VPN.
Status	String	Non	active	État de la passerelle VPN. Valeurs possibles : init provisioning active updating deleting
BusinessStatus	String	Non	Normal	État de paiement de la passerelle VPN. Valeurs possibles : Normal FinancialLocked
PageNumber	Integer	Non	1	Numéro de la page à renvoyer. Valeur par défaut : 1.
PageSize	Integer	Non	10	Nombre d'entrées par page. Valeurs possibles : 1 à 50. Valeur par défaut : 10.
IncludeReservationData	Boolean	Non	true	Indique s'il faut renvoyer les informations sur les commandes en attente. Valeurs possibles : false (par défaut) true
Tag.N.Key	String	Non	FinanceDept	Clé du tag N. La clé ne peut pas être une chaîne vide. Longueur maximale : 64 caractères. Ne doit pas contenir `http://` ni `https://`. Ne doit pas commencer par `aliyun` ou `acs:`. Spécifiez jusqu'à 20 clés de tag par appel.
Tag.N.Value	String	Non	FinanceJoshua	Valeur du tag N. La valeur peut être une chaîne vide et ne doit pas dépasser 128 caractères. Elle ne doit pas commencer par `aliyun` ou `acs:`, et ne doit pas contenir `http://` ni `https://`. Chaque clé de tag correspond à une valeur. Spécifiez jusqu'à 20 valeurs de tag par appel.

Paramètres de réponse

Paramètre	Type	Exemple	Description
PageSize	Integer	10	Nombre d'entrées renvoyées par page.
RequestId	String	DF11D6F6-E35A-41C3-9B20-6FC8A901FE65	ID de la requête.
PageNumber	Integer	1	Numéro de la page renvoyée.
TotalCount	Integer	1	Nombre total d'entrées renvoyées.
VpnGateways	Array of VpnGateway		Liste des passerelles VPN.
VpnGateway
VpnType	String	Normal	Type de la passerelle VPN. La valeur est définie sur Normal, ce qui indique une passerelle NAT standard.
Status	String	active	État de la passerelle VPN. init provisioning active updating deleting
VpcId	String	vpc-bp1m3i0kn1nd4wiw9****	ID du VPC auquel appartient la passerelle VPN.
SslMaxConnections	Long	5	Nombre de connexions SSL-VPN prises en charge par la passerelle VPN.
Spec	String	5M	Bande passante maximale de la passerelle VPN. M indique Mbit/s.
InternetIp	String	47.12.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 servir à 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 permet pas de créer une connexion SSL-VPN. En mode double tunnel, le système attribue deux adresses IP à la passerelle VPN afin de créer deux tunnels chiffrés.
CreateTime	Long	1515383700000	Horodatage 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
ChargeType	String	Exemple de valeur pour le site Chine (aliyun.com) : Prepay. Exemple de valeur pour le site international (alibabacloud.com) : POSTPAY.	Mode de facturation de la passerelle VPN. Seule la valeur POSTPAY peut être renvoyée, ce qui indique le mode de facturation à l'utilisation.
VpnGatewayId	String	vpn-bp17lofy9fd0dnvzv****	ID de la passerelle VPN.
Tag	String	{\"VpnEnableBgp\":\"true\",\"VisuallySsl\":\"true\",\"PbrPriority\":\"true\",\"VpnNewImage\":\"true\",\"description\":\"forwarding1.3.7\",\"VpnVersion\":\"v1.2.4\"}	Tag généré automatiquement pour la passerelle VPN. VpnEnableBgp : indique si la passerelle VPN prend en charge BGP. Valeurs possibles : true false VisuallySsl : indique si la passerelle VPN permet d'afficher les informations sur les clients SSL connectés. true false PbrPriority : indique si la passerelle VPN permet de configurer les priorités pour les routes basées sur des politiques. true false VpnNewImage : indique si la passerelle VPN est mise à niveau. true false description : description de la passerelle VPN. Ce paramètre est réservé à un usage interne du système. VpnVersion : version de la passerelle VPN.
IpsecVpn	String	enable	Indique si IPsec-VPN est activé pour la passerelle VPN. enable disable
EndTime	Long	1518105600000	Horodatage d'expiration de la passerelle VPN. 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.
VSwitchId	String	vsw-bp15lbk8sgtr6r5b0****	ID du vSwitch auquel appartient la passerelle VPN.
Description	String	test	Description de la passerelle VPN.
EnableBgp	Boolean	true	État BGP de la passerelle VPN. true false
BusinessStatus	String	Normal	État de paiement de la passerelle VPN. Normal FinancialLocked
SslVpn	String	enable	Indique si SSL-VPN est activé pour la passerelle VPN. enable disable
Name	String	test	Nom de la passerelle VPN.
NetworkType	String	public	Type de réseau de la passerelle VPN. public private
Tags	Array of Tag		Liste des tags ajoutés à la passerelle VPN.
Tag
Key	String	FinanceDept	Clé du tag.
Value	String	FinanceJoshua	Valeur du tag.
ReservationData	Object		Informations sur les commandes en attente. Remarque Ce paramètre est renvoyé uniquement lorsque IncludeReservationData est défini sur true.
Status	String	1	État de la commande en attente. 1 : indique que la commande est une commande de renouvellement ou de renouvellement avec modification des spécifications et qu'elle n'est pas encore entrée en vigueur. 2 : indique que la commande est une commande de mise à niveau temporaire et qu'elle est entrée en vigueur. À l'expiration de la mise à niveau temporaire, le système restaure les spécifications précédentes de la passerelle VPN. Dans ce cas, ReservationIpsec, ReservationMaxConnections, ReservationSpec et ReservationSsl indiquent les spécifications précédentes.
ReservationOrderType	String	TEMP_UPGRADE	Type de la commande qui n'est pas encore entrée en vigueur. Valeurs possibles : RENEWCHANGE : renouvellement avec modification des spécifications TEMP_UPGRADE : mise à niveau temporaire RENEW : renouvellement
ReservationIpsec	String	enable	État IPsec-VPN de la commande qui n'est pas encore entrée en vigueur. Valeurs possibles : enable disable
ReservationSpec	String	5	Bande passante de la commande en attente. Unité : Mbit/s.
ReservationSsl	String	enable	État SSL-VPN de la commande qui n'est pas encore entrée en vigueur. Valeurs possibles : enable disable
ReservationMaxConnections	Integer	5	Nombre maximal de connexions SSL-VPN simultanées de la commande en attente.
ReservationEndTime	String	2021-07-20T16:00:00Z	Si le type de commande est TEMP_UPGRADE (mise à niveau temporaire), ce paramètre spécifie l'heure d'expiration de la mise à niveau temporaire. Si le type de commande est RENEWCHANGE (renouvellement avec modification des spécifications) ou RENEW (renouvellement), ce paramètre indique l'heure d'entrée en vigueur du renouvellement ou du renouvellement avec modification des spécifications.
DisasterRecoveryInternetIp	String	47.91.XX.XX	Deuxième adresse IP attribuée par le système pour créer une connexion IPsec-VPN. Ce paramètre est renvoyé uniquement 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 est renvoyé uniquement lorsque la passerelle VPN prend en charge le mode double tunnel.
SslVpnInternetIp	String	47.74.XX.XX	Adresse IP de la connexion SSL-VPN. Ce paramètre est renvoyé uniquement lorsque la passerelle VPN est publique, prend en charge uniquement le mode tunnel unique et a la fonctionnalité SSL-VPN activée.

Exemples

Exemples de requêtes

http(s)://[Endpoint]/?Action=DescribeVpnGateways
&RegionId=ap-southeast-2
&VpcId=vpc-bp1m3i0kn1nd4wiw9****
&VpnGatewayId=vpn-bp17lofy9fd0dnvzv****
&Status=active
&BusinessStatus=Normal
&PageNumber=1
&PageSize=10
&IncludeReservationData=true
&Tag=[{"Key":"FinanceDept","Value":"FinanceJoshua"}]
&Common request parameters

Exemples de réponses réussies

XML format

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

<DescribeVpnGatewaysResponse>
    <PageSize>10</PageSize>
    <RequestId>DF11D6F6-E35A-41C3-9B20-6FC8A901FE65</RequestId>
    <PageNumber>1</PageNumber>
    <TotalCount>1</TotalCount>
    <VpnGateways>
        <VpnType>Normal</VpnType>
        <Status>Active</Status>
        <VpcId>vpc-bp1m3i0kn1nd4wiw9****</VpcId>
        <SslMaxConnections>5</SslMaxConnections>
        <Spec>5M</Spec>
        <InternetIp>47.12.XX.XX</InternetIp>
        <CreateTime>1515383700000</CreateTime>
        <AutoPropagate>true</AutoPropagate>
        <ChargeType>Example value for China site (aliyun.com): Prepay. Example value for International site (alibabacloud.com): POSTPAY.</ChargeType>
        <VpnGatewayId>vpn-bp17lofy9fd0dnvzv****</VpnGatewayId>
        <Tag>{\"VpnEnableBgp\":\"true\",\"VisuallySsl\":\"true\",\"PbrPriority\":\"true\",\"VpnNewImage\":\"true\",\"description\":\"forwarding1.3.7\",\"VpnVersion\":\"v1.2.4\"}</Tag>
        <IpsecVpn>enable</IpsecVpn>
        <EndTime>1518105600000</EndTime>
        <VSwitchId>vsw-bp15lbk8sgtr6r5b0****</VSwitchId>
        <Description>test</Description>
        <EnableBgp>true</EnableBgp>
        <BusinessStatus>Normal</BusinessStatus>
        <SslVpn>enable</SslVpn>
        <Name>test</Name>
        <NetworkType>public</NetworkType>
        <DisasterRecoveryVSwitchId>vsw-p0w95ql6tmr2ludkt****</DisasterRecoveryVSwitchId>
        <DisasterRecoveryInternetIp>47.91.XX.XX</DisasterRecoveryInternetIp>
        <SslVpnInternetIp>47.74.XX.XX</SslVpnInternetIp>
        <Tags>
            <Key>FinanceDept</Key>
            <Value>FinanceJoshua</Value>
        </Tags>
        <ReservationData>
            <Status>1</Status>
            <ReservationOrderType>TEMP_UPGRADE</ReservationOrderType>
            <ReservationIpsec>enable</ReservationIpsec>
            <ReservationSpec>5</ReservationSpec>
            <ReservationSsl>enable</ReservationSsl>
            <ReservationMaxConnections>5</ReservationMaxConnections>
            <ReservationEndTime>2021-07-20T16:00:00Z</ReservationEndTime>
        </ReservationData>
    </VpnGateways>
</DescribeVpnGatewaysResponse>

JSON format

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

{
  "PageSize" : 10,
  "RequestId" : "DF11D6F6-E35A-41C3-9B20-6FC8A901FE65",
  "PageNumber" : 1,
  "TotalCount" : 1,
  "VpnGateways" : [ {
    "VpnType" : "Normal",
    "Status" : "Active",
    "VpcId" : "vpc-bp1m3i0kn1nd4wiw9****",
    "SslMaxConnections" : 5,
    "Spec" : "5M",
    "InternetIp" : "47.12.XX.XX",
    "CreateTime" : 1515383700000,
    "AutoPropagate" : true,
    "ChargeType": Example value for  China site (aliyun.com): Prepay. Example value for International site (alibabacloud.com): POSTPAY.
    "VpnGatewayId" : "vpn-bp17lofy9fd0dnvzv****",
    "Tag" : "{\"VpnEnableBgp\":\"true\",\"VisuallySsl\":\"true\",\"PbrPriority\":\"true\",\"VpnNewImage\":\"true\",\"description\":\"forwarding1.3.7\",\"VpnVersion\":\"v1.2.4\"}",
    "IpsecVpn" : "enable",
    "EndTime" : 1518105600000,
    "VSwitchId" : "vsw-bp15lbk8sgtr6r5b0****",
    "Description" : "test",
    "EnableBgp" : true,
    "BusinessStatus" : "Normal",
    "SslVpn" : "enable",
    "Name" : "test",
    "NetworkType" : "public",
    "DisasterRecoveryVSwitchId" : "vsw-p0w95ql6tmr2ludkt****",
    "DisasterRecoveryInternetIp" : "47.91.XX.XX",
    "SslVpnInternetIp" : "47.74.XX.XX",
    "Tags" : [ {
      "Key" : "FinanceDept",
      "Value" : "FinanceJoshua"
    } ],
    "ReservationData" : {
      "Status" : "1",
      "ReservationOrderType" : "TEMP_UPGRADE",
      "ReservationIpsec" : "enable",
      "ReservationSpec" : "5",
      "ReservationSsl" : "enable",
      "ReservationMaxConnections" : 5,
      "ReservationEndTime" : "2021-07-20T16:00:00Z"
    }
  } ]
}

Codes d'erreur

HttpCode

Error code

Error message

Description

400

InvalidParameter.TagKey

The specified parameter TagKey is invalid.

La clé de tag spécifiée n'est pas valide.

400

InvalidParameter.TagValue

The specified parameter TagValue is invalid.

La valeur de tag spécifiée n'est pas valide.

400

Duplicated.TagKey

The specified parameter TagKey is duplicated.

La clé de tag spécifiée existe déjà.

400

InternalError

The request processing has failed due to some unknown error, exception or failure.

Une erreur interne s'est produite.

403

Forbidden.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. Demandez les autorisations requises et réessayez.

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. Obtenez les autorisations requises et réessayez.

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