DescribeNatGateways - NAT Gateway: Central de Documentação do Alibaba Cloud

Consulta os detalhes de gateways NAT que atendem a condições especificadas em uma região especificada.

Descrição da operação

Esta operação consulta os detalhes de gateways NAT da Internet e gateways NAT da VPC. O termo gateway NAT neste documento refere-se a ambos os tipos, salvo especificação em contrário.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região do gateway NAT. Você pode chamar a operação DescribeRegions para consultar os IDs das regiões.	cn-hangzhou
NatGatewayId	string	Não	O ID do gateway NAT.	ngw-bp1uewa15k4iy5770****
VpcId	string	Não	O ID da nuvem privada virtual (VPC) à qual o gateway NAT pertence.	vpc-bp15zckdt37pq72z****
Name	string	Não	O nome do gateway NAT. O nome deve ter de 1 a 128 caracteres e não pode começar com `http://` ou `https://`.	test
InstanceChargeType	string	Não	PrePaid: assinatura. Este método de cobrança não está mais disponível para novas compras. O método de cobrança do gateway NAT. Valor válido: PostPaid (pós-pago).	PostPaid
Spec	string	Não	A especificação do gateway NAT. Deixe este parâmetro vazio.	Example value for the China site: Small. Example value for the international site: leave empty
NatType	string	Não	O tipo do gateway NAT. Valor válido: Enhanced (gateway NAT aprimorado).	Enhanced
ResourceGroupId	string	Não	O ID do grupo de recursos ao qual o gateway NAT pertence.	rg-bp67acfmxazb4ph****
PageNumber	integer	Não	O número da página. Valor padrão: 1.	10
PageSize	integer	Não	O número de entradas por página para paginação em uma consulta paginada. Valor máximo: 50. Valor padrão: 10.	1
DryRun	boolean	Não	Especifica se deve ser realizado apenas um dry run para esta solicitação. Valores válidos: true: realiza um dry run na solicitação sem consultar o status do recurso. O sistema verifica se o seu par de AccessKey é válido, a autorização do usuário do Resource Access Management (RAM) e se os parâmetros obrigatórios foram especificados. Se a solicitação falhar no dry run, uma mensagem de erro será retornada. Se a solicitação passar no dry run, o código de erro `DryRunOperation` será retornado. false (padrão): envia uma solicitação normal. Se a solicitação passar no dry run, um código de status HTTP 2xx será retornado e o status do recurso será consultado.	false
Status	string	Não	O status do gateway NAT. Valores válidos: Creating: a criação de um gateway NAT é uma operação assíncrona. O gateway NAT permanece no estado Creating até que a criação seja concluída. Available: o gateway NAT foi criado e está em execução. Este é um estado estável. Modifying: o upgrade ou downgrade de um gateway NAT é uma operação assíncrona. O gateway NAT permanece no estado Modifying até que a modificação seja concluída. Deleting: a exclusão de um gateway NAT é uma operação assíncrona. O gateway NAT permanece no estado Deleting até que a exclusão seja concluída. Converting: o upgrade de um gateway NAT padrão para um gateway NAT aprimorado é uma operação assíncrona. O gateway NAT permanece no estado Converting até que o upgrade seja concluído.	Available
NetworkType	string	Não	O tipo do gateway NAT. Valores válidos: internet: gateway NAT da Internet. intranet: gateway NAT da VPC.	internet
Tag	array<object>	Não	A lista de tags.
	object	Não	A lista de tags.
Key	string	Não	A chave da tag do gateway NAT. Você pode especificar até 20 chaves de tag. A chave da tag pode ter até 128 caracteres e não pode começar com `aliyun` ou `acs:`. Não pode conter `http://` ou `https://`.	KeyTest
Value	string	Não	O valor da tag do gateway NAT. Você pode especificar até 20 valores de tag. O valor da tag pode ter até 128 caracteres e não pode começar com `aliyun` ou `acs:`. Não pode conter `http://` ou `https://`.	valueTest
ZoneId	string	Não	O ID da zona do gateway NAT.	cn-hangzhou-b
AvailabilityMode	string	Não	O tipo de recuperação de desastres do gateway NAT. Valores válidos: CrossAZ: recuperação de desastres entre zonas. SingleAZ: recuperação de desastres de zona única.	CrossAZ

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O número de entradas por página.
PageSize	integer	O número de entradas por página.	10
RequestId	string	O ID da solicitação.	4EC47282-1B74-4534-BD0E-403F3EE64CAF
PageNumber	integer	O número da página atual.	10
TotalCount	integer	O número total de NAT gateways consultados.	1
NatGateways	object
NatGateway	array<object>	Os detalhes dos NAT gateways.
	array<object>	Os detalhes dos NAT gateways.
