List

Retrieves a list of Router resources available to the specified project

6 variables
51 variables

Retrieves a list of Router resources available to the specified project

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • View and manage your data across Google Cloud Platform services
  • View and manage your Google Compute Engine resources
  • View your Google Compute Engine resources

Input

This building block consumes 6 input parameters

  = Parameter name
  = Format

project STRING Required

Project ID for this request

region STRING Required

Name of the region for this request

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)

maxResults INTEGER

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)

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

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

Output

This building block provides 51 output parameters

  = Parameter name
  = Format

id STRING

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

items[] OBJECT

Represents a Cloud Router resource.

For more information about Cloud Router, read the the Cloud Router overview

items[].bgp OBJECT

items[].bgp.advertiseMode ENUMERATION

User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM

items[].bgp.advertisedGroups[] ENUMERATION

items[].bgp.advertisedIpRanges[] OBJECT

Description-tagged IP ranges for the router to advertise

items[].bgp.asn INTEGER

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[].bgpPeers[] OBJECT

items[].bgpPeers[].advertiseMode ENUMERATION

User-specified flag to indicate which mode to use for advertisement

items[].bgpPeers[].advertisedGroups[] ENUMERATION

items[].bgpPeers[].advertisedRoutePriority INTEGER

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[].bgpPeers[].interfaceName STRING

Name of the interface the BGP peer is associated with

items[].bgpPeers[].ipAddress STRING

IP address of the interface inside Google Cloud Platform. Only IPv4 is supported

items[].bgpPeers[].managementType ENUMERATION

[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[].bgpPeers[].name STRING

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

items[].bgpPeers[].peerAsn INTEGER

Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value

items[].bgpPeers[].peerIpAddress STRING

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

items[].creationTimestamp STRING

[Output Only] Creation timestamp in RFC3339 text format

items[].description STRING

An optional description of this resource. Provide this property when you create the resource

items[].id INTEGER

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

items[].interfaces[] OBJECT

items[].interfaces[].ipRange STRING

IP address and range of the interface. 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 address as it represents the IP address of the interface

items[].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 either be a VPN tunnel or an Interconnect attachment

items[].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 either a VPN tunnel or an Interconnect attachment

items[].interfaces[].managementType ENUMERATION

[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[].interfaces[].name STRING

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

items[].kind STRING

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

items[].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[].nats[] OBJECT

Represents a Nat resource. It enables the VMs within the specified subnetworks to access Internet without external IP addresses. It specifies a list of subnetworks (and the ranges within) that want to use NAT. Customers can also provide the external IPs that would be used for NAT. GCP would auto-allocate ephemeral IPs if no external IPs are provided

items[].nats[].icmpIdleTimeoutSec INTEGER

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

items[].nats[].logConfig OBJECT

Configuration of logging on a NAT

items[].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[].nats[].name STRING

Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035

items[].nats[].natIpAllocateOption ENUMERATION

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 nat_ip should be empty.

items[].nats[].natIps[] STRING

items[].nats[].sourceSubnetworkIpRangesToNat ENUMERATION

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 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[].nats[].tcpEstablishedIdleTimeoutSec INTEGER

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

items[].nats[].tcpTransitoryIdleTimeoutSec INTEGER

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

items[].nats[].udpIdleTimeoutSec INTEGER

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

items[].network STRING

URI of the network to which this router belongs

items[].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[].selfLink STRING

[Output Only] Server-defined URL for the resource

kind STRING

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

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

selfLink STRING

[Output Only] Server-defined URL for this resource

warning OBJECT

[Output Only] Informational warning message

warning.code ENUMERATION

[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.data[] OBJECT

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

warning.message STRING

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