DescribeNatGateways - - Centre de documentation Alibaba Cloud

Notes d'utilisation

Cette opération permet d'interroger aussi bien les passerelles NAT de Virtual Private Cloud (VPC) que les passerelles NAT Internet. Dans cette rubrique, le terme « passerelle NAT » désigne indistinctement ces deux types de passerelles.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de commodité, nous vous recommandons d'appeler cette opération via OpenAPI Explorer. Ce dernier 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	Yes	DescribeNatGateways	Opération à exécuter. Définissez la valeur sur DescribeNatGateways.
RegionId	String	Yes	cn-hangzhou	ID de la région des passerelles NAT à interroger. Appelez l'opération DescribeRegions pour obtenir la liste la plus récente des régions.
NatGatewayId	String	No	ngw-bp1uewa15k4iy5770****	ID de la passerelle NAT.
VpcId	String	No	vpc-bp15zckdt37pq72z****	ID du VPC auquel appartient la passerelle NAT.
Name	String	No	test	Nom de la passerelle NAT. Le nom doit comporter entre 1 et 128 caractères. Il ne peut pas commencer par `http://` ou `https://`. Si ce paramètre n'est pas spécifié, le système attribue automatiquement un nom à la passerelle NAT.
InstanceChargeType	String	No	PostPaid	Mode de facturation de la passerelle NAT. Définissez la valeur sur PostPaid (paiement à l'utilisation).
Spec	String	No	Exemple de valeur pour le site China d'Alibaba Cloud : Small. Si vous utilisez le site International d'Alibaba Cloud, ignorez ce paramètre.	Taille de la passerelle NAT. Ignorez ce paramètre.
NatType	String	No	Enhanced	Type de passerelle NAT. Définissez la valeur sur Enhanced (passerelle NAT améliorée).
ResourceGroupId	String	No	rg-bp67acfmxazb4ph****	ID du groupe de ressources auquel appartient la passerelle NAT.
PageNumber	Integer	No	10	Numéro de la page à renvoyer. Valeur par défaut : 1.
PageSize	Integer	No	1	Nombre d'entrées à renvoyer par page. Valeur maximale : 50. Valeur par défaut : 10.
DryRun	Boolean	No	false	Indique s'il faut effectuer uniquement une simulation sans exécuter la requête réelle. Valeurs valides : true : effectue uniquement une simulation. Le système vérifie la requête pour détecter d'éventuels problèmes (valeurs de paramètres manquantes, syntaxe incorrecte, limites de service). Si la simulation échoue, un message d'erreur est renvoyé. En cas de succès, le code d'erreur `DryRunOperation` est retourné. false (par défaut) : effectue une simulation puis exécute la requête réelle. Si la simulation réussit, un code de statut HTTP 2xx est renvoyé et l'opération s'exécute.
Status	String	No	Available	État de la passerelle NAT. Valeurs valides : Creating : après l'envoi d'une requête de création, le système génère la passerelle NAT en arrière-plan. Elle reste dans l'état Creating jusqu'à la fin de l'opération. Available : la passerelle NAT est stable après sa création. Modifying : suite à une demande de modification, le système met à jour la passerelle NAT en arrière-plan. L'état Modifying persiste jusqu'à l'achèvement de l'opération. Deleting : lors d'une requête de suppression, le système efface la passerelle NAT en arrière-plan. Elle demeure dans l'état Deleting pendant toute la durée du processus. Converting : après une demande de mise à niveau d'une passerelle NAT standard vers une passerelle NAT améliorée, le système procède à la conversion en arrière-plan. L'état Converting est maintenu jusqu'à la fin de l'opération.
NetworkType	String	No	internet	Type de la passerelle NAT. Valeurs valides : internet : passerelle NAT Internet intranet : passerelle NAT VPC
Tag.N.Key	String	No	KeyTest	Clés de tag de la passerelle NAT. Vous pouvez spécifier jusqu'à 20 clés de tag. Chaque clé de tag ne doit pas dépasser 64 caractères. Elle ne peut pas commencer par `aliyun` ou `acs:`, ni contenir `http://` ou `https://`.
Tag.N.Value	String	No	valueTest	Valeurs de tag de la passerelle NAT. Vous pouvez spécifier jusqu'à 20 valeurs de tag. La valeur du tag ne doit pas excéder 128 caractères. Elle ne peut pas commencer par `aliyun` ou `acs:`, ni contenir `http://` ou `https://`.
ZoneId	String	No	cn-hangzhou-b	ID de la zone à laquelle appartient la passerelle NAT.

Paramètres de réponse

Paramètre	Type	Exemple	Description
PageSize	Integer	10	Nombre d'entrées renvoyées par page.
RequestId	String	4EC47282-1B74-4534-BD0E-403F3EE64CAF	ID de la requête.
PageNumber	Integer	10	Numéro de la page renvoyée.
TotalCount	Integer	1	Nombre total d'entrées de passerelles NAT renvoyées.
NatGateways	Array of NatGateway		Détails de la passerelle NAT.
NatGateway
Status	String	Creating	État de la passerelle NAT. Valeurs valides : Creating : après l'envoi d'une requête de création, le système génère la passerelle NAT en arrière-plan. Elle reste dans l'état Creating jusqu'à la fin de l'opération. Available : la passerelle NAT est stable après sa création. Modifying : suite à une demande de modification, le système met à jour la passerelle NAT en arrière-plan. L'état Modifying persiste jusqu'à l'achèvement de l'opération. Deleting : lors d'une requête de suppression, le système efface la passerelle NAT en arrière-plan. Elle demeure dans l'état Deleting pendant toute la durée du processus. Converting : après une demande de mise à niveau d'une passerelle NAT standard vers une passerelle NAT améliorée, le système procède à la conversion en arrière-plan. L'état Converting est maintenu jusqu'à la fin de l'opération.
CreationTime	String	2021-06-08T12:20:20Z	Heure de création de la passerelle NAT.
VpcId	String	vpc-bp15zckdt37pq72z****	ID du VPC où la passerelle NAT est déployée.
NatType	String	Enhanced	Type de la passerelle NAT. La valeur est définie sur Enhanced (passerelle NAT améliorée).
AutoPay	Boolean	false	Indique si le paiement automatique est activé. Valeurs valides : false true
Spec	String	Small	Taille de la passerelle NAT. Une valeur vide est renvoyée pour ce paramètre. Si InternetChargeType est défini sur PayByLcu, une valeur vide est renvoyée.
DeletionProtection	Boolean	true	Indique si la protection contre la suppression est activée. Valeurs valides : true false
NetworkType	String	internet	Type de passerelle NAT. Valeurs valides : internet : passerelle NAT Internet intranet : passerelle NAT VPC
SecurityProtectionEnabled	Boolean	false	Indique si la fonctionnalité de pare-feu est activée. Valeurs valides : false : non true : oui
InstanceChargeType	String	PostPaid	Mode de facturation de la passerelle NAT. La valeur est définie sur PostPaid (paiement à l'utilisation).
RegionId	String	cn-hangzhou	ID de la région où la passerelle NAT est déployée.
EcsMetricEnabled	Boolean	true	Indique si la surveillance du trafic est activée. Valeurs valides : true false
IcmpReplyEnabled	Boolean	true	Indique si la réponse ICMP est activée. Valeurs valides : true (par défaut) : oui false
Description	String	NAT	Description de la passerelle NAT.
ExpiredTime	String	2021-08-26T16:00Z	Date d'expiration de la passerelle NAT.
ResourceGroupId	String	rg-bp67acfmxazb4ph****	ID du groupe de ressources auquel appartient le groupe d'EIP contiguës.
NatGatewayId	String	ngw-bp1047e2d4z7kf2ki****	ID de la passerelle NAT Internet.
InternetChargeType	String	PayByLcu	Mode de facturation de la passerelle NAT. Valeurs valides : PayBySpec : facturation par spécification PayByLcu : facturation par CU
BusinessStatus	String	Normal	État commercial de la passerelle NAT. Valeurs valides : Normal FinancialLocked
Name	String	abc	Nom de la passerelle NAT.
IpLists	Array of IpList		Liste des adresses IP élastiques (EIP) associées à la passerelle NAT Internet.
IpList
UsingStatus	String	UsedByForwardTable	Association entre l'EIP et la passerelle NAT Internet. Valeurs valides : UsedByForwardTable : l'EIP est spécifiée dans une entrée DNAT. UsedBySnatTable : l'EIP est spécifiée dans une entrée SNAT. UsedByForwardSnatTable : l'EIP est spécifiée à la fois dans une entrée SNAT et une entrée DNAT. Idle : l'EIP n'est spécifiée dans aucune entrée DNAT ou SNAT.
IpAddress	String	116,62.XX.XX	Adresse IP de l'EIP associée à la passerelle NAT.
SnatEntryEnabled	Boolean	false	Indique si les adresses IP utilisées dans les entrées DNAT peuvent être spécifiées dans les entrées SNAT. Valeurs valides : true false
AllocationId	String	eip-m5egzuvp3dgixen6****	ID de l'EIP associée à la passerelle NAT.
PrivateIpAddress	String	192 168.XX.XX	Adresse IP privée de la passerelle NAT.
ForwardTableIds	Array of String	ftb-uf6gj3mhsg94qsqst****	ID de la table DNAT.
SnatTableIds	Array of String	stb-uf6dalcdu0krz423p****	ID de la table SNAT de la passerelle NAT.
FullNatTableIds	Array of String	fulltb-gw88z7hhlv43rmb26****	ID de la table FULLNAT.
NatGatewayPrivateInfo	Object		Informations sur le réseau privé de la passerelle NAT Internet améliorée. Remarque Si NatType est défini sur Normal, tous les paramètres renvoyés dans cette liste sont vides.
VswitchId	String	vsw-bp1s2laxhdf9ayjbo****	ID du vSwitch auquel appartient la passerelle NAT.
EniInstanceId	String	eni-m5eg4ozy5st8q3q4****	ID de l'interface réseau élastique (ENI).
MaxBandwidth	Integer	5120	Bande passante maximale. Unité : Mbit/s.
MaxSessionQuota	Integer	2000000	Nombre de connexions simultanées à la passerelle NAT. Unité : connexions.
MaxSessionEstablishRate	Integer	100000	Nombre de nouvelles connexions à la passerelle NAT. Unité : connexions par seconde.
PrivateIpAddress	String	192 168.XX.XX	Adresses IP privées.
IzNo	String	cn-hangzhou-b	Zone à laquelle appartient la passerelle NAT.
EniType	String	indirect	Mode d'association de l'ENI à la passerelle NAT. indirect : mode non direct Une valeur vide indique l'utilisation du mode direct.
PrivateLinkEnabled	Boolean	true	Indique si la passerelle NAT prend en charge PrivateLink. Valeurs valides : true false
PrivateLinkMode	String	FullNat	Mode utilisé par PrivateLink. Valeurs valides : FullNat : mode FULLNAT Geneve : mode GENEVE
EipBindMode	String	MULTI_BINDED	Mode d'association de la passerelle NAT à une adresse IP élastique (EIP). Valeurs valides : MULTI_BINDED : mode multi-EIP vers ENI NAT : mode NAT, compatible avec les adresses IPv4 Remarque En mode NAT, l'EIP occupe une adresse IP privée sur le vSwitch de la passerelle NAT. Assurez-vous que le vSwitch dispose d'un nombre suffisant d'adresses IP privées. Dans le cas contraire, l'association de la passerelle NAT à l'EIP échouera. En mode NAT, vous pouvez associer jusqu'à 50 EIP à une passerelle NAT.
Tags	Array of Tag		Liste des tags.
Tag
TagKey	String	KeyTest	Clé du tag.
TagValue	String	valueTest	Valeur du tag.

Exemples

Exemples de requêtes

http(s)://[Endpoint]/?Action=DescribeNatGateways
&RegionId=cn-hangzhou
&NatGatewayId=ngw-bp1uewa15k4iy5770****
&VpcId=vpc-bp15zckdt37pq72z****
&Name=test
&InstanceChargeType=PostPaid
Example value for the Spec parameter: Small. You can use this value on the China site (aliyun.com). If you use the international site (alibabacloud.com), ignore this parameter.
&NatType=Enhanced
&ResourceGroupId=rg-bp67acfmxazb4ph****
&PageNumber=10
&PageSize=1
&DryRun=false
&Status=Available
&NetworkType=internet
&Tag=[{"Key":"KeyTest","Value":"valueTest"}]
&ZoneId=cn-hangzhou-b
&Common request parameters

Exemples de réponses réussies

Format XML

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

<DescribeNatGatewaysResponse>
    <PageSize>10</PageSize>
    <RequestId>4EC47282-1B74-4534-BD0E-403F3EE64CAF</RequestId>
    <PageNumber>10</PageNumber>
    <TotalCount>1</TotalCount>
    <NatGateways>
        <Status>Creating</Status>
        <CreationTime>2021-06-08T12:20:20Z</CreationTime>
        <VpcId>vpc-bp15zckdt37pq72z****</VpcId>
        <NatType>Enhanced</NatType>
        <AutoPay>false</AutoPay>
        <Spec>Small</Spec>
        <DeletionProtection>true</DeletionProtection>
        <NetworkType>internet</NetworkType>
        <SecurityProtectionEnabled>false</SecurityProtectionEnabled>
        <InstanceChargeType>PostPaid</InstanceChargeType>
        <RegionId>cn-hangzhou</RegionId>
        <EcsMetricEnabled>true</EcsMetricEnabled>
        <IcmpReplyEnabled>true</IcmpReplyEnabled>
        <Description>NAT</Description>
        <ExpiredTime>2021-08-26T16:00Z</ExpiredTime>
        <ResourceGroupId>rg-bp67acfmxazb4ph****</ResourceGroupId>
        <NatGatewayId>ngw-bp1047e2d4z7kf2ki****</NatGatewayId>
        <InternetChargeType>PayByLcu</InternetChargeType>
        <BusinessStatus>Normal</BusinessStatus>
        <Name>abc</Name>
        <IpLists>
            <UsingStatus>UsedByForwardTable</UsingStatus>
            <IpAddress>116.62.XX.XX</IpAddress>
            <SnatEntryEnabled>false</SnatEntryEnabled>
            <AllocationId>eip-m5egzuvp3dgixen6****</AllocationId>
            <PrivateIpAddress>192.168.XX.XX</PrivateIpAddress>
        </IpLists>
        <ForwardTableIds>ftb-uf6gj3mhsg94qsqst****</ForwardTableIds>
        <SnatTableIds>stb-uf6dalcdu0krz423p****</SnatTableIds>
        <FullNatTableIds>fulltb-gw88z7hhlv43rmb26****</FullNatTableIds>
        <NatGatewayPrivateInfo>
            <VswitchId>vsw-bp1s2laxhdf9ayjbo****</VswitchId>
            <EniInstanceId>eni-m5eg4ozy5st8q3q4****</EniInstanceId>
            <MaxBandwidth>5120</MaxBandwidth>
            <MaxSessionQuota>2000000</MaxSessionQuota>
            <MaxSessionEstablishRate>100000</MaxSessionEstablishRate>
            <PrivateIpAddress>192.168.XX.XX</PrivateIpAddress>
            <IzNo>cn-hangzhou-b</IzNo>
            <EniType>indirect</EniType>
        </NatGatewayPrivateInfo>
        <PrivateLinkEnabled>true</PrivateLinkEnabled>
        <PrivateLinkMode>FullNat</PrivateLinkMode>
        <EipBindMode>MULTI_BINDED</EipBindMode>
        <Tags>
            <TagKey>KeyTest</TagKey>
            <TagValue>valueTest</TagValue>
        </Tags>
    </NatGateways>
</DescribeNatGatewaysResponse>

Format JSON

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

{
  "PageSize" : 10,
  "RequestId" : "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
  "PageNumber" : 10,
  "TotalCount" : 1,
  "NatGateways" : [ {
    "Status" : "Creating",
    "CreationTime" : "2021-06-08T12:20:20Z",
    "VpcId" : "vpc-bp15zckdt37pq72z****",
    "NatType" : "Enhanced",
    "AutoPay" : false,
    "Spec" : "Small",
    "DeletionProtection" : true,
    "NetworkType" : "internet",
    "SecurityProtectionEnabled" : false,
    "InstanceChargeType" : "PostPaid",
    "RegionId" : "cn-hangzhou",
    "EcsMetricEnabled" : true,
    "IcmpReplyEnabled" : true,
    "Description" : "NAT",
    "ExpiredTime" : "2021-08-26T16:00Z",
    "ResourceGroupId" : "rg-bp67acfmxazb4ph****",
    "NatGatewayId" : "ngw-bp1047e2d4z7kf2ki****",
    "InternetChargeType" : "PayByLcu",
    "BusinessStatus" : "Normal",
    "Name" : "abc",
    "IpLists" : [ {
      "UsingStatus" : "UsedByForwardTable",
      "IpAddress" : "116.62.XX.XX",
      "SnatEntryEnabled" : false,
      "AllocationId" : "eip-m5egzuvp3dgixen6****",
      "PrivateIpAddress" : "192.168.XX.XX"
    } ],
    "ForwardTableIds" : [ "ftb-uf6gj3mhsg94qsqst****" ],
    "SnatTableIds" : [ "stb-uf6dalcdu0krz423p****" ],
    "FullNatTableIds" : [ "fulltb-gw88z7hhlv43rmb26****" ],
    "NatGatewayPrivateInfo" : {
      "VswitchId" : "vsw-bp1s2laxhdf9ayjbo****",
      "EniInstanceId" : "eni-m5eg4ozy5st8q3q4****",
      "MaxBandwidth" : 5120,
      "MaxSessionQuota" : 2000000,
      "MaxSessionEstablishRate" : 100000,
      "PrivateIpAddress" : "192.168.XX.XX",
      "IzNo" : "cn-hangzhou-b",
      "EniType" : "indirect"
    },
    "PrivateLinkEnabled" : true,
    "PrivateLinkMode" : "FullNat",
    "EipBindMode" : "MULTI_BINDED",
    "Tags" : [ {
      "TagKey" : "KeyTest",
      "TagValue" : "valueTest"
    } ]
  } ]
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.	Message d'erreur renvoyé car l'ID de région spécifié n'existe pas.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	Message d'erreur renvoyé en raison d'une erreur interne.

Pour obtenir la liste des codes d'erreur, consultez le Centre d'erreurs API.