Method: routers.aggregatedList

Retrieves an aggregated list of routers.

To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

HTTP request

GET https://compute.googleapis.com/compute/v1/projects/{project}/aggregated/routers

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID for this request.

Query parameters

Parameters
maxResults

integer (uint32 format)

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
pageToken

string

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter

string

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 =, !=, >, <, <=, >= or :.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use:

labels.owner:*

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example:

(scheduling.automaticRestart = true)
(cpuPlatform = "Intel Skylake")

By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example:

(cpuPlatform = "Intel Skylake") OR
(cpuPlatform = "Intel Broadwell") AND
(scheduling.automaticRestart = true)

If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples:

fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal")

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 name ne .*instance.

You cannot combine constraints on multiple fields using regular expressions.
orderBy

string

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 orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
returnPartialSuccess

boolean

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.
includeAllScopes

boolean

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
serviceProjectNumber

string (int64 format)

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

Request body

The request body must be empty.

Response body

Contains a list of routers.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "kind": string,
  "id": string,
  "items": {
    string: {
      "routers": [
        {
          "kind": string,
          "id": string,
          "creationTimestamp": string,
          "name": string,
          "description": string,
          "region": string,
          "network": string,
          "interfaces": [
            {
              "name": string,
              "linkedVpnTunnel": string,
              "linkedInterconnectAttachment": string,
              "ipRange": string,
              "managementType": enum,
              "privateIpAddress": string,
              "redundantInterface": string,
              "subnetwork": string,
              "ipVersion": enum
            }
          ],
          "bgpPeers": [
            {
              "name": string,
              "interfaceName": string,
              "ipAddress": string,
              "peerIpAddress": string,
              "peerAsn": integer,
              "advertisedRoutePriority": integer,
              "advertiseMode": enum,
              "advertisedGroups": [
                enum
              ],
              "advertisedIpRanges": [
                {
                  "range": string,
                  "description": string
                }
              ],
              "managementType": enum,
              "enable": enum,
              "bfd": {
                "sessionInitializationMode": enum,
                "minTransmitInterval": integer,
                "minReceiveInterval": integer,
                "multiplier": integer
              },
              "routerApplianceInstance": string,
              "enableIpv6": boolean,
              "ipv6NexthopAddress": string,
              "peerIpv6NexthopAddress": string,
              "md5AuthenticationKeyName": string,
              "customLearnedRoutePriority": integer,
              "customLearnedIpRanges": [
                {
                  "range": string
                }
              ],
              "enableIpv4": boolean,
              "ipv4NexthopAddress": string,
              "peerIpv4NexthopAddress": string,
              "exportPolicies": [
                string
              ],
              "importPolicies": [
                string
              ]
            }
          ],
          "bgp": {
            "asn": integer,
            "advertiseMode": enum,
            "advertisedGroups": [
              enum
            ],
            "advertisedIpRanges": [
              {
                "range": string,
                "description": string
              }
            ],
            "keepaliveInterval": integer,
            "identifierRange": string
          },
          "selfLink": string,
          "nats": [
            {
              "name": string,
              "type": enum,
              "autoNetworkTier": enum,
              "endpointTypes": [
                enum
              ],
              "sourceSubnetworkIpRangesToNat": enum,
              "subnetworks": [
                {
                  "name": string,
                  "sourceIpRangesToNat": [
                    enum
                  ],
                  "secondaryIpRangeNames": [
                    string
                  ]
                }
              ],
              "natIps": [
                string
              ],
              "drainNatIps": [
                string
              ],
              "natIpAllocateOption": enum,
              "minPortsPerVm": integer,
              "maxPortsPerVm": integer,
              "enableDynamicPortAllocation": boolean,
              "udpIdleTimeoutSec": integer,
              "icmpIdleTimeoutSec": integer,
              "tcpEstablishedIdleTimeoutSec": integer,
              "tcpTransitoryIdleTimeoutSec": integer,
              "tcpTimeWaitTimeoutSec": integer,
              "logConfig": {
                "enable": boolean,
                "filter": enum
              },
              "rules": [
                {
                  "ruleNumber": integer,
                  "description": string,
                  "match": string,
                  "action": {
                    "sourceNatActiveIps": [
                      string
                    ],
                    "sourceNatDrainIps": [
                      string
                    ],
                    "sourceNatActiveRanges": [
                      string
                    ],
                    "sourceNatDrainRanges": [
                      string
                    ]
                  }
                }
              ],
              "enableEndpointIndependentMapping": boolean
            }
          ],
          "encryptedInterconnectRouter": boolean,
          "md5AuthenticationKeys": [
            {
              "name": string,
              "key": string
            }
          ]
        }
      ],
      "warning": {
        "code": enum,
        "message": string,
        "data": [
          {
            "key": string,
            "value": string
          }
        ]
      }
    },
    ...
  },
  "nextPageToken": string,
  "selfLink": string,
  "warning": {
    "code": enum,
    "message": string,
    "data": [
      {
        "key": string,
        "value": string
      }
    ]
  },
  "unreachables": [
    string
  ]
}
Fields
kind

