project STRING Required

Project ID for this request

region STRING Required

Name of the region for this request

router STRING Required

Name of the Router resource to query

bgp OBJECT

bgp.advertiseMode ENUMERATION

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

bgp.advertisedGroups[] ENUMERATION

bgp.advertisedIpRanges[] OBJECT

Description-tagged IP ranges for the router to advertise

bgp.advertisedIpRanges[].description STRING

User-specified description for the IP range

bgp.advertisedIpRanges[].range STRING

The IP range to advertise. The value must be a CIDR-formatted string

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

bgpPeers[] OBJECT

bgpPeers[].advertiseMode ENUMERATION

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

bgpPeers[].advertisedGroups[] ENUMERATION

bgpPeers[].advertisedIpRanges[] OBJECT

Description-tagged IP ranges for the router to advertise

bgpPeers[].advertisedIpRanges[].description STRING

User-specified description for the IP range

bgpPeers[].advertisedIpRanges[].range STRING

The IP range to advertise. The value must be a CIDR-formatted string

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

bgpPeers[].interfaceName STRING

Name of the interface the BGP peer is associated with

bgpPeers[].ipAddress STRING

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

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.

bgpPeers[].name STRING

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

bgpPeers[].peerAsn INTEGER

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

bgpPeers[].peerIpAddress STRING

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

creationTimestamp STRING

[Output Only] Creation timestamp in RFC3339 text format

description STRING

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

id INTEGER

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

interfaces[] OBJECT

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

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

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

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.

interfaces[].name STRING

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

kind STRING

[Output Only] Type of resource. Always compute#router for 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

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

nats[].icmpIdleTimeoutSec INTEGER

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

nats[].logConfig OBJECT

Configuration of logging on a NAT

nats[].logConfig.enable BOOLEAN

Indicates whether or not to export logs. This is false by default

nats[].logConfig.filter ENUMERATION

Specifies the desired filtering of logs on this NAT. If unspecified, logs are exported for all connections handled by this NAT

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

nats[].name STRING

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

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.

nats[].natIps[] STRING

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.

nats[].subnetworks[] OBJECT

Defines the IP ranges that want to use NAT for a subnetwork

nats[].subnetworks[].name STRING

URL for the subnetwork resource that will use NAT

nats[].subnetworks[].secondaryIpRangeNames[] STRING

nats[].subnetworks[].sourceIpRangesToNat[] ENUMERATION

nats[].tcpEstablishedIdleTimeoutSec INTEGER

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

nats[].tcpTransitoryIdleTimeoutSec INTEGER

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

nats[].udpIdleTimeoutSec INTEGER

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

network STRING

URI of the network to which this router belongs

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

selfLink STRING

[Output Only] Server-defined URL for the resource

resource OBJECT

Represents a Cloud Router resource.

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

resource.bgp OBJECT

resource.bgp.advertiseMode ENUMERATION

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

resource.bgp.advertisedGroups[] ENUMERATION

resource.bgp.advertisedIpRanges[] OBJECT

Description-tagged IP ranges for the router to advertise

resource.bgp.advertisedIpRanges[].description STRING

User-specified description for the IP range

resource.bgp.advertisedIpRanges[].range STRING

The IP range to advertise. The value must be a CIDR-formatted string

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

resource.bgpPeers[] OBJECT

resource.bgpPeers[].advertiseMode ENUMERATION

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

resource.bgpPeers[].advertisedGroups[] ENUMERATION

resource.bgpPeers[].advertisedIpRanges[] OBJECT

Description-tagged IP ranges for the router to advertise

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

resource.bgpPeers[].interfaceName STRING

Name of the interface the BGP peer is associated with

resource.bgpPeers[].ipAddress STRING

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

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

resource.bgpPeers[].name STRING

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

resource.bgpPeers[].peerAsn INTEGER

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

resource.bgpPeers[].peerIpAddress STRING

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

resource.creationTimestamp STRING

[Output Only] Creation timestamp in RFC3339 text format

resource.description STRING

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

resource.id INTEGER

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

resource.interfaces[] OBJECT

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

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

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

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

resource.interfaces[].name STRING

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

resource.kind STRING

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

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

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

resource.nats[].icmpIdleTimeoutSec INTEGER

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

resource.nats[].logConfig OBJECT

Configuration of logging on a NAT

resource.nats[].logConfig.enable BOOLEAN

Indicates whether or not to export logs. This is false by default

resource.nats[].logConfig.filter ENUMERATION

Specifies the desired filtering of logs on this NAT. If unspecified, logs are exported for all connections handled by this NAT

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

resource.nats[].name STRING

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

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

resource.nats[].natIps[] STRING

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

resource.nats[].subnetworks[] OBJECT

Defines the IP ranges that want to use NAT for a subnetwork

resource.nats[].tcpEstablishedIdleTimeoutSec INTEGER

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

resource.nats[].tcpTransitoryIdleTimeoutSec INTEGER

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

resource.nats[].udpIdleTimeoutSec INTEGER

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

resource.network STRING

URI of the network to which this router belongs

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

resource.selfLink STRING

[Output Only] Server-defined URL for the resource