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

Consulta os detalhes de uma instância de NAT gateway.

Descrição da operação

Consulta um NAT gateway público ou um NAT gateway de VPC. Neste tópico, NAT Gateway refere-se a qualquer um dos tipos.

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

vpc:GetNatGatewayAttribute

get

*NatGateway

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região do NAT gateway. Chame a operação DescribeRegions para obter o ID da região.	cn-qingdao
NatGatewayId	string	Sim	O ID do NAT gateway.	ngw-bp1b0lic8uz4r6vf2****
RegionId	string	Sim	O ID da região do NAT gateway. Chame a operação DescribeRegions para obter o ID da região.	cn-qingdao

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
VpcId	string	O ID da VPC à qual a instância de NAT gateway pertence.	vpc-bp15zckdt37pq72z****
CreationTime	string	A hora de criação da instância de NAT gateway. A hora está no formato `YYYY-MM-DDThh:mm:ssZ`.	2021-12-08T12:20:20Z
Status	string	O status da instância de NAT gateway. Valores válidos: Creating: Sendo criado. Esta é uma operação assíncrona. Available: Disponível. Este é o estado estável do NAT gateway após a criação. Modifying: Sendo modificado. Esta é uma operação assíncrona. Deleting: Sendo excluído. Esta é uma operação assíncrona. Converting: Sendo convertido para um NAT gateway aprimorado. Esta é uma operação assíncrona.	Available
NatType	string	O tipo do NAT gateway público. O valor Enhanced indica um NAT gateway aprimorado.	Enhanced
NetworkType	string	O tipo do NAT gateway. Valores válidos: internet: Um NAT gateway público. intranet: Um NAT gateway de VPC.	internet
RegionId	string	O ID da região da instância de NAT gateway.	cn-qingdao
EcsMetricEnabled	boolean	Indica se o recurso de monitoramento de tráfego do gateway está ativado. Valores válidos: true: Ativado. false: Desativado.	true
RequestId	string	O ID da solicitação.	4EC47282-1B74-4534-BD0E-403F3EE64CAF
Description	string	A descrição da instância de NAT gateway.	NAT
ExpiredTime	string	A hora de expiração da instância de NAT gateway.	2021-12-26T12:20:20Z
ResourceGroupId	string	O ID do grupo de recursos.	rg-bp67acfmxazb4ph****
NatGatewayId	string	O ID da instância de NAT gateway.	ngw-bp1047e2d4z7kf2ki****
BusinessStatus	string	O status comercial da instância de NAT gateway. Valores válidos: Normal: A instância está em execução normalmente. FinancialLocked: A instância está suspensa devido a um pagamento em atraso.	Normal
Name	string	O nome da instância de NAT gateway.	abc
ForwardTable	object	Informações sobre a tabela DNAT.
ForwardTableId	string	O ID da tabela DNAT.	ftb-uf6gj3mhsg94qsqst****
ForwardEntryCount	integer	O número de entradas DNAT.	1
SnatTable	object	Informações sobre a tabela SNAT.
SnatEntryCount	integer	O número de entradas SNAT.	1
SnatTableId	string	O ID da tabela SNAT.	stb-SnatTableIds****
FullNatTable	object	Informações sobre a tabela FULLNAT.
FullNatEntryCount	integer	O número de entradas FULLNAT.	1
FullNatTableId	string	O ID da tabela FULLNAT.	fulltb-gw88z7hhlv43rmb26****
BillingConfig	object	A configuração de cobrança.
InternetChargeType	string	O método de cobrança da instância de NAT gateway. Valores válidos: PayBySpec: cobrado por especificação. PayByLcu: cobrado por uso.	PayBySpec
AutoPay	string	Indica se o pagamento automático está ativado. Este parâmetro é retornado apenas se InstanceChargeType estiver definido como PrePaid. Valores válidos: false: O pagamento automático está desativado. Após a geração de um pedido, o pagamento deve ser concluído no console de Pedidos. true: O pagamento automático está ativado. Os pagamentos são concluídos automaticamente. Se InstanceChargeType estiver definido como PostPaid, uma string vazia será retornada.	false
Spec	string	A especificação da instância de NAT gateway público. Este parâmetro é retornado apenas se InternetChargeType estiver definido como PayBySpec. Valores válidos: Small Middle Large	Small
InstanceChargeType	string	O método de cobrança da instância de NAT gateway. O valor é PostPaid (pós-pago).	PostPaid
PrivateInfo	object	As informações de rede privada sobre a instância de NAT gateway.
MaxBandwidth	integer	A largura de banda máxima, em Mbps.	5120
VswitchId	string	O ID do vSwitch ao qual a instância de NAT gateway pertence.	vsw-bp1s2laxhdf9ayjbo***
PrivateIpAddress	string	O endereço IP privado.	192.168.XX.XX
IzNo	string	O ID da zona de disponibilidade à qual a instância de NAT gateway pertence.	cn-qingdao-b
EniInstanceId	string	O ID da instância da interface de rede elástica.	eni-bp1cmgtoaka8vfyg****
DeletionProtectionInfo	object	Informações sobre o recurso de proteção contra exclusão.
Enabled	boolean	Indica se a proteção contra exclusão está ativada. true false	true
IpList	array<object>	Os endereços Elastic IP (EIPs) associados ao NAT gateway público.
	object	Os EIPs associados ao NAT gateway público.