string

Type of resource.
id

string

[Output Only] Unique identifier for the resource; defined by the server.
items

map (key: string, value: object)

A list of Router resources.

Key: Name of the scope containing this set of routers.
items.routers[]

object

A list of routers contained in this scope.
items.routers[].kind

string

[Output Only] Type of resource. Always compute#router for routers.
items.routers[].id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.
items.routers[].creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.
items.routers[].name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
items.routers[].description

string

An optional description of this resource. Provide this property when you create the resource.
items.routers[].region

string

[Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
items.routers[].network

string

URI of the network to which this router belongs.
items.routers[].interfaces[]

object

Router interfaces. To create a BGP peer that uses a router interface, the interface must have one of the following fields specified:

  • linkedVpnTunnel
  • linkedInterconnectAttachment
  • subnetwork
You can create a router interface without any of these fields specified. However, you cannot create a BGP peer that uses that interface.
items.routers[].interfaces[].name

string

Name of this interface entry. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
items.routers[].interfaces[].linkedVpnTunnel

string

URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork.
items.routers[].interfaces[].linkedInterconnectAttachment

string

URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork.
items.routers[].interfaces[].ipRange

string

IP address and range of the interface.

  • For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface.
  • For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fc00:0:1:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose.
items.routers[].interfaces[].managementType

enum

[Output Only] The resource that configures and manages this interface.

  • MANAGED_BY_USER is the default value and can be managed directly by users.
  • MANAGED_BY_ATTACHMENT is an interface that is configured and managed by Cloud Interconnect, specifically, by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of interface when the PARTNER InterconnectAttachment is created, updated, or deleted.
items.routers[].interfaces[].privateIpAddress

string

The regional private internal IP address that is used to establish BGP sessions to a VM instance acting as a third-party Router Appliance, such as a Next Gen Firewall, a Virtual Router, or an SD-WAN VM.
items.routers[].interfaces[].redundantInterface

string

Name of the interface that will be redundant with the current interface you are creating. The redundantInterface must belong to the same Cloud Router as the interface here. To establish the BGP session to a Router Appliance VM, you must create two BGP peers. The two BGP peers must be attached to two separate interfaces that are redundant with each other. The redundantInterface must be 1-63 characters long, and comply with RFC1035. Specifically, the redundantInterface must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
items.routers[].interfaces[].subnetwork

string

The URI of the subnetwork resource that this interface belongs to, which must be in the same region as the Cloud Router. When you establish a BGP session to a VM instance using this interface, the VM instance must belong to the same subnetwork as the subnetwork specified here.
items.routers[].interfaces[].ipVersion

enum

IP version of this interface.
items.routers[].bgpPeers[]

object

BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273.
items.routers[].bgpPeers[].name

string

Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
items.routers[].bgpPeers[].interfaceName

string

Name of the interface the BGP peer is associated with.
items.routers[].bgpPeers[].ipAddress

string

IP address of the interface inside Google Cloud Platform.
items.routers[].bgpPeers[].peerIpAddress

string

IP address of the BGP interface outside Google Cloud Platform.
items.routers[].bgpPeers[].peerAsn

integer (uint32 format)

Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.
items.routers[].bgpPeers[].advertisedRoutePriority

integer (uint32 format)

The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win.
items.routers[].bgpPeers[].advertiseMode

enum

User-specified flag to indicate which mode to use for advertisement.
items.routers[].bgpPeers[].advertisedGroups[]

enum

User-specified list of prefix groups to advertise in custom mode, which currently supports the following option:

  • ALL_SUBNETS: Advertises all of the router's own VPC subnets. This excludes any routes learned for subnets that use VPC Network Peering.
Note that this field can only be populated if advertiseMode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These groups are advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.
items.routers[].bgpPeers[].advertisedIpRanges[]

object

User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertiseMode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These IP ranges are advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.
items.routers[].bgpPeers[].advertisedIpRanges[].range

string

The IP range to advertise. The value must be a CIDR-formatted string.
items.routers[].bgpPeers[].advertisedIpRanges[].description

string

User-specified description for the IP range.
items.routers[].bgpPeers[].managementType

enum

[Output Only] The resource that configures and manages this BGP peer.

  • MANAGED_BY_USER is the default value and can be managed by you or other users
  • MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted.
items.routers[].bgpPeers[].enable

enum

The status of the BGP peer connection.

If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE.
items.routers[].bgpPeers[].bfd

object

BFD configuration for the BGP peering.
items.routers[].bgpPeers[].bfd.sessionInitializationMode

enum

The BFD session initialization mode for this BGP peer.

If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is DISABLED.
items.routers[].bgpPeers[].bfd.minTransmitInterval

integer (uint32 format)

The minimum interval, in milliseconds, between BFD control packets transmitted to the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the corresponding receive interval of the other router.

If set, this value must be between 1000 and 30000.

The default is 1000.
items.routers[].bgpPeers[].bfd.minReceiveInterval

integer (uint32 format)

The minimum interval, in milliseconds, between BFD control packets received from the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the transmit interval of the other router.

If set, this value must be between 1000 and 30000.

The default is 1000.
items.routers[].bgpPeers[].bfd.multiplier

integer (uint32 format)

The number of consecutive BFD packets that must be missed before BFD declares that a peer is unavailable.

If set, the value must be a value between 5 and 16.

The default is 5.
items.routers[].bgpPeers[].routerApplianceInstance

string

URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances. The VM instance must be located in zones contained in the same region as this Cloud Router. The VM instance is the peer side of the BGP session.
items.routers[].bgpPeers[].enableIpv6

boolean

Enable IPv6 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 6.
items.routers[].bgpPeers[].ipv6NexthopAddress

string

IPv6 address of the interface inside Google Cloud Platform.
items.routers[].bgpPeers[].peerIpv6NexthopAddress

string

IPv6 address of the BGP interface outside Google Cloud Platform.
items.routers[].bgpPeers[].md5AuthenticationKeyName

string

Present if MD5 authentication is enabled for the peering. Must be the name of one of the entries in the Router.md5_authentication_keys. The field must comply with RFC1035.
items.routers[].bgpPeers[].customLearnedRoutePriority

integer

The user-defined custom learned route priority for a BGP session. This value is applied to all custom learned route ranges for the session. You can choose a value from 0 to 65335. If you don't provide a value, Google Cloud assigns a priority of 100 to the ranges.
items.routers[].bgpPeers[].customLearnedIpRanges[]

object

A list of user-defined custom learned route IP address ranges for a BGP session.
items.routers[].bgpPeers[].customLearnedIpRanges[].range

string

The custom learned route IP address range. Must be a valid CIDR-formatted prefix. If an IP address is provided without a subnet mask, it is interpreted as, for IPv4, a /32 singular IP address range, and, for IPv6, /128.
items.routers[].bgpPeers[].enableIpv4

boolean

Enable IPv4 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 4.
items.routers[].bgpPeers[].ipv4NexthopAddress

string

IPv4 address of the interface inside Google Cloud Platform.
items.routers[].bgpPeers[].peerIpv4NexthopAddress

string

IPv4 address of the BGP interface outside Google Cloud Platform.
items.routers[].bgpPeers[].exportPolicies[]

string

routers.list of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type.

Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies.
items.routers[].bgpPeers[].importPolicies[]

string

routers.list of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type.

Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies.
items.routers[].bgp

object

BGP information specific to this router.
items.routers[].bgp.asn

integer (uint32 format)

Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
items.routers[].bgp.advertiseMode

enum

User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM.
items.routers[].bgp.advertisedGroups[]

enum

User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertiseMode is CUSTOM and is advertised to all peers of the router. These groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.
items.routers[].bgp.advertisedIpRanges[]

object

User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertiseMode is CUSTOM and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.
items.routers[].bgp.advertisedIpRanges[].range

string

The IP range to advertise. The value must be a CIDR-formatted string.
items.routers[].bgp.advertisedIpRanges[].description

string

User-specified description for the IP range.
items.routers[].bgp.keepaliveInterval

integer (uint32 format)

The interval in seconds between BGP keepalive messages that are sent to the peer.

Hold time is three times the interval at which keepalive messages are sent, and the hold time is the maximum number of seconds allowed to elapse between successive keepalive messages that BGP receives from a peer.

BGP will use the smaller of either the local hold time value or the peer's hold time value as the hold time for the BGP connection between the two peers.

If set, this value must be between 20 and 60. The default is 20.
items.routers[].bgp.identifierRange

string

Explicitly specifies a range of valid BGP Identifiers for this Router. It is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at least /30, even if the BGP sessions are over IPv6. It must not overlap with any IPv4 BGP session ranges.

Other vendors commonly call this "router ID".
items.routers[].selfLink

string

[Output Only] Server-defined URL for the resource.
items.routers[].nats[]

object

A list of NAT services created in this router.
items.routers[].nats[].name

string

Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.
items.routers[].nats[].type

enum

Indicates whether this NAT is used for public or private IP translation. If unspecified, it defaults to PUBLIC.
items.routers[].nats[].autoNetworkTier

enum

The network tier to use when automatically reserving NAT IP addresses. Must be one of: PREMIUM, STANDARD. If not specified, then the current  project-level default tier is used.
items.routers[].nats[].endpointTypes[]

enum

routers.list of NAT-ted endpoint types supported by the Nat Gateway. If the list is empty, then it will be equivalent to include ENDPOINT_TYPE_VM
items.routers[].nats[].sourceSubnetworkIpRangesToNat

enum

Specify the Nat option, which can take one of the following values:

  • ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat.
  • ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat.
  • LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field subnetwork below)
