Queries FULLNAT entries.
Debugging
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:
- The required resource types are displayed in bold characters.
- 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:ListFullNatEntries | get |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
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 specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.
| 5A2CFF0E-5718-45B5-9D4D-70B3FF3898 |
FullNatTableId | string | No | The ID of the FULLNAT table to which the FULLNAT entries to be queried belong. Note
You must specify at least one of FullNatTableId and NatGatewayId.
| fulltb-gw88z7hhlv43rmb26**** |
FullNatEntryId | string | No | The ID of the FULLNAT entry that you want to query. | fullnat-gw8fz23jezpbblf1j**** |
FullNatEntryNames | array | No | The name of the FULLNAT entry that you want to query. You can specify at most 20 names. The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter. | |
string | No | The name of the FULLNAT entry that you want to query. You can specify at most 20 names. The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter. | test | |
NetworkInterfaceIds | array | No | The ID of the elastic network interface (ENI) that you want to query. | |
string | No | The ID of the ENI that you want to query. You can specify up to 20 ENIs. | eni-gw80wedm8pq0tpr2**** | |
NextToken | string | No | The pagination token that is used in the next request to retrieve a new page of results. Valid values:
| caeba0bbb2be03f84eb48b699f0a4883 |
MaxResults | long | No | The number of entries per page. Valid values: 1 to 100. Default value: 20. | 20 |
RegionId | string | Yes | The region ID of the virtual private cloud (VPC) NAT gateway to which the FULLNAT entries to be queried belong. You can call the DescribeRegions operation to query the most recent region list. | eu-central-1 |
IpProtocol | string | No | The protocol of the packets that are forwarded by the port. Valid values:
| TCP |
NatGatewayId | string | No | The ID of the NAT gateway. Note
You must specify at least one of FullNatTableId and NatGatewayId.
| ngw-bp1uewa15k4iy5770**** |
NatIp | string | No | The NAT IP address that provides address translation in FULLNAT entries. | 10.0.XX.XX |
NatIpPort | string | No | The frontend port to be modified in the mapping of FULLNAT port. Valid values: 1 to 65535. | 443 |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "F03E41F6-1A74-311F-8D98-124EEE9F37B8",
"NatGatewayId": "ngw-gw8054kn57y3hq3bv****",
"FullNatTableId": "fullnat-gw8fz23jezpbblf1j****",
"TotalCount": 1,
"NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
"MaxResults": 1,
"FullNatEntries": [
{
"NatIp": "192.168.XX.XX",
"NatIpPort": "80",
"AccessIp": "192.168.XX.XX",
"AccessPort": "80",
"IpProtocol": "TCP",
"NetworkInterfaceId": "eni-gw80wedm8pq0tpr2****",
"NetworkInterfaceType": "Endpoint",
"FullNatEntryName": "test",
"FullNatEntryDescription": "abc",
"CreationTime": "2021-10-27T02:44:40Z",
"FullNatEntryId": "fullnat-gw8fz23jezpbblf1j****",
"FullNatEntryStatus": "Available",
"FullNatTableId": "fulltb-gw88z7hhlv43rmb26****"
}
]
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | ResourceNotFound.FullNatTableId | The specified resource of %s is not found. | - |
400 | MissingParam.FullnatTableIdOrNatGatewayId | FullnatTableId and natGatewayId can not both be null | FullnatTableId and natGatewayId cannot be empty at the same time. |
400 | ResourceNotFound.FullNatTable | The NAT gateway has no full nat table. | No FULLNAT table is configured for the NAT gateway. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2023-12-20 | The Error code has changed. The request parameters of the API has changed | View Change Details |