Status	string	O status do NAT gateway. Valores válidos: Creating: O NAT gateway está sendo criado. A criação de um NAT gateway é uma operação assíncrona, e o status é Creating antes que a criação seja concluída. Available: O NAT gateway foi criado e está em um estado estável. Modifying: O NAT gateway está sendo modificado. A modificação de um NAT gateway é uma operação assíncrona, e o status é Modifying durante a modificação. Deleting: O NAT gateway está sendo excluído. A exclusão de um NAT gateway é uma operação assíncrona, e o status é Deleting durante a exclusão. Converting: Um NAT gateway padrão está sendo atualizado para um NAT gateway aprimorado. Esta é uma operação assíncrona, e o status é Converting durante a atualização.	Creating
CreationTime	string	A hora em que o NAT gateway foi criado. A hora é exibida em UTC e segue o padrão ISO 8601 no formato YYYY-MM-DDThh:mm:ssZ.	2021-06-08T12:20:20Z
VpcId	string	O ID da VPC à qual o NAT gateway pertence.	vpc-bp15zckdt37pq72z****
NatType	string	O tipo do gateway NAT. Valor válido: Enhanced (gateway NAT aprimorado).	Enhanced
AutoPay	boolean	Especifica se o pagamento automático está ativado para pedidos. Valores válidos: false: Não. true: Sim.	false
Spec	string	A especificação do NAT gateway. Este parâmetro retorna um valor vazio. Quando InternetChargeType está definido como PayByLcu, um valor vazio é retornado.	Small
DeletionProtection	boolean	Especifica se a proteção contra exclusão está ativada. Valores válidos: true: Sim. false: Não.	true
NetworkType	string	O tipo do NAT gateway. Valores válidos: internet: NAT gateway de Internet. intranet: NAT gateway de VPC.	internet
SecurityProtectionEnabled	boolean	Especifica se o recurso de firewall está ativado. Valores válidos: false: Não. true: Sim.	false
InstanceChargeType	string	O método de cobrança do NAT gateway. Valor válido: PostPaid (pós-pago).	PostPaid
RegionId	string	O ID da região do NAT gateway.	cn-hangzhou
EcsMetricEnabled	boolean	Especifica se o monitoramento de tráfego do gateway está ativado. Valores válidos: true: Sim. false: Não.	true
IcmpReplyEnabled	boolean	Especifica se a resposta de eco ICMP está ativada. Valores válidos: true: Sim. Este é o valor padrão. false: Não.	true
Description	string	A descrição do NAT gateway.	NAT
ExpiredTime	string	A hora de expiração do NAT gateway. A hora é exibida em UTC e segue o padrão ISO 8601 no formato YYYY-MM-DDThh:mmZ.	2021-08-26T16:00Z
ResourceGroupId	string	O ID do grupo de recursos.	rg-bp67acfmxazb4ph****
NatGatewayId	string	O ID do gateway NAT.	ngw-bp1047e2d4z7kf2ki****
InternetChargeType	string	O método de cobrança do NAT gateway. Valores válidos: PayBySpec: cobrado por especificações definidas. PayByLcu: cobrado por uso.	PayByLcu
BusinessStatus	string	O status do serviço do NAT gateway. Valores válidos: Normal: Normal. FinancialLocked: Bloqueado devido a pagamento em atraso.	Normal
Name	string	O nome do NAT gateway.	abc
IpLists	object
IpList	array<object>	A lista de EIPs associados ao NAT gateway de Internet.
	object	A lista de endereços IP do NAT gateway.
UsingStatus	string	O status de associação do EIP associado ao NAT gateway de Internet. Valores válidos: UsedByForwardTable: O EIP é usado em uma regra DNAT. UsedBySnatTable: O EIP é usado em uma regra SNAT. UsedByForwardSnatTable: O EIP é usado em regras DNAT e SNAT. Idle: O EIP está ocioso e não é usado em nenhuma regra DNAT ou SNAT.	UsedByForwardTable
IpAddress	string	O endereço IP do EIP associado ao NAT gateway.	116.62.XX.XX
SnatEntryEnabled	boolean	Especifica se um endereço IP que já é usado em uma entrada DNAT também pode ser usado em uma entrada SNAT. Valores válidos: true: Sim. false: Não.	false
AllocationId	string	O ID da instância do EIP associado ao NAT gateway.	eip-m5egzuvp3dgixen6****
PrivateIpAddress	string	O endereço IP privado do NAT gateway.	192.168.XX.XX
ForwardTableIds	object
ForwardTableId	array	O ID da tabela DNAT do NAT gateway.
	string	O ID da tabela DNAT.	ftb-uf6gj3mhsg94qsqst****