The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there should not be any other Router.Nat section in any Router for this network in this region.
items.routers[].nats[].subnetworks[]

object

A list of Subnetwork resources whose traffic should be translated by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the SubnetworkIpRangeToNatOption above.
items.routers[].nats[].subnetworks[].name

string

URL for the subnetwork resource that will use NAT.
items.routers[].nats[].subnetworks[].sourceIpRangesToNat[]

enum

Specify the options for NAT ranges in the Subnetwork. All options of a single value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. The only valid option with multiple values is: ["PRIMARY_IP_RANGE", "LIST_OF_SECONDARY_IP_RANGES"] Default: [ALL_IP_RANGES]
items.routers[].nats[].subnetworks[].secondaryIpRangeNames[]

string

A list of the secondary ranges of the Subnetwork that are allowed to use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES" is one of the values in sourceIpRangesToNat.
items.routers[].nats[].natIps[]

string

A list of URLs of the IP resources used for this Nat service. These IP addresses must be valid static external IP addresses assigned to the project.
items.routers[].nats[].drainNatIps[]

string

A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT only.
items.routers[].nats[].natIpAllocateOption

enum

Specify the NatIpAllocateOption, which can take one of the following values:

  • MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there are not enough specified Nat IPs, the Nat service fails for new VMs.
  • AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can't specify any Nat IPs. When choosing AUTO_ONLY, then natIp should be empty.
