edit-icon download-icon


Last Updated: Apr 09, 2018


Query the created NAT Gateways in a specified region.

Request parameters

Name Type Required Description
Action String Yes

The action to perform.

Valid value: DescribeNatGateways

RegionId String Yes

The region of the NAT Gateway.

You can query the region ID by calling the DescribeRegions API.

NatGatewayId String No

The ID of the NAT Gateway.

VpcId String No

The ID of the VPC.

PageNumber Integer No The number of pages to return. The default value is 1.
PageSize Integer No The number of rows per page. The maximum value is 50 and the default value is 10.

Response parameters

Name Type Description
NatGateways JSON string A list of queried NAT Gateways.
TotalCount Integer The number of queried entries.
PageNumber Integer The current page number.
PageSize Integer The number of entries on the current page.

Error codes

See VPC API Error Center.


Request example

  1. https://vpc.aliyuncs.com/?&Action=DescribeNatGateways
  2. &VpcId=vpc-11af8lp67
  3. &RegionId=cn-shanghai
  4. &<CommonParameters>

Response example

XML format

  1. <DescribeNatGatewaysResponse>
  2. <PageNumber>1</PageNumber>
  3. <TotalCount>1</TotalCount>
  4. <PageSize>10</PageSize>
  5. <RequestId>CF5D6933-C574-4FEC-83C0-4DF63EBD19CE</RequestId>
  6. <NatGateways>
  7. <NatGateway>
  8. <Description/>
  9. <Spec>Small</Spec>
  10. <ForwardTableIds>
  11. <ForwardTableId>ftb-rj9p798gwt2k3yk6c6yxh</ForwardTableId>
  12. </ForwardTableIds>
  13. <VpcId>vpc-rj983s9gj1nssugzh49vr</VpcId>
  14. <NatGatewayId>ngw-rj99ps4cq9lfse0ried3l</NatGatewayId>
  15. <CreationTime>2017-01-23T02:30:31Z</CreationTime>
  16. <BandwidthPackageIds>
  17. <BandwidthPackageId>bwp-rj911xdpev0h9liwesfg4</BandwidthPackageId>
  18. </BandwidthPackageIds>
  19. <Name/>
  20. <Status>Available</Status>
  21. <BusinessStatus>Normal</BusinessStatus>
  22. <RegionId>us-west-1</RegionId>
  23. <SnatTableIds>
  24. <SnatTableId>stb-rj9u47y5gl255bgmb3ady</SnatTableId>
  25. </SnatTableIds>
  26. <InstanceChargeType>PostPaid</InstanceChargeType>
  27. </NatGateway>
  28. </NatGateways>
  29. </DescribeNatGatewaysResponse>
Thank you! We've received your feedback.