- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Retrieves runtime Nat mapping information of VM endpoints.
HTTP request
GET https://compute.googleapis.com/compute/v1/projects/{project}/regions/{region}/routers/{router}/getNatMappingInfo
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
Project ID for this request. |
region |
Name of the region for this request. |
router |
Name of the Router resource to query for Nat Mapping information of VM endpoints. |
Query parameters
Parameters | |
---|---|
maxResults |
The maximum number of results per page that should be returned. If the number of available results is larger than |
pageToken |
Specifies a page token to use. Set |
filter |
A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either For example, if you are filtering Compute Engine instances, you can exclude instances named The
You can also filter nested fields. For example, you could specify To filter on multiple expressions, provide each separate expression within parentheses. For example:
By default, each expression is an
If you want to use a regular expression, use the
The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use You cannot combine constraints on multiple fields using regular expressions. |
orderBy |
Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using Currently, only sorting by |
returnPartialSuccess |
Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. |
natName |
Name of the nat service to filter the Nat Mapping information. If it is omitted, all nats for this router will be returned. Name should conform to RFC1035. |
Request body
The request body must be empty.
Response body
Contains a list of VmEndpointNatMappings.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "kind": string, "id": string, "result": [ { "instanceName": string, "interfaceNatMappings": [ { "sourceVirtualIp": string, "sourceAliasIpRange": string, "numTotalNatPorts": integer, "natIpPortRanges": [ string ], "drainNatIpPortRanges": [ string ], "numTotalDrainNatPorts": integer, "ruleMappings": [ { "ruleNumber": integer, "numTotalNatPorts": integer, "natIpPortRanges": [ string ], "drainNatIpPortRanges": [ string ], "numTotalDrainNatPorts": integer } ] } ] } ], "nextPageToken": string, "selfLink": string, "warning": { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] } } |
Fields | |
---|---|
kind |
[Output Only] Type of resource. Always |
id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
result[] |
[Output Only] A list of Nat mapping information of VM endpoints. |
result[].instanceName |
Name of the VM instance which the endpoint belongs to |
result[].interfaceNatMappings[] |
|
result[].interfaceNatMappings[].sourceVirtualIp |
Primary IP of the VM for this NIC. |
result[].interfaceNatMappings[].sourceAliasIpRange |
Alias IP range for this interface endpoint. It will be a private (RFC 1918) IP range. Examples: "10.33.4.55/32", or "192.168.5.0/24". |
result[].interfaceNatMappings[].numTotalNatPorts |
Total number of ports across all NAT IPs allocated to this interface. It equals to the aggregated port number in the field natIpPortRanges. |
result[].interfaceNatMappings[].natIpPortRanges[] |
A list of all IP:port-range mappings assigned to this interface. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: ["2.2.2.2:12345-12355", "1.1.1.1:2234-2234"]. |
result[].interfaceNatMappings[].drainNatIpPortRanges[] |
routers.list of all drain IP:port-range mappings assigned to this interface. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: ["2.2.2.2:12345-12355", "1.1.1.1:2234-2234"]. |
result[].interfaceNatMappings[].numTotalDrainNatPorts |
Total number of drain ports across all NAT IPs allocated to this interface. It equals to the aggregated port number in the field drainNatIpPortRanges. |
result[].interfaceNatMappings[].ruleMappings[] |
Information about mappings provided by rules in this NAT. |
result[].interfaceNatMappings[].ruleMappings[].ruleNumber |
Rule number of the NAT Rule. |
result[].interfaceNatMappings[].ruleMappings[].numTotalNatPorts |
Total number of ports across all NAT IPs allocated to this interface by this rule. It equals the aggregated port number in the field natIpPortRanges. |
result[].interfaceNatMappings[].ruleMappings[].natIpPortRanges[] |
A list of all IP:port-range mappings assigned to this interface by this rule. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: ["2.2.2.2:12345-12355", "1.1.1.1:2234-2234"]. |
result[].interfaceNatMappings[].ruleMappings[].drainNatIpPortRanges[] |
routers.list of all drain IP:port-range mappings assigned to this interface by this rule. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: ["2.2.2.2:12345-12355", "1.1.1.1:2234-2234"]. |
result[].interfaceNatMappings[].ruleMappings[].numTotalDrainNatPorts |
Total number of drain ports across all NAT IPs allocated to this interface by this rule. It equals the aggregated port number in the field drainNatIpPortRanges. |
nextPageToken |
[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than |
selfLink |
[Output Only] Server-defined URL for this resource. |
warning |
[Output Only] Informational warning message. |
warning.code |
[Output Only] A warning code, if applicable. For example, Compute Engine returns |
warning.message |
[Output Only] A human-readable description of the warning code. |
warning.data[] |
[Output Only] Metadata about this warning in "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
warning.data[].key |
[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be |
warning.data[].value |
[Output Only] A warning data value corresponding to the key. |
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/compute.readonly
https://www.googleapis.com/auth/compute
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
In addition to any permissions specified on the fields above, authorization requires one or more of the following IAM permissions:
compute.routers.get
To find predefined roles that contain those permissions, see Compute Engine IAM Roles.