items.routers[].nats[].minPortsPerVm

integer

Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. This is rounded up to the nearest power of 2. For example, if the value of this field is 50, at least 64 ports are allocated to a VM.
items.routers[].nats[].maxPortsPerVm

integer

Maximum number of ports allocated to a VM from this NAT config when Dynamic Port Allocation is enabled.

If Dynamic Port Allocation is not enabled, this field has no effect.

If Dynamic Port Allocation is enabled, and this field is set, it must be set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm is not set.

If Dynamic Port Allocation is enabled and this field is not set, a maximum of 65536 ports will be allocated to a VM from this NAT config.
items.routers[].nats[].enableDynamicPortAllocation

boolean

Enable Dynamic Port Allocation.

If not specified, it is disabled by default.

If set to true,

  • Dynamic Port Allocation will be enabled on this NAT config.
  • enableEndpointIndependentMapping cannot be set to true.
  • If minPorts is set, minPortsPerVm must be set to a power of two greater than or equal to 32. If minPortsPerVm is not set, a minimum of 32 ports will be allocated to a VM from this NAT config.
items.routers[].nats[].udpIdleTimeoutSec

integer

Timeout (in seconds) for UDP connections. Defaults to 30s if not set.
items.routers[].nats[].icmpIdleTimeoutSec

