REST Resource: routers

Resource: Router
- JSON representation
Methods

Resource: Router

Router resource.

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": 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 }

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": 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
}

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 (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
`interfaces[].name`	`string` Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
`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.
`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.
`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.
`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.
`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.
`bgpPeers[].name`	`string` Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
`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. Only IPv4 is supported.
`bgpPeers[].peerAsn`	`number (uint32 format)` Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
`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.
`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. 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.
`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.
`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 will automatically create, update, and delete this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted.
`bgp`	`object` BGP information specific to this router.
`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.
`bgp.advertiseMode`	`enum` User-specified flag to indicate which mode to use for advertisement.
`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.
`selfLink`	`string` [Output Only] Server-defined URL for the resource.
`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. 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 to use NAT.
`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]
`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 IPs must be valid static external IP addresses assigned to the project. maxLength is subject to change post alpha.
`nats[].natIpAllocateOption`	`enum` Specify the NatIpAllocateOption. If it is AUTO_ONLY, then natIp should be empty.
`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.
`nats[].udpIdleTimeoutSec`	`number` Timeout (in seconds) for UDP connections. Defaults to 30s if not set.
`nats[].icmpIdleTimeoutSec`	`number` Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.
`nats[].tcpEstablishedIdleTimeoutSec`	`number` Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set.
`nats[].tcpTransitoryIdleTimeoutSec`	`number` Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.
`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.

Was this page helpful? Let us know how we did:

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.0 License, and code samples are licensed under the Apache 2.0 License. For details, see our Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated February 14, 2019.

REST Resource: routers

Resource: Router

Methods

`aggregatedList`

`delete`

`get`

`getNatMappingInfo`

`getRouterStatus`

`insert`

`list`

`patch`

`preview`

`update`

Send feedback about...