UsingStatus	string	O status de uso do EIP. Idle: Não associado a uma entrada SNAT ou a uma entrada DNAT. UsedBySnat: Associado a uma entrada SNAT. UsedByForward: Associado a uma entrada DNAT.	idle
IpAddress	string	O endereço EIP.	116.33.XX.XX
AllocationId	string	O ID da instância EIP.	eip-bp13e9i2qst4g6jzi****
PrivateLinkEnabled	boolean	Indica se o PrivateLink é suportado. Valores válidos: true: O PrivateLink é suportado. false: O PrivateLink não é suportado.	true
PrivateLinkMode	string	O modo do serviço PrivateLink. Valores válidos: FullNat: Modo FULLNAT. Geneve: Modo Geneve.	FullNat
EnableSessionLog	boolean	Indica se o registro de sessão está ativado. Valores válidos: true false	true
LogDelivery	object	As configurações de entrega de logs de sessão.
LogDeliveryType	string	O destino para o qual os logs de sessão são entregues. O valor é sempre sls, que indica o Log Service.	sls
LogDestination	string	O Logstore do Log Service para o qual os logs de sessão são entregues.	acs:log:cn-hangzhou:0000:project/nat_session_log_project/logstore/session_log_test
DeliveryStatus	string	O status da entrega de logs. Valores válidos: Success: Os logs foram entregues com sucesso. Failure: Falha na entrega dos logs.	Failure
DeliverLogsErrorMessage	string	A mensagem de erro retornada quando a entrega de logs falha.	LogStoreNotExist: logstore session_log_test does not exist
AccessMode	object	O modo de acesso do 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 túnel. Este parâmetro é retornado apenas quando `ModeValue` está definido como `tunnel`. Valor válido: geneve: Geneve.	geneve
AvailabilityMode	string

Exemplos

Resposta de sucesso

JSON formato

{
  "VpcId": "vpc-bp15zckdt37pq72z****",
  "CreationTime": "2021-12-08T12:20:20Z",
  "Status": "Available",
  "NatType": "Enhanced",
  "NetworkType": "internet",
  "RegionId": "cn-qingdao",
  "EcsMetricEnabled": true,
  "RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
  "Description": "NAT",
  "ExpiredTime": "2021-12-26T12:20:20Z",
  "ResourceGroupId": "rg-bp67acfmxazb4ph****",
  "NatGatewayId": "ngw-bp1047e2d4z7kf2ki****",
  "BusinessStatus": "Normal",
  "Name": "abc",
  "ForwardTable": {
    "ForwardTableId": "ftb-uf6gj3mhsg94qsqst****",
    "ForwardEntryCount": 1
  },
  "SnatTable": {
    "SnatEntryCount": 1,
    "SnatTableId": "stb-SnatTableIds****"
  },
  "FullNatTable": {
    "FullNatEntryCount": 1,
    "FullNatTableId": "fulltb-gw88z7hhlv43rmb26****"
  },
  "BillingConfig": {
    "InternetChargeType": "PayBySpec",
    "AutoPay": "false",
    "Spec": "Small",
    "InstanceChargeType": "PostPaid"
  },
  "PrivateInfo": {
    "MaxBandwidth": 5120,
    "VswitchId": "vsw-bp1s2laxhdf9ayjbo***",
    "PrivateIpAddress": "192.168.XX.XX",
    "IzNo": "cn-qingdao-b",
    "EniInstanceId": "eni-bp1cmgtoaka8vfyg****"
  },
  "DeletionProtectionInfo": {
    "Enabled": true
  },
  "IpList": [
    {
      "UsingStatus": "idle",
      "IpAddress": "116.33.XX.XX",
      "AllocationId": "eip-bp13e9i2qst4g6jzi****"
    }
  ],
  "PrivateLinkEnabled": true,
  "PrivateLinkMode": "FullNat",
  "EnableSessionLog": true,
  "LogDelivery": {
    "LogDeliveryType": "sls",
    "LogDestination": "acs:log:cn-hangzhou:0000:project/nat_session_log_project/logstore/session_log_test",
    "DeliveryStatus": "Failure",
    "DeliverLogsErrorMessage": "LogStoreNotExist: logstore session_log_test does not exist"
  },
  "AccessMode": {
    "ModeValue": "route",
    "TunnelType": "geneve"
  },
  "AvailabilityMode": ""
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
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.