Method: routers.aggregatedList

Retrieves an aggregated list of routers.

HTTP request

GET https://www.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

number (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. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison 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.

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

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.

Request body

The request body must be empty.

Response body

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

Contains a list of routers.

JSON representation
{
  "id": string,
  "items": [
    {
      "scopeName": string,
      "routers": [
        {
          "id": string,
          "creationTimestamp": string,
          "name": string,
          "description": string,
          "region": string,
          "network": string,
          "interfaces": [
            {
              "name": string,
              "linkedVpnTunnel": string,
              "linkedInterconnectAttachment": string,
              "ipRange": string,
              "managementType": enum
            }
          ],
          "bgpPeers": [
            {
              "name": string,
              "interfaceName": string,
              "ipAddress": string,
              "peerIpAddress": string,
              "peerAsn": number,
              "advertisedRoutePriority": number,
              "advertiseMode": enum,
              "advertisedGroups": [
                enum
              ],
              "advertisedIpRanges": [
                {
                  "range": string,
                  "description": string
                }
              ],
              "managementType": enum
            }
          ],
          "bgp": {
            "asn": number,
            "advertiseMode": enum,
            "advertisedGroups": [
              enum
            ],
            "advertisedIpRanges": [
              {
                "range": string,
                "description": string
              }
            ]
          },
          "selfLink": string,
          "nats": [
            {
              "name": string,
              "sourceSubnetworkIpRangesToNat": enum,
              "subnetworks": [
                {
                  "name": string,
                  "sourceIpRangesToNat": [
                    enum
                  ],
                  "secondaryIpRangeNames": [
                    string
                  ]
                }
              ],
              "natIps": [
                string
              ],
              "natIpAllocateOption": enum,
              "minPortsPerVm": number,
              "udpIdleTimeoutSec": number,
              "icmpIdleTimeoutSec": number,
              "tcpEstablishedIdleTimeoutSec": number,
              "tcpTransitoryIdleTimeoutSec": number
            }
          ],
          "kind": 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
      }
    ]
  },
  "kind": string
}
Fields
id

string

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

items[]

object

A list of Router resources.

items[].scopeName

string

Name of the scope containing this set of routers.

items[].routers[]

object

A list of routers contained in this scope.

items[].routers[].id

string (fixed64 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. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.

items[].routers[].interfaces[].name

string

Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.

items[].routers[].interfaces[].linkedVpnTunnel

string

URI of the linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource and it could either be a VPN Tunnel or an interconnect attachment.

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 at most one linked resource and it could either be a VPN Tunnel or an interconnect attachment.

items[].routers[].interfaces[].ipRange

string

IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.

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 by you or other users; MANAGED_BY_ATTACHMENT is an interface that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google will automatically create, update, and delete this type of interface when the PARTNER InterconnectAttachment is created, updated, or deleted.

items[].routers[].bgpPeers[]

object

BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. 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.

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. Only IPv4 is supported.

items[].routers[].bgpPeers[].peerIpAddress

string

IP address of the BGP interface outside Google cloud. Only IPv4 is supported.

items[].routers[].bgpPeers[].peerAsn

number (uint32 format)

Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.

items[].routers[].bgpPeers[].advertisedRoutePriority

number (uint32 format)

The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with 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. This field can only be populated if advertiseMode is CUSTOM and overrides the list defined for the router (in Bgp message). These groups will be 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 Bgp message). These IP ranges will be 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 will automatically create, update, and delete this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted.

items[].routers[].bgp

object

BGP information specific to this router.

items[].routers[].bgp.asn

number (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.

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[].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[].sourceSubnetworkIpRangesToNat

enum

Specify the Nat option. If this field contains ALL_SUBNETWORKS_ALL_IP_RANGES or ALL_SUBNETWORKS_ALL_PRIMARY_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 to use NAT.

items[].routers[].nats[].subnetworks[].sourceIpRangesToNat[]

enum

Specify the options for NAT ranges in the Subnetwork. All usages of 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 IPs must be valid static external IP addresses assigned to the project. maxLength is subject to change post alpha.

items[].routers[].nats[].natIpAllocateOption

enum

Specify the NatIpAllocateOption. If it is AUTO_ONLY, then natIp should be empty.

items[].routers[].nats[].minPortsPerVm

number

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 gets rounded up to the nearest power of 2. Eg. if the value of this field is 50, at least 64 ports will be allocated to a VM.

items[].routers[].nats[].udpIdleTimeoutSec

number

Timeout (in seconds) for UDP connections. Defaults to 30s if not set.

items[].routers[].nats[].icmpIdleTimeoutSec

number

Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.

items[].routers[].nats[].tcpEstablishedIdleTimeoutSec

number

Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set.

items[].routers[].nats[].tcpTransitoryIdleTimeoutSec

number

Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.

items[].routers[].kind

string

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

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.

kind

string

Type of resource.

Authorization Scopes

Requires one of the following OAuth scopes:

  • 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 Google IAM permissions:

  • compute.routers.list
Was this page helpful? Let us know how we did:

Send feedback about...

Compute Engine