DescribeNatGateways - API reference| Alibaba Cloud Documentation Center

Description

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.

Examples

Request example

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

Response example

XML format

<DescribeNatGatewaysResponse>
    <PageNumber>1</PageNumber>
    <TotalCount>1</TotalCount>
    <PageSize>10</PageSize>
    <RequestId>CF5D6933-C574-4FEC-83C0-4DF63EBD19CE</RequestId>
    <NatGateways>
        <NatGateway>
            <Description/>
            <Spec>Small</Spec>
            <ForwardTableIds>
                <ForwardTableId>ftb-rj9p798gwt2k3yk6c6yxh</ForwardTableId>
            </ForwardTableIds>
            <VpcId>vpc-rj983s9gj1nssugzh49vr</VpcId>
            <NatGatewayId>ngw-rj99ps4cq9lfse0ried3l</NatGatewayId>
            <CreationTime>2017-01-23T02:30:31Z</CreationTime>
            <BandwidthPackageIds>
                <BandwidthPackageId>bwp-rj911xdpev0h9liwesfg4</BandwidthPackageId>
            </BandwidthPackageIds>
            <Name/>
            <Status>Available</Status>
            <BusinessStatus>Normal</BusinessStatus>
            <RegionId>us-west-1</RegionId>
            <SnatTableIds>
                <SnatTableId>stb-rj9u47y5gl255bgmb3ady</SnatTableId>
            </SnatTableIds>
            <InstanceChargeType>PostPaid</InstanceChargeType>
        </NatGateway>
    </NatGateways>
</DescribeNatGatewaysResponse>