All Products
Search
Document Center

NAT Gateway:VpcDescribeVpcNatGatewayNetworkInterfaceQuota

Last Updated:Jun 19, 2026

Queries the number of endpoints (EPs) that can be created for reverse access on a VPC NAT gateway.

Operation description

Before you call this operation, make sure that you have created a VPC NAT gateway instance. For more information, see CreateNatGateway.

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:VpcDescribeVpcNatGatewayNetworkInterfaceQuota

get

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

ResourceUid

integer

No

The ID of the Alibaba Cloud account that owns the resource.

132193271328****

ClientToken

string

No

The client token that is used to ensure the idempotence of the request.

You can use the client to generate the token, but you must make sure that the token is unique among different requests. The ClientToken parameter supports only ASCII characters.

Note

If you do not specify this parameter, the system uses the RequestId of the API request as the ClientToken. The RequestId of each API request may be different.

123e4567-e89b-12d3-a456-426655440000

NatGatewayId

string

No

The ID of the VPC NAT gateway to query.

ngw-bp1uewa15k4iy5770****

RegionId

string

No

The region ID of the VPC NAT gateway to query.

You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou

Response elements

Element

Type

Description

Example

object

The request ID.

RequestId

string

The request ID.

611CB80C-B6A9-43DB-9E38-0B0AC3D9B58F

Quota

integer

The number of EPs that can be created.

2

Examples

Success response

JSON format

{
  "RequestId": "611CB80C-B6A9-43DB-9E38-0B0AC3D9B58F",
  "Quota": 2
}

Error codes

HTTP status code

Error code

Error message

Description

400 OperationDenied.PrivateLinkNotEnabled The NAT gateway is not enable for private link. The error message returned because the NAT gateway cannot use PrivateLink.
404 ResourceNotFound.NatGateway The NatGateway instance not exist. The NAT gateway does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.