integer

Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.
items.routers[].nats[].tcpEstablishedIdleTimeoutSec

integer

Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set.
items.routers[].nats[].tcpTransitoryIdleTimeoutSec

integer

Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.
items.routers[].nats[].tcpTimeWaitTimeoutSec

integer

Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults to 120s if not set.
items.routers[].nats[].logConfig

object

Configure logging on this NAT.
items.routers[].nats[].logConfig.enable

boolean

Indicates whether or not to export logs. This is false by default.
items.routers[].nats[].logConfig.filter

enum

Specify the desired filtering of logs on this NAT. If unspecified, logs are exported for all connections handled by this NAT. This option can take one of the following values:

  • ERRORS_ONLY: Export logs only for connection failures.
  • TRANSLATIONS_ONLY: Export logs only for successful connections.
  • ALL: Export logs for all connections, successful and unsuccessful.
items.routers[].nats[].rules[]

object

A list of rules associated with this NAT.
items.routers[].nats[].rules[].ruleNumber

integer (uint32 format)

An integer uniquely identifying a rule in the list. The rule number must be a positive value between 0 and 65000, and must be unique among rules within a NAT.
items.routers[].nats[].rules[].description

string

An optional description of this rule.
items.routers[].nats[].rules[].match

string

CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding action is enforced.

The following examples are valid match expressions for public NAT:

inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')

destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'

The following example is a valid match expression for private NAT:

nexthop.hub == '//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1'
items.routers[].nats[].rules[].action

object

The action to be enforced for traffic that matches this rule.
items.routers[].nats[].rules[].action.sourceNatActiveIps[]

string

A list of URLs of the IP resources used for this NAT rule. These IP addresses must be valid static external IP addresses assigned to the project. This field is used for public NAT.
items.routers[].nats[].rules[].action.sourceNatDrainIps[]

string

A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT rule only. This field is used for public NAT.
items.routers[].nats[].rules[].action.sourceNatActiveRanges[]

string

A list of URLs of the subnetworks used as source ranges for this NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT. This field is used for private NAT.
items.routers[].nats[].rules[].action.sourceNatDrainRanges[]

string

A list of URLs of subnetworks representing source ranges to be drained. This is only supported on patch/update, and these subnetworks must have previously been used as active ranges in this NAT Rule. This field is used for private NAT.
items.routers[].nats[].enableEndpointIndependentMapping

boolean
items.routers[].encryptedInterconnectRouter

boolean

Indicates if a router is dedicated for use with encrypted VLAN attachments (interconnectAttachments).
items.routers[].md5AuthenticationKeys[]

object

Keys used for MD5 authentication.
items.routers[].md5AuthenticationKeys[].name

string

Name used to identify the key.

Must be unique within a router. Must be referenced by exactly one bgpPeer. Must comply with RFC1035.
items.routers[].md5AuthenticationKeys[].key

string

[Input only] Value of the key.

For patch and update calls, it can be skipped to copy the value from the previous configuration. This is allowed if the key with the same name existed before the operation. Maximum length is 80 characters. Can only contain printable ASCII characters.
items.warning

object

Informational warning which replaces the list of routers when the list is empty.
items.warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
items.warning.message

string

[Output Only] A human-readable description of the warning code.
items.warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: 

"data": [  {  "key": "scope",  "value": "zones/us-east1-d"  }
items.warning.data[].key

string

[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 scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
items.warning.data[].value

string

[Output Only] A warning data value corresponding to the key.
nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
warning

object

[Output Only] Informational warning message.
warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
warning.message

string

[Output Only] A human-readable description of the warning code.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: 

"data": [  {  "key": "scope",  "value": "zones/us-east1-d"  }
warning.data[].key

string

[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 scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
warning.data[].value

string

[Output Only] A warning data value corresponding to the key.
unreachables[]

string

[Output Only] Unreachable resources.

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.list

To find predefined roles that contain those permissions, see Compute Engine IAM Roles.