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

Invoca DescribeNatGateways para consultar os NAT gateways criados.

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

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

ens:DescribeNatGateways

list

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
EnsRegionId	string	Não	O ID do nó do Edge Node Service (ENS).	cn-wuxi-9
NatGatewayId	string	Não	O ID do NAT gateway.	nat-5t7nh1cfm6kxiszlttr38****
NetworkId	string	Não	O ID da rede.	n-2zeuphj08tt7q3brd****
VSwitchId	string	Não	O ID do vSwitch.	vsw-5rllcjb3ol6duzjdnbm1o****
Name	string	Não	O nome do NAT gateway.	test0
NatGatewayIds	array	Não	Os IDs dos NAT gateways. Você pode especificar de 1 a 100 IDs.
	string	Não	O ID do NAT gateway.	nat-5****4ik
EnsRegionIds	array	Não	Os IDs dos nós de borda. Você pode especificar de 1 a 100 IDs.
	string	Não	O ID do nó de borda.	cn-chengdu-telecom-4
PageNumber	integer	Não	O número da página. As páginas começam a partir da página 1. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página. O valor máximo é 100. Valor padrão: 10.	10

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O esquema da resposta.
RequestId	string	O ID da solicitação.	2818A8F4-5E2B-5611-8732-5ACF7B677059
PageNumber	integer	O número da página.	1
TotalCount	integer	O número de NAT gateways retornados.	49
PageSize	integer	O número de entradas por página.	10
NatGateways	array<object>	Os detalhes dos NAT gateways.
	array<object>	Os detalhes do NAT gateway.
EnsRegionId	string	O ID do nó ENS.	cn-xiangyang-5
NatGatewayId	string	O ID do NAT gateway.	nat-5t7nh1cfm6kxiszlttr38****
NetworkId	string	O ID da rede.	n-5s2ml1olj0kzaws9n1yrj****
VSwitchId	string	O ID do vSwitch.	vsw-5szpp1os9m55myirbflfw****
Name	string	O nome do NAT gateway.	test0
CreationTime	string	A hora em que o NAT gateway foi criado. A hora segue o padrão ISO 8601 no formato YYYY-MM-DDThh:mm:ssZ. A hora é exibida em UTC.	2021-11-22T07:03:32Z
Spec	string	O tipo do NAT gateway.	enat.default
Status	string	O status do NAT gateway. Valores válidos: Creating: Após você enviar uma solicitação para criar um NAT gateway, o sistema cria o NAT gateway em segundo plano. O NAT gateway permanece no estado Creating até que a operação seja concluída. Available: O NAT gateway fica no estado Available após a conclusão da criação. Deleting: Após você enviar uma solicitação para excluir um NAT gateway, o sistema exclui o NAT gateway em segundo plano. O NAT gateway permanece no estado Deleting até que a operação seja concluída.	Available
IpLists	array<object>	Os EIPs associados ao NAT gateway.
	object	O EIP associado ao NAT gateway.
UsingStatus	string	The association between the EIP and the Internet NAT gateway. Valid values: UsedByForwardTable: The EIP is specified in a DNAT entry. UsedBySnatTable: The EIP is specified in an SNAT entry. Idle: The EIP is not specified in an SNAT entry or a DNAT entry.	Idle
IpAddress	string	The EIP.	8.XX.XX.162
AllocationId	string	The ID of the EIP.	eip-50g****
Tags	array<object>	A coleção de tags.
	object	A coleção de tags.
Value	string	Tag value.	TestValue
Key	string	Tag key.	TestKey
TagKey `deprecated`	string	Tag key.	TestKey
TagValue `deprecated`	string	Tag value.	TestValue

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "2818A8F4-5E2B-5611-8732-5ACF7B677059",
  "PageNumber": 1,
  "TotalCount": 49,
  "PageSize": 10,
  "NatGateways": [
    {
      "EnsRegionId": "cn-xiangyang-5",
      "NatGatewayId": "nat-5t7nh1cfm6kxiszlttr38****",
      "NetworkId": "n-5s2ml1olj0kzaws9n1yrj****",
      "VSwitchId": "vsw-5szpp1os9m55myirbflfw****",
      "Name": "test0",
      "CreationTime": "2021-11-22T07:03:32Z",
      "Spec": "enat.default",
      "Status": "Available",
      "IpLists": [
        {
          "UsingStatus": "Idle",
          "IpAddress": "8.XX.XX.162",
          "AllocationId": "eip-50g****"
        }
      ],
      "Tags": [
        {
          "Value": "TestValue",
          "Key": "TestKey",
          "TagKey": "TestKey",
          "TagValue": "TestValue"
        }
      ]
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
400	Invalid%s	The specified parameter %s is invalid.
400	Missing%s	You must specify the parameter %s.
400	ens.interface.error	Failed to call API.
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.