DescribeNatGatewayAssociateNetworkInterfaces - NAT Gateway

Queries elastic network interfaces (ENIs) associated with a virtual private cloud (VPC) NAT gateway when the VPC NAT gateway serves as a PrivateLink service resource. This feature is not publicly available.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
vpc:DescribeNatGatewayAssociateNetworkInterfaces	list	NatGateway `acs:vpc:{#regionId}:{#accountId}:natgateway/{#NatGatewayId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the Internet NAT gateway. Call the DescribeRegions operation to query the region list.	cn-hangzhou
NatGatewayId	string	Yes	The ID of the NAT gateway.	ngw-bp1uewa15k4iy5770****
ResourceGroupId	string	No	The resource group ID.	rg-acfmxazdjdhd****
Tag	array<object>	No	The information about resource tags.
	object	No	The tag.
Key	string	No	The tag key You can specify at most 20 tag keys. It cannot be an empty string, The tag key can be up to 64 characters in length and cannot contain `http://` or `https://`. The tag key cannot start with `aliyun` or `acs:`.	FinanceDept
Value	string	No	The tag key. You can specify at most 20 tag keys. It cannot be an empty string. The tag key can be up to 64 characters in length and cannot contain `http://` or `https://`. The tag key cannot start with `aliyun` or `acs:`.	FinanceJoshua
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 client token can contain only ASCII characters. Note If you do not set this parameter, the value of RequestId is used.** The RequestId** may be different for each request.	5A2CFF0E-5718-45B5-9D4D-70B3FF****
Filter	array<object>	No	The filter information. You can specify a filter key and a filter value.
	object	No	The information about the filter.
Key	string	No	The filter key. ResourceId Note Specify the service resource ID in the Value field. NetworkInterfaceId Note Specify the ENI ID in the Value field. ResourceOwnerId Note Specify the UID of the account to which the service resource belongs.	ResourceId
Value	string	No	Separate multiple values with commas (,).	ep-8psre8c8936596cd****
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. Valid value: If no value is returned for NetToken, you do not need to specify this parameter. If a value is returned for NextToken, you must specify the token that is obtained from the previous query as the value of NextToken.	caeba0bbb2be03f84eb48b699f0a****
MaxResults	integer	No	The number of entries to return per page. Valid values: 1 to 100. Default value: 20.	20

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	Request ID.	2315DEB7-5E92-423A-91F7-4C1EC9AD****
NextToken	string	Indicates whether the token for the next query exists. Valid value: If NextToken is empty, there is no next page. If the value returned of NextToken is not empty, the value indicates the token that is used for the next query.	caeba0bbb2be03f84eb48b699f0a****
MaxResults	integer	The number of entries to return per page. Valid values: 1 to 100. Default value: 20.	20
NatGatewayId	string	The ID of the VPC NAT gateway.	ngw-bp1uewa15k4iy5770****
TotalCount	integer	The total number of entries.	1
AssociateNetworkInterfaces	array<object>	The ENIs associated with the VPC NAT gateway.
AssociateNetworkInterface	object	The details of the ENI.
NetworkInterfaceId	string	The ID of the ENI.	eni-gw8g131ef2dnbu3k****
ResourceId	string	The ID of the service resource.	ep-8psre8c8936596cd****
ResourceType	string	The type of the service resource.	PrivateLink
ResourceOwnerId	string	The UID of the account to which the service resource belongs.	138859086900****
IPv4Sets	array<object>	The IPv4 addresses of the ENIs.
IPv4Set	object	The IPv4 address of the ENI.
IPv4Address	string	The primary private IP address of the ENI.	172.17..
Primary	boolean	Indicates whether the IP address is the primary private IP address. Valid values: true: Primary private IP address false: Secondary private IP addresses	true
TunnelIndex	string	The ID of the tunnel index.	41a5489ea2a0****
Count	integer	Number of associated ENIs.	0

Examples

Sample success responses

JSONformat

{
  "RequestId": "2315DEB7-5E92-423A-91F7-4C1EC9AD****",
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "MaxResults": 20,
  "NatGatewayId": "ngw-bp1uewa15k4iy5770****",
  "TotalCount": 1,
  "AssociateNetworkInterfaces": {
    "AssociateNetworkInterface": [
      {
        "NetworkInterfaceId": "eni-gw8g131ef2dnbu3k****",
        "ResourceId": "ep-8psre8c8936596cd****",
        "ResourceType": "PrivateLink",
        "ResourceOwnerId": "138859086900****",
        "IPv4Sets": {
          "IPv4Set": [
            {
              "IPv4Address": "172.17.**.**",
              "Primary": true
            }
          ]
        },
        "TunnelIndex": "41a5489ea2a0****",
        "ResourceVpcId": ""
      }
    ]
  },
  "Count": 0
}

Error codes

HTTP status code	Error code	Error message	Description
400	InstanceNotExist.NatGatewayId	The NAT gateway instance is not exist.	The NAT Gateway instance does not exist.
400	IllegalParam.ResourceOwnerId	The param of resource owner ID is illegal.	The parameter of resource owner ID is illegal.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-12-30	The Error code has changed. The response structure of the API has changed	View Change Details
2024-10-23	The Error code has changed. The response structure of the API has changed	View Change Details