DescribeNatGateways - Elastic Compute Service - Alibaba Cloud Documentation Center

Note

This API has been deprecated. We recommend migrating to Vpc(2016-04-28) - DescribeNatGateways for enhanced functionality and continued support. While the deprecated API remains temporarily accessible, no further updates or bug fixes will be provided.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vpc:DescribeNatGateways

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region to which the NAT gateways belong. You can call the DescribeRegions operation to obtain the latest list of regions.
NatGatewayId	string	No	The ID of the NAT gateway.
VpcId	string	No	The ID of the VPC to which the NAT gateway belongs.
PageNumber	integer	No	The number of the page to return. Page numbering starts at 1. Default value: 1.
PageSize	integer	No	The number of entries per page. Valid values: 1 to 100. Default value: 10.

Response elements

Element	Type	Description	Example
	object	The returned data.
PageSize	integer	The number of entries per page.
RequestId	string	The request ID.
PageNumber	integer	The page number.
TotalCount	integer	The total number of entries returned.
NatGateways	object	A container for the details of the NAT Gateways.
NatGateway	array<object>	A list of NAT Gateway objects.
	array<object>	The details of the NAT Gateway.
Status	string	The status of the NAT Gateway. Valid values: `Available`, `Pending`, and `Deleting`.
CreationTime	string	The time when the NAT Gateway was created. The time is in UTC and is formatted as `YYYY-MM-DDThh:mm:ssZ`.
VpcId	string	The ID of the VPC to which the NAT Gateway belongs.
Spec	string	The specification of the NAT Gateway. Valid values: `Small`, `Middle`, and `Large`.
Description	string	The NAT Gateway description.
NatGatewayId	string	The NAT Gateway ID.
BusinessStatus	string	The business status of the NAT Gateway. Valid values: `Normal` and `FinancialLocked`.
Name	string	The NAT Gateway name.
InstanceChargeType	string	The billing method of the NAT Gateway. The value is `PostPaid`, which indicates the pay-as-you-go billing method.
RegionId	string	The ID of the region in which the NAT Gateway is deployed.
ForwardTableIds	object	The IDs of the forwarding tables.
ForwardTableId	array	A list of forwarding table IDs.
	string	The ID of the forwarding table.
BandwidthPackageIds	object	The IDs of the bandwidth packages.
BandwidthPackageId	array	A list of bandwidth package IDs.
	string	The ID of the bandwidth package.

Examples

Success response

JSON format

{
  "PageSize": 0,
  "RequestId": "",
  "PageNumber": 0,
  "TotalCount": 0,
  "NatGateways": {
    "NatGateway": [
      {
        "Status": "",
        "CreationTime": "",
        "VpcId": "",
        "Spec": "",
        "Description": "",
        "NatGatewayId": "",
        "BusinessStatus": "",
        "Name": "",
        "InstanceChargeType": "",
        "RegionId": "",
        "ForwardTableIds": {
          "ForwardTableId": [
            ""
          ]
        },
        "BandwidthPackageIds": {
          "BandwidthPackageId": [
            ""
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidAliuid	User Id is not valid.
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.	The specified RegionId parameter does not exist. Check whether the service is available in the specified region.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.