REST Resource: routers

Resource: Router

Represents a Cloud Router resource.

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

JSON representation 
{
  "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": integer,
      "advertisedRoutePriority": integer,
      "advertiseMode": enum,
      "advertisedGroups": [
        enum
      ],
      "advertisedIpRanges": [
        {
          "range": string,
          "description": string
        }
      ],
      "managementType": enum
    }
  ],
  "bgp": {
    "asn": integer,
    "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
      ],
      "drainNatIps": [
        string
      ],
      "natIpAllocateOption": enum,
      "minPortsPerVm": integer,
      "udpIdleTimeoutSec": integer,
      "icmpIdleTimeoutSec": integer,
      "tcpEstablishedIdleTimeoutSec": integer,
      "tcpTransitoryIdleTimeoutSec": integer,
      "logConfig": {
        "enable": boolean,
        "filter": enum
      }
    }
  ],
  "kind": string
}
Fields
id

string (fixed64 format)

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

string

[Output Only] Creation timestamp in RFC3339 text format.
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.
description

string

An optional description of this resource. Provide this property when you create the 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.
network

string

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

object

Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both.
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.
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[].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[].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[].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.
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.
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.
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[].peerIpAddress

string

IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.
bgpPeers[].peerAsn

integer (uint32 format)

Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.
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.
bgpPeers[].advertiseMode

enum

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

enum

User-specified list of prefix groups to advertise in custom mode, which can take one of the following options:

  • ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets.
  • ALL_VPC_SUBNETS: Advertises the router's own VPC subnets.
  • ALL_PEER_VPC_SUBNETS: Advertises peer subnets of the router's VPC network.
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.
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.
bgpPeers[].advertisedIpRanges[].range

string

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

string

User-specified description for the IP range.
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.
bgp

object

BGP information specific to this router.
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.
bgp.advertiseMode

enum

User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM.
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.
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.
bgp.advertisedIpRanges[].range

string

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

string

User-specified description for the IP range.
nats[]

object

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

string

Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.
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 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

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

string

URL for the subnetwork resource that will use NAT.
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]
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.
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.
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.
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.
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[].udpIdleTimeoutSec

integer

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

integer

Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.
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[].logConfig

object

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

boolean

Indicates whether or not to export logs. This is false by default.
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.
kind

string

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

Methods

aggregatedList

 Retrieves an aggregated list of routers.

delete

 Deletes the specified Router resource.

get

 Returns the specified Router resource.

getNatMappingInfo

 Retrieves runtime Nat mapping information of VM endpoints.

getRouterStatus

 Retrieves runtime information of the specified router.

insert

 Creates a Router resource in the specified project and region using the data included in the request.

list

 Retrieves a list of Router resources available to the specified project.

patch

 Patches the specified Router resource with the data included in the request.

preview

 Preview fields auto-generated during router create and update operations.

update

 Updates the specified Router resource with the data included in the request.