SnatTableIds	object
SnatTableId	array	O ID da tabela SNAT do NAT gateway.
	string	O ID da tabela SNAT.	stb-uf6dalcdu0krz423p****
FullNatTableIds	object
FullNatTableId	array	O ID da tabela FULLNAT.
	string	O ID da tabela FULLNAT.	fulltb-gw88z7hhlv43rmb26****
NatGatewayPrivateInfo	object	As informações de rede privada do NAT gateway de Internet aprimorado. Nota Se NatType estiver definido como Normal, todos os parâmetros nesta lista retornarão valores vazios.
VswitchId	string	O ID do vSwitch ao qual o NAT gateway pertence.	vsw-bp1s2laxhdf9ayjbo****
EniInstanceId	string	O ID da instância do controlador de interface de rede elástica (NIC).	eni-m5eg4ozy5st8q3q4****
MaxBandwidth	integer	A largura de banda máxima. Unidade: Mbit/s.	5120
MaxSessionQuota	integer	O número máximo de conexões simultâneas suportadas pelo NAT gateway.	2000000
MaxSessionEstablishRate	integer	O número máximo de novas conexões por segundo suportadas pelo NAT gateway.	100000
PrivateIpAddress	string	O endereço IP privado.	192.168.XX.XX
IzNo	string	A zona à qual o NAT gateway pertence.	cn-hangzhou-b
EniType	string	O modo de anexação entre o controlador de interface de rede elástica (NIC) e o NAT gateway. Valores válidos: indirect: modo não direto. Valor vazio: modo direto.	indirect
PrivateLinkEnabled	boolean	Especifica se o PrivateLink é suportado. Valores válidos: true: Sim. false: Não.	true
PrivateLinkMode	string	O modo de tradução de serviço do PrivateLink. Valores válidos: FullNat: modo FULLNAT. Geneve: modo Geneve.	FullNat
EipBindMode	string	O modo de anexação de EIP do NAT gateway. Valores válidos: MULTI_BINDED: modo visível de controlador de interface de rede (NIC) com múltiplos EIPs. NAT: modo EIP padrão, compatível com gateways IPv4. Nota Quando o modo de anexação de EIP do NAT gateway é o modo EIP padrão, o EIP ocupa um IP privado do vSwitch ao qual o NAT gateway pertence. Certifique-se de que haja endereços IP privados suficientes no vSwitch. Se não houver endereços IP privados ociosos ativos no vSwitch, você não poderá anexar novos EIPs. Quando o modo de anexação de EIP é o modo EIP padrão, o número máximo de EIPs que podem ser anexados ao NAT gateway é 50.	MULTI_BINDED
Tags	object
Tag	array<object>	A lista de tags.
	object	A lista de tags.
TagKey	string	A chave da tag da instância.	KeyTest
TagValue	string	O valor da tag da instância.	valueTest
EnableSessionLog	string	Especifica se o registro de sessão está ativado. Valores válidos: true: Sim. false: Não.	true
AccessMode	object	O modo de acesso para acesso reverso ao NAT gateway de VPC.
ModeValue	string	O modo de acesso. Valores válidos: route: modo de rota. tunnel: modo de túnel.	route
TunnelType	string	O tipo de modo de túnel. Valores válidos: geneve: Geneve.	geneve
AvailabilityMode	string	O tipo de recuperação de desastres do gateway NAT. Valores válidos: CrossAZ: recuperação de desastres entre zonas. SingleAZ: recuperação de desastres de zona única.	CrossAZ
IpPrefixList	object
IpPrefixList	array<object>	A lista de blocos CIDR de prefixo de IP NAT.
	object
IpPrefix	string	O bloco CIDR de prefixo de IP NAT.	192.168.0.0/28

Exemplos

Resposta de sucesso

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": "CrossAZ",
        "IpPrefixList": {
          "IpPrefixList": [
            {
              "IpPrefix": "192.168.0.0/28"
            }
          ]
        }
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	O processamento da solicitação falhou devido a um erro desconhecido.
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.