DescribeNatGateways - NAT Gateway - Centro de documentación de Alibaba Cloud

Llama a DescribeNatGateways para consultar la información detallada de los NAT gateways que cumplen con las condiciones especificadas en una región determinada, en formato de lista.

Descripción de la operación

Esta operación admite la consulta de información detallada sobre NAT gateways de Internet o NAT gateways de VPC. El término "NAT gateway" utilizado en este documento no distingue entre los dos tipos.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

vpc:DescribeNatGateways

get

NatGateway.

acs:vpc:{#regionId}:{#accountId}:natgateway/*

NatGateway.

acs:vpc:{#regionId}:{#accountId}:natgateway/{#NatGatewayId}

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionId	string	Sí	El ID de la región del NAT gateway que se va a consultar. Puede llamar a la operación DescribeRegions para obtener el ID de la región.	cn-hangzhou
NatGatewayId	string	No	El ID del NAT gateway que se va a consultar.	ngw-bp1uewa15k4iy5770****
VpcId	string	No	El ID de la VPC a la que pertenece el NAT gateway que se va a consultar.	vpc-bp15zckdt37pq72z****
Name	string	No	El nombre del NAT gateway que se va a consultar. El nombre debe tener entre 1 y 128 caracteres de longitud y no puede comenzar con `http://` o `https://`.	test
InstanceChargeType	string	No	PrePaid: el método de facturación por suscripción heredado. El método de facturación por suscripción ya no está disponible para nuevas compras. El método de facturación de la instancia de NAT gateway que se va a consultar. Valor válido: PostPaid (pago por uso).	PostPaid
Spec	string	No	La especificación del NAT gateway. Deje este parámetro vacío.	Valor de ejemplo del sitio de China: Small, valor de ejemplo del sitio internacional: no requerido
NatType	string	No	El tipo de NAT gateway. Valor válido: Enhanced (NAT gateway mejorado).	Enhanced
ResourceGroupId	string	No	El ID del grupo de recursos al que pertenece el NAT gateway que se va a consultar.	rg-bp67acfmxazb4ph****
PageNumber	integer	No	El número de página. Valor predeterminado: 1.	10
PageSize	integer	No	El número de entradas por página para consultas paginadas. Valor máximo: 50. Valor predeterminado: 10.	1
DryRun	boolean	No	Especifica si se debe realizar una ejecución de prueba (dry run). Valores válidos: true: realiza una ejecución de prueba sin consultar el estado del recurso. Los elementos de verificación incluyen si el par de AccessKey es válido, si el usuario de RAM tiene autorización y si se han especificado los parámetros requeridos. Si la verificación falla, se devuelve el error correspondiente. Si la verificación se realiza correctamente, se devuelve el código de error `DryRunOperation`. false (predeterminado): realiza una solicitud normal. Después de que la verificación se realiza correctamente, se devuelve un código de estado HTTP 2xx y se consulta directamente el estado del recurso.	false
Status	string	No	El estado del NAT gateway que se va a consultar. Valores válidos: Creating: La creación de un NAT gateway es una operación asíncrona. El estado es Creating antes de que finalice la creación. Available: El estado posterior a la creación del NAT gateway. Este es un estado estable. Modifying: La modificación de un NAT gateway es una operación asíncrona. El estado es Modifying durante el proceso de modificación. Deleting: La eliminación de un NAT gateway es una operación asíncrona. El estado es Deleting durante el proceso de eliminación. Converting: La conversión de un NAT gateway estándar a un NAT gateway mejorado es una operación asíncrona. El estado es Converting durante el proceso de conversión.	Available
NetworkType	string	No	El tipo de NAT gateway que se va a consultar. Valores válidos: internet: NAT gateway de Internet. intranet: NAT gateway de VPC.	internet
Tag	array<object>	No	La lista de etiquetas.
	object	No	La lista de etiquetas.
Key	string	No	La clave de etiqueta de la instancia de NAT gateway. Puede especificar hasta 20 claves de etiqueta. La clave de etiqueta puede tener hasta 128 caracteres de longitud. No puede comenzar con `aliyun` o `acs:`, y no puede contener `http://` o `https://`.	KeyTest
Value	string	No	El valor de etiqueta de la instancia de NAT gateway. Puede especificar hasta 20 valores de etiqueta. El valor de etiqueta puede tener hasta 128 caracteres de longitud. No puede comenzar con `aliyun` o `acs:`, y no puede contener `http://` o `https://`.	valueTest
ZoneId	string	No	El ID de la zona donde se despliega el NAT gateway.	cn-hangzhou-b
AvailabilityMode	string	No

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	El número de entradas por página.
PageSize	integer	El número de entradas por página.	10
RequestId	string	El ID de la solicitud.	4EC47282-1B74-4534-BD0E-403F3EE64CAF
PageNumber	integer	El número de página actual.	10
TotalCount	integer	El número total de entradas en la lista de puertas de enlace NAT.	1
NatGateways	object
NatGateway	array<object>	La información detallada de la puerta de enlace NAT.
	array<object>	La información detallada de la puerta de enlace NAT.
Status	string	El estado de la puerta de enlace NAT. Valores válidos: Creating: La creación de una puerta de enlace NAT es una operación asíncrona. El estado es Creating antes de que se complete la creación. Available: El estado posterior a la creación de la puerta de enlace NAT. Este es un estado estable. Modifying: La modificación de una puerta de enlace NAT es una operación asíncrona. El estado es Modifying durante el proceso de modificación. Deleting: La eliminación de una puerta de enlace NAT es una operación asíncrona. El estado es Deleting durante el proceso de eliminación. Converting: La conversión de una puerta de enlace NAT estándar a una puerta de enlace NAT mejorada es una operación asíncrona. El estado es Converting durante el proceso de conversión.	Creating
CreationTime	string	La hora de creación de la puerta de enlace NAT.	2021-06-08T12:20:20Z
VpcId	string	El ID de la VPC a la que pertenece la puerta de enlace NAT.	vpc-bp15zckdt37pq72z****
NatType	string	El tipo de NAT gateway. Valor válido: Enhanced (NAT gateway mejorado).	Enhanced
AutoPay	boolean	Especifica si se debe pagar automáticamente la orden. Valores válidos: false: no paga automáticamente la orden. true: paga automáticamente la orden.	false
Spec	string	La especificación de la puerta de enlace NAT. El valor de retorno de este parámetro está vacío. Cuando InternetChargeType es PayByLcu, el valor de retorno está vacío.	Small
DeletionProtection	boolean	Indica si la protección contra eliminación está habilitada. Valores válidos: true: habilitada. false: deshabilitada.	true
NetworkType	string	El tipo de la puerta de enlace NAT. Valores válidos: internet: puerta de enlace NAT de Internet. intranet: puerta de enlace NAT de VPC.	internet
SecurityProtectionEnabled	boolean	Indica si la función de firewall está habilitada. Valores válidos: false: deshabilitada. true: habilitada.	false
InstanceChargeType	string	El método de facturación de la instancia de puerta de enlace NAT. Valor válido: PostPaid (pago por uso).	PostPaid
RegionId	string	El ID de región de la puerta de enlace NAT.	cn-hangzhou
EcsMetricEnabled	boolean	Indica si la función de monitoreo de tráfico de la puerta de enlace está habilitada. Valores válidos: true: habilitada. false: deshabilitada.	true
IcmpReplyEnabled	boolean	Indica si la respuesta de proxy ICMP está habilitada. Valores válidos: true (predeterminado): habilitada. false: deshabilitada.	true
Description	string	La descripción de la puerta de enlace NAT.	NAT
ExpiredTime	string	La hora de vencimiento de la puerta de enlace NAT.	2021-08-26T16:00Z
ResourceGroupId	string	El ID del grupo de recursos.	rg-bp67acfmxazb4ph****
NatGatewayId	string	El ID de la puerta de enlace NAT.	ngw-bp1047e2d4z7kf2ki****
InternetChargeType	string	El método de medición de la puerta de enlace NAT. Valores válidos: PayBySpec: pago por especificación fija. PayByLcu: pago por unidad de capacidad (CU).	PayByLcu
BusinessStatus	string	El estado comercial de la puerta de enlace NAT. Valores válidos: Normal: normal. FinancialLocked: bloqueada por pago pendiente.	Normal
Name	string	El nombre de la instancia de puerta de enlace NAT.	abc
IpLists	object
IpList	array<object>	La lista de EIP asociadas con la puerta de enlace NAT de Internet.
	object	La lista de información de IP de la puerta de enlace NAT.
UsingStatus	string	La asociación de la EIP vinculada a la instancia de puerta de enlace NAT de Internet. Valores válidos: UsedByForwardTable: la EIP se utiliza para configurar reglas DNAT. UsedBySnatTable: la EIP se utiliza para configurar reglas SNAT. UsedByForwardSnatTable: la EIP se utiliza para configurar reglas DNAT y SNAT. Idle: inactiva. No hay reglas DNAT ni SNAT configuradas.	UsedByForwardTable
IpAddress	string	La dirección IP de la EIP vinculada a la puerta de enlace NAT.	116.62.XX.XX
SnatEntryEnabled	boolean	Indica si la dirección IP que ya se utiliza para entradas DNAT también puede utilizarse para entradas SNAT. Valores válidos: true: puede utilizarse para entradas SNAT. false: no puede utilizarse para entradas SNAT.	false
AllocationId	string	El ID de instancia de la EIP vinculada a la puerta de enlace NAT.	eip-m5egzuvp3dgixen6****
PrivateIpAddress	string	La dirección IP privada de la puerta de enlace NAT.	192.168.XX.XX
ForwardTableIds	object
ForwardTableId	array	El ID de la tabla DNAT de la puerta de enlace NAT.
	string	El ID de la tabla DNAT.	ftb-uf6gj3mhsg94qsqst****
SnatTableIds	object
SnatTableId	array	El ID de la tabla SNAT de la puerta de enlace NAT.
	string	El ID de la tabla SNAT.	stb-uf6dalcdu0krz423p****
FullNatTableIds	object
FullNatTableId	array	El ID de la tabla FULLNAT.
	string	El ID de la tabla FULLNAT.	fulltb-gw88z7hhlv43rmb26****
NatGatewayPrivateInfo	object	La información de red privada de la puerta de enlace NAT de Internet mejorada. Nota Cuando NatType se establece en Normal, todos los parámetros de esta lista devuelven valores vacíos.
VswitchId	string	El ID del vSwitch al que pertenece la puerta de enlace NAT.	vsw-bp1s2laxhdf9ayjbo****
EniInstanceId	string	El ID de instancia de la interfaz de red elástica (ENI).	eni-m5eg4ozy5st8q3q4****
MaxBandwidth	integer	El ancho de banda máximo. Unidad: Mbps.	5120
MaxSessionQuota	integer	El número de conexiones simultáneas de la puerta de enlace NAT.	2000000
MaxSessionEstablishRate	integer	La tasa de nuevas conexiones de la puerta de enlace NAT. Unidad: conexiones por segundo.	100000
PrivateIpAddress	string	La dirección IP privada.	192.168.XX.XX
IzNo	string	La zona a la que pertenece la puerta de enlace NAT.	cn-hangzhou-b
EniType	string	El modo de vinculación entre la ENI y la puerta de enlace NAT. Valores válidos: indirect: modo sin paso directo. Valor de retorno vacío: modo de paso directo.	indirect
PrivateLinkEnabled	boolean	Indica si el vínculo privado es compatible. Valores válidos: true: el vínculo privado es compatible. false: el vínculo privado no es compatible.	true
PrivateLinkMode	string	El modo de conversión del servicio de vínculo privado. Valores válidos: FullNat: utiliza el modo FULLNAT. Geneve: utiliza el modo Geneve.	FullNat
EipBindMode	string	El modo de vinculación de EIP de la puerta de enlace NAT. Valores válidos: MULTI_BINDED: modo multi-EIP visible para NIC. NAT: modo normal de EIP, compatible con puerta de enlace IPv4. Nota Cuando el modo de vinculación de EIP de la puerta de enlace NAT es el modo normal de EIP, la EIP ocupa una dirección IP privada del vSwitch donde se encuentra la puerta de enlace NAT. Asegúrese de que haya suficientes direcciones IP privadas disponibles en el vSwitch. Si no hay direcciones IP privadas libres disponibles en el vSwitch, no se pueden vincular nuevas EIP. Cuando el modo de vinculación de EIP es el modo normal de EIP, el número máximo de EIP que se pueden vincular a la puerta de enlace NAT es 50.	MULTI_BINDED
Tags	object
Tag	array<object>	La lista de etiquetas.
	object	La lista de etiquetas.
TagKey	string	La clave de etiqueta de la instancia.	KeyTest
TagValue	string	El valor de etiqueta de la instancia.	valueTest
EnableSessionLog	string	Indica si el registro de sesiones está habilitado. Valores válidos: true: el registro de sesiones está habilitado. false: el registro de sesiones está deshabilitado.	true
AccessMode	object	El modo de acceso para el acceso inverso a la puerta de enlace NAT de VPC.
ModeValue	string	El modo de acceso. Valores válidos: route: modo de ruta. tunnel: modo de túnel.	route
TunnelType	string	El tipo de modo de túnel: geneve: tipo Geneve.	geneve
AvailabilityMode	string
IpPrefixList	object
IpPrefixList	array<object>	La lista de rangos de direcciones de prefijo IP NAT.
	object
IpPrefix	string	El bloque CIDR de prefijo de IP NAT.	192.168.0.0/28

Ejemplos

Respuesta exitosa

JSON Formato

{
  "PageSize": 10,
  "RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
  "PageNumber": 10,
  "TotalCount": 1,
  "NatGateways": {
    "NatGateway": [
      {
        "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": {
          "IpList": [
            {
              "UsingStatus": "UsedByForwardTable",
              "IpAddress": "116.62.XX.XX",
              "SnatEntryEnabled": false,
              "AllocationId": "eip-m5egzuvp3dgixen6****",
              "PrivateIpAddress": "192.168.XX.XX"
            }
          ]
        },
        "ForwardTableIds": {
          "ForwardTableId": [
            "ftb-uf6gj3mhsg94qsqst****"
          ]
        },
        "SnatTableIds": {
          "SnatTableId": [
            "stb-uf6dalcdu0krz423p****"
          ]
        },
        "FullNatTableIds": {
          "FullNatTableId": [
            "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": {
          "Tag": [
            {
              "TagKey": "KeyTest",
              "TagValue": "valueTest"
            }
          ]
        },
        "EnableSessionLog": "true",
        "AccessMode": {
          "ModeValue": "route",
          "TunnelType": "geneve"
        },
        "AvailabilityMode": "",
        "IpPrefixList": {
          "IpPrefixList": [
            {
              "IpPrefix": "192.168.0.0/28"
            }
          ]
        }
      }
    ]
  }
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	El procesamiento de la solicitud falló debido a un error desconocido.
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.