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

Observações de uso

Use esta operação para consultar gateways NAT de Virtual Private Cloud (VPC) e gateways NAT de Internet. Neste tópico, o termo "gateways NAT" refere-se a ambos os tipos.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeNatGateways	A operação a ser executada. Defina o valor como DescribeNatGateways.
RegionId	String	Sim	cn-hangzhou	O ID da região dos gateways NAT a serem consultados. Chame a operação DescribeRegions para obter a lista mais recente de regiões.
NatGatewayId	String	Não	ngw-bp1uewa15k4iy5770****	O ID do gateway NAT.
VpcId	String	Não	vpc-bp15zckdt37pq72z****	O ID da VPC à qual o gateway NAT pertence.
Name	String	Não	test	O nome do gateway NAT. O nome deve ter de 1 a 128 caracteres e não pode começar com `http://` ou `https://`. Se este parâmetro não for especificado, o sistema atribuirá automaticamente um nome ao gateway NAT.
InstanceChargeType	String	Não	PostPaid	O método de faturamento do gateway NAT. Defina o valor como PostPaid, que especifica o método de pagamento conforme o uso.
Spec	String	Não	Valor de exemplo para o site da Alibaba Cloud na China: Small. Se você usar o site internacional da Alibaba Cloud, ignore este parâmetro.	O tamanho do gateway NAT. Ignore este parâmetro.
NatType	String	Não	Enhanced	O tipo de gateway NAT. Defina o valor como Enhanced (gateway NAT aprimorado).
ResourceGroupId	String	Não	rg-bp67acfmxazb4ph****	O ID do grupo de recursos ao qual o gateway NAT pertence.
PageNumber	Integer	Não	10	O número da página a ser retornada. Valor padrão: 1.
PageSize	Integer	Não	1	O número de entradas a serem retornadas em cada página. Valor máximo: 50. Valor padrão: 10.
DryRun	Boolean	Não	false	Especifica se deve ser executada apenas uma simulação, sem realizar a solicitação real. Valores válidos: true: executa apenas uma simulação. O sistema verifica a solicitação em busca de problemas potenciais, incluindo valores de parâmetros ausentes, sintaxe incorreta e limites de serviço. Se a solicitação falhar na simulação, uma mensagem de erro será retornada. Se passar, o código de erro `DryRunOperation` será retornado. false (padrão): executa uma simulação e realiza a solicitação real. Se a solicitação passar na simulação, um código de status HTTP 2xx será retornado e a operação será executada.
Status	String	Não	Available	O status do gateway NAT. Valores válidos: Creating: Após o envio de uma solicitação para criar um gateway NAT, o sistema o cria em segundo plano. O gateway permanece no estado Creating até a conclusão da operação. Available: O gateway NAT permanece em um estado estável após sua criação. Modifying: Após o envio de uma solicitação para modificar um gateway NAT, o sistema o modifica em segundo plano. O gateway permanece no estado Modifying até a conclusão da operação. Deleting: Após o envio de uma solicitação para excluir um gateway NAT, o sistema o exclui em segundo plano. O gateway permanece no estado Deleting até a conclusão da operação. Converting: Após o envio de uma solicitação para atualizar um gateway NAT padrão para um gateway NAT aprimorado, o sistema realiza a atualização em segundo plano. O gateway permanece no estado Converting até a conclusão da operação.
NetworkType	String	Não	internet	O tipo do gateway NAT. Valores válidos: internet: um gateway NAT de Internet intranet: um gateway NAT de VPC
Tag.N.Key	String	Não	KeyTest	As chaves de tag do gateway NAT. É possível especificar até 20 chaves de tag. Cada chave de tag não pode exceder 64 caracteres e não pode começar com `aliyun` ou `acs:`. Não pode conter `http://` ou `https://`.
Tag.N.Value	String	Não	valueTest	Os valores de tag do gateway NAT. É possível especificar no máximo 20 valores de tag. O valor da tag não pode exceder 128 caracteres e não pode começar com `aliyun` ou `acs:`. O valor não pode conter `http://` ou `https://`.
ZoneId	String	Não	cn-hangzhou-b	O ID da zona à qual o gateway NAT pertence.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
PageSize	Integer	10	O número de entradas retornadas em cada página.
RequestId	String	4EC47282-1B74-4534-BD0E-403F3EE64CAF	O ID da solicitação.
PageNumber	Integer	10	O número da página retornada.
TotalCount	Integer	1	O número de entradas de gateway NAT retornadas.
NatGateways	Array of NatGateway		Os detalhes sobre o gateway NAT.
NatGateway
Status	String	Creating	O status do gateway NAT. Valores válidos: Creating: Após o envio de uma solicitação para criar um gateway NAT, o sistema o cria em segundo plano. O gateway permanece no estado Creating até a conclusão da operação. Available: O gateway NAT permanece em um estado estável após sua criação. Modifying: Após o envio de uma solicitação para modificar um gateway NAT, o sistema o modifica em segundo plano. O gateway permanece no estado Modifying até a conclusão da operação. Deleting: Após o envio de uma solicitação para excluir um gateway NAT, o sistema o exclui em segundo plano. O gateway permanece no estado Deleting até a conclusão da operação. Converting: Após o envio de uma solicitação para atualizar um gateway NAT padrão para um gateway NAT aprimorado, o sistema realiza a atualização em segundo plano. O gateway permanece no estado Converting até a conclusão da operação.
CreationTime	String	2021-06-08T12:20:20Z	O horário em que o gateway NAT foi criado.
VpcId	String	vpc-bp15zckdt37pq72z****	O ID da VPC onde o gateway NAT está implantado.
NatType	String	Enhanced	O tipo do gateway NAT. O valor é definido como Enhanced (gateway NAT aprimorado).
AutoPay	Boolean	false	Indica se o pagamento automático está ativado. Valores válidos: false true
Spec	String	Small	O tamanho do gateway NAT. Um valor vazio é retornado para este parâmetro. Se InternetChargeType estiver definido como PayByLcu, um valor vazio será retornado.
DeletionProtection	Boolean	true	Indica se o recurso de proteção contra exclusão está ativado. Valores válidos: true false
NetworkType	String	internet	O tipo de gateway NAT. Valores válidos: internet: um gateway NAT de Internet intranet: um gateway NAT de VPC
SecurityProtectionEnabled	Boolean	false	Indica se o recurso de firewall está ativado. Valores válidos: false: não true: sim
InstanceChargeType	String	PostPaid	O método de faturamento do gateway NAT. O valor é definido como PostPaid, que indica o método de pagamento conforme o uso.
RegionId	String	cn-hangzhou	O ID da região onde o gateway NAT está implantado.
EcsMetricEnabled	Boolean	true	Indica se o recurso de monitoramento de tráfego está ativado. Valores válidos: true false
IcmpReplyEnabled	Boolean	true	Indica se a recuperação ICMP está ativada. Valores válidos: true (padrão): sim false
Description	String	NAT	A descrição do gateway NAT.
ExpiredTime	String	2021-08-26T16:00Z	O horário em que o gateway NAT expira.
ResourceGroupId	String	rg-bp67acfmxazb4ph****	O ID do grupo de recursos ao qual o grupo contíguo de EIPs pertence.
NatGatewayId	String	ngw-bp1047e2d4z7kf2ki****	O ID do gateway NAT de Internet.
InternetChargeType	String	PayByLcu	O método de medição do gateway NAT. Valores válidos: PayBySpec: pagamento por especificação PayByLcu: pagamento por CU
BusinessStatus	String	Normal	O status do gateway NAT. Valores válidos: Normal FinancialLocked
Name	String	abc	O nome do gateway NAT.
IpLists	Array of IpList		A lista de endereços IP elásticos (EIPs) associados ao gateway NAT de Internet.
IpList
UsingStatus	String	UsedByForwardTable	A associação entre o EIP e o gateway NAT de Internet. Valores válidos: UsedByForwardTable: O EIP está especificado em uma entrada DNAT. UsedBySnatTable: O EIP está especificado em uma entrada SNAT. UsedByForwardSnatTable: O EIP está especificado tanto em uma entrada SNAT quanto em uma entrada DNAT. Idle: O EIP não está especificado em nenhuma entrada DNAT ou SNAT.
IpAddress	String	116.62.XX.XX	O endereço IP do EIP associado ao gateway NAT.
SnatEntryEnabled	Boolean	false	Indica se os endereços IP usados em entradas DNAT podem ser especificados em entradas SNAT. Valores válidos: true false
AllocationId	String	eip-m5egzuvp3dgixen6****	O ID do EIP associado ao gateway NAT.
PrivateIpAddress	String	192.168.XX.XX	O endereço IP privado do gateway NAT.
ForwardTableIds	Array of String	ftb-uf6gj3mhsg94qsqst****	O ID da tabela DNAT.
SnatTableIds	Array of String	stb-uf6dalcdu0krz423p****	O ID da tabela SNAT do gateway NAT.
FullNatTableIds	Array of String	fulltb-gw88z7hhlv43rmb26****	O ID da tabela FULLNAT.
NatGatewayPrivateInfo	Object		As informações de rede privada sobre o gateway NAT de Internet aprimorado. Nota Se NatType estiver definido como Normal, todos os parâmetros retornados nesta lista estarão vazios.
VswitchId	String	vsw-bp1s2laxhdf9ayjbo****	O ID do vSwitch ao qual o gateway NAT pertence.
EniInstanceId	String	eni-m5eg4ozy5st8q3q4****	O ID da interface de rede elástica (ENI).
MaxBandwidth	Integer	5120	A largura de banda máxima. Unidade: Mbit/s.
MaxSessionQuota	Integer	2.000.000	O número de conexões simultâneas ao gateway NAT. Unidade: conexões.
MaxSessionEstablishRate	Integer	100.000	O número de novas conexões ao gateway NAT. Unidade: conexões por segundo.
PrivateIpAddress	String	192.168.XX.XX	Endereços IP privados.
IzNo	String	cn-hangzhou-b	A zona à qual o gateway NAT pertence.
EniType	String	indirect	O modo pelo qual a ENI está associada ao gateway NAT. indirect: modo não direto Se um valor vazio for retornado, indica que o modo direto está sendo usado.
PrivateLinkEnabled	Boolean	true	Indica se o gateway NAT suporta PrivateLink. Valores válidos: true false
PrivateLinkMode	String	FullNat	O modo usado pelo PrivateLink. Valores válidos: FullNat: o modo FULLNAT Geneve: o modo GENEVE
EipBindMode	String	MULTI_BINDED	O modo pelo qual o gateway NAT está associado a um endereço IP elástico (EIP). Valores válidos: MULTI_BINDED: modo multi-EIP para ENI NAT: modo NAT, compatível com endereços IPv4 Nota Ao usar o modo NAT, o EIP ocupa um endereço IP privado no vSwitch do gateway NAT. Certifique-se de que o vSwitch tenha endereços IP privados suficientes. Caso contrário, a associação do gateway NAT com o EIP falhará. No modo NAT, é possível associar um gateway NAT a até 50 EIPs.
Tags	Array of Tag		A lista de tags.
Tag
TagKey	String	KeyTest	A chave da tag.
TagValue	String	valueTest	O valor da tag.

Exemplos

Solicitações de exemplo

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

Respostas de sucesso de exemplo

Formato 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>

Formato 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"
    } ]
  } ]
}

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.	A mensagem de erro retornada porque o ID da região especificado não existe.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	A mensagem de erro retornada porque ocorreu um erro interno.

Para obter uma lista de códigos de erro, visite a Central de Erros de API.