Method: routers.preview

routers.preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.

HTTP request

POST https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/routers/{resourceId}/preview

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID for this request.

region

string

Name of the region for this request.

resourceId

string

Name of the Router resource to query.

Request body

The request body contains data with the following structure:

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": [
        
      ],
      "managementType": enum
    }
  ],
  "bgp": {
    "asn": number,
    "advertiseMode": enum,
    "advertisedGroups": [
      enum
    ],
    "advertisedIpRanges": [
      
    ]
  },
  "selfLink": string,
  "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] Type of how the resource/configuration of the interface is managed. MANAGED_BY_USER is the default value; MANAGED_BY_ATTACHMENT represents an interface that is automatically created for PARTNER type interconnectAttachment, Google will automatically create/update/delete this type of interface when the PARTNER interconnectAttachment is created/provisioned/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] Type of how the resource/configuration of the BGP peer is managed. MANAGED_BY_USER is the default value; MANAGED_BY_ATTACHMENT represents an BGP peer that is automatically created for PARTNER interconnectAttachment, Google will automatically create/delete this type of BGP peer when the PARTNER interconnectAttachment is created/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.

kind

string

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

Response body

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

JSON representation
{
  "resource": {
    "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,
    "kind": string
  }
}
Fields
resource

object

routers.preview of given router.

resource.id

string (fixed64 format)

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

resource.creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

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

string

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

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

string

URI of the network to which this router belongs.

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

resource.interfaces[].name

string

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

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

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

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

resource.interfaces[].managementType

enum

[Output Only] Type of how the resource/configuration of the interface is managed. MANAGED_BY_USER is the default value; MANAGED_BY_ATTACHMENT represents an interface that is automatically created for PARTNER type interconnectAttachment, Google will automatically create/update/delete this type of interface when the PARTNER interconnectAttachment is created/provisioned/deleted.

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

resource.bgpPeers[].name

string

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

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

string

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

resource.bgpPeers[].peerAsn

number (uint32 format)

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

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

resource.bgpPeers[].advertiseMode

enum

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

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

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

resource.bgpPeers[].advertisedIpRanges[].range

string

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

resource.bgpPeers[].advertisedIpRanges[].description

string

User-specified description for the IP range.

resource.bgpPeers[].managementType

enum

[Output Only] Type of how the resource/configuration of the BGP peer is managed. MANAGED_BY_USER is the default value; MANAGED_BY_ATTACHMENT represents an BGP peer that is automatically created for PARTNER interconnectAttachment, Google will automatically create/delete this type of BGP peer when the PARTNER interconnectAttachment is created/deleted.

resource.bgp

object

BGP information specific to this router.

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

resource.bgp.advertiseMode

enum

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

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

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

resource.bgp.advertisedIpRanges[].range

string

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

resource.bgp.advertisedIpRanges[].description

string

User-specified description for the IP range.

resource.selfLink

string

[Output Only] Server-defined URL for the resource.

resource.kind

string

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

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.get
Was this page helpful? Let us know how we did:

Send feedback about...

Compute Engine