routes

Creates, updates, deletes, gets or lists a routes resource.

Overview

Name	routes
Type	Resource
Id	google.compute.routes

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
id	string (uint64)	[Output Only] The unique identifier for the resource. This identifier is defined by the server.
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])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. (pattern: a-z?)
asPaths	array	[Output Only] AS path.
creationTimestamp	string	[Output Only] Creation timestamp in RFC3339 text format.
description	string	An optional description of this resource. Provide this field when you create the resource.
destRange	string	The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported. Must specify an IPv4 range (e.g. 192.0.2.0/24) or an IPv6 range in RFC 4291 format (e.g. 2001:db8::/32). IPv6 range will be displayed using RFC 5952 compressed format.
kind	string	[Output Only] Type of this resource. Always compute#routes for Route resources. (default: compute#route)
network	string	Fully-qualified URL of the network that this route applies to.
nextHopGateway	string	The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/ project/global/gateways/default-internet-gateway
nextHopHub	string	[Output Only] The full resource name of the Network Connectivity Center hub that will handle matching packets.
nextHopIlb	string	The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule If an IP address is provided, must specify an IPv4 address in dot-decimal notation or an IPv6 address in RFC 4291 format. For example, the following are all valid IP addresses: - 10.128.0.56 - 2001:db8::2d9:51:0:0 - 2001:db8:0:0:2d9:51:0:0 IPv6 addresses will be displayed using RFC 5952 compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address.
nextHopInstance	string	The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
nextHopInterRegionCost	integer (uint32)	[Output only] Internal fixed region-to-region cost that Google Cloud calculates based on factors such as network performance, distance, and available bandwidth between regions.
nextHopIp	string	The network IP address of an instance that should handle matching packets. Both IPv6 address and IPv4 addresses are supported. Must specify an IPv4 address in dot-decimal notation (e.g. 192.0.2.99) or an IPv6 address in RFC 4291 format (e.g. 2001:db8::2d9:51:0:0 or 2001:db8:0:0:2d9:51:0:0). IPv6 addresses will be displayed using RFC 5952 compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address.
nextHopMed	integer (uint32)	[Output Only] Multi-Exit Discriminator, a BGP route metric that indicates the desirability of a particular route in a network.
nextHopNetwork	string	The URL of the local network if it should handle matching packets.
nextHopOrigin	string	[Output Only] Indicates the origin of the route. Can be IGP (Interior Gateway Protocol), EGP (Exterior Gateway Protocol), or INCOMPLETE.
nextHopPeering	string	[Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.
nextHopVpnTunnel	string	The URL to a VpnTunnel that should handle matching packets.
params	object	Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. (id: RouteParams)
priority	integer (uint32)	The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is 1000. The priority value must be from 0 to 65535, inclusive.
routeStatus	string	[Output only] The status of the route.
routeType	string	[Output Only] The type of this route, which can be one of the following values: - 'TRANSIT' for a transit route that this router learned from another Cloud Router and will readvertise to one of its BGP peers - 'SUBNET' for a route from a subnet of the VPC - 'BGP' for a route learned from a BGP peer of this router - 'STATIC' for a static route
selfLink	string	[Output Only] Server-defined fully-qualified URL for this resource.
tags	array	A list of instance tags to which this route applies.
warnings	array	[Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.

list

Successful response

Name	Datatype	Description
id	string	[Output Only] Unique identifier for the resource; defined by the server.
items	array	A list of Route resources.
kind	string	Type of resource. (default: compute#routeList)
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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	project, route		Returns the specified Route resource.
list	select	project	filter, maxResults, orderBy, pageToken, returnPartialSuccess	Retrieves the list of Route resources available to the specified project.
insert	insert	project	requestId	Creates a Route resource in the specified project using the data included in the request.
delete	delete	project, route	requestId	Deletes the specified Route resource.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
project	string
route	string
filter	string
maxResults	integer (uint32)
orderBy	string
pageToken	string
requestId	string
returnPartialSuccess	boolean

SELECT examples

get

Returns the specified Route resource.

SELECT
id,
name,
asPaths,
creationTimestamp,
description,
destRange,
kind,
network,
nextHopGateway,
nextHopHub,
nextHopIlb,
nextHopInstance,
nextHopInterRegionCost,
nextHopIp,
nextHopMed,
nextHopNetwork,
nextHopOrigin,
nextHopPeering,
nextHopVpnTunnel,
params,
priority,
routeStatus,
routeType,
selfLink,
tags,
warnings
FROM google.compute.routes
WHERE project = '{{ project }}' -- required
AND route = '{{ route }}' -- required;

list

Retrieves the list of Route resources available to the specified project.

SELECT
id,
items,
kind,
nextPageToken,
selfLink,
warning
FROM google.compute.routes
WHERE project = '{{ project }}' -- required
AND filter = '{{ filter }}'
AND maxResults = '{{ maxResults }}'
AND orderBy = '{{ orderBy }}'
AND pageToken = '{{ pageToken }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}';

INSERT examples

insert

Creates a Route resource in the specified project using the data included in the request.

INSERT INTO google.compute.routes (
data__kind,
data__id,
data__creationTimestamp,
data__name,
data__description,
data__network,
data__tags,
data__destRange,
data__priority,
data__nextHopInstance,
data__nextHopIp,
data__nextHopNetwork,
data__nextHopGateway,
data__nextHopPeering,
data__nextHopIlb,
data__warnings,
data__nextHopVpnTunnel,
data__nextHopHub,
data__selfLink,
data__routeType,
data__asPaths,
data__routeStatus,
data__nextHopOrigin,
data__nextHopMed,
data__nextHopInterRegionCost,
data__params,
project,
requestId
)
SELECT 
'{{ kind }}',
'{{ id }}',
'{{ creationTimestamp }}',
'{{ name }}',
'{{ description }}',
'{{ network }}',
'{{ tags }}',
'{{ destRange }}',
{{ priority }},
'{{ nextHopInstance }}',
'{{ nextHopIp }}',
'{{ nextHopNetwork }}',
'{{ nextHopGateway }}',
'{{ nextHopPeering }}',
'{{ nextHopIlb }}',
'{{ warnings }}',
'{{ nextHopVpnTunnel }}',
'{{ nextHopHub }}',
'{{ selfLink }}',
'{{ routeType }}',
'{{ asPaths }}',
'{{ routeStatus }}',
'{{ nextHopOrigin }}',
{{ nextHopMed }},
{{ nextHopInterRegionCost }},
'{{ params }}',
'{{ project }}',
'{{ requestId }}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone
;

Manifest

# Description fields are for documentation purposes
- name: routes
  props:
    - name: project
      value: string
      description: Required parameter for the routes resource.
    - name: kind
      value: string
      description: >
        [Output Only] Type of this resource. Always compute#routes for Route resources.
        
      default: compute#route
    - name: id
      value: string
      description: >
        [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        
    - name: creationTimestamp
      value: string
      description: >
        [Output Only] Creation timestamp in RFC3339 text format.
        
    - name: name
      value: string
      description: >
        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])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.
        
    - name: description
      value: string
      description: >
        An optional description of this resource. Provide this field when you create the resource.
        
    - name: network
      value: string
      description: >
        Fully-qualified URL of the network that this route applies to.
        
    - name: tags
      value: array
      description: >
        A list of instance tags to which this route applies.
        
    - name: destRange
      value: string
      description: >
        The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported. Must specify an IPv4 range (e.g. 192.0.2.0/24) or an IPv6 range in RFC 4291 format (e.g. 2001:db8::/32). IPv6 range will be displayed using RFC 5952 compressed format.
        
    - name: priority
      value: integer
      description: >
        The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is `1000`. The priority value must be from `0` to `65535`, inclusive.
        
    - name: nextHopInstance
      value: string
      description: >
        The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
        
    - name: nextHopIp
      value: string
      description: >
        The network IP address of an instance that should handle matching packets. Both IPv6 address and IPv4 addresses are supported. Must specify an IPv4 address in dot-decimal notation (e.g. 192.0.2.99) or an IPv6 address in RFC 4291 format (e.g. 2001:db8::2d9:51:0:0 or 2001:db8:0:0:2d9:51:0:0). IPv6 addresses will be displayed using RFC 5952 compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address.
        
    - name: nextHopNetwork
      value: string
      description: >
        The URL of the local network if it should handle matching packets.
        
    - name: nextHopGateway
      value: string
      description: >
        The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/ project/global/gateways/default-internet-gateway
        
    - name: nextHopPeering
      value: string
      description: >
        [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.
        
    - name: nextHopIlb
      value: string
      description: >
        The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule If an IP address is provided, must specify an IPv4 address in dot-decimal notation or an IPv6 address in RFC 4291 format. For example, the following are all valid IP addresses: - 10.128.0.56 - 2001:db8::2d9:51:0:0 - 2001:db8:0:0:2d9:51:0:0 IPv6 addresses will be displayed using RFC 5952 compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address.
        
    - name: warnings
      value: array
      description: >
        [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
        
    - name: nextHopVpnTunnel
      value: string
      description: >
        The URL to a VpnTunnel that should handle matching packets.
        
    - name: nextHopHub
      value: string
      description: >
        [Output Only] The full resource name of the Network Connectivity Center hub that will handle matching packets.
        
    - name: selfLink
      value: string
      description: >
        [Output Only] Server-defined fully-qualified URL for this resource.
        
    - name: routeType
      value: string
      description: >
        [Output Only] The type of this route, which can be one of the following values: - 'TRANSIT' for a transit route that this router learned from another Cloud Router and will readvertise to one of its BGP peers - 'SUBNET' for a route from a subnet of the VPC - 'BGP' for a route learned from a BGP peer of this router - 'STATIC' for a static route
        
      valid_values: ['BGP', 'STATIC', 'SUBNET', 'TRANSIT']
    - name: asPaths
      value: array
      description: >
        [Output Only] AS path.
        
    - name: routeStatus
      value: string
      description: >
        [Output only] The status of the route.
        
      valid_values: ['ACTIVE', 'DROPPED', 'INACTIVE', 'PENDING']
    - name: nextHopOrigin
      value: string
      description: >
        [Output Only] Indicates the origin of the route. Can be IGP (Interior Gateway Protocol), EGP (Exterior Gateway Protocol), or INCOMPLETE.
        
      valid_values: ['EGP', 'IGP', 'INCOMPLETE']
    - name: nextHopMed
      value: integer
      description: >
        [Output Only] Multi-Exit Discriminator, a BGP route metric that indicates the desirability of a particular route in a network.
        
    - name: nextHopInterRegionCost
      value: integer
      description: >
        [Output only] Internal fixed region-to-region cost that Google Cloud calculates based on factors such as network performance, distance, and available bandwidth between regions.
        
    - name: params
      value: object
      description: >
        Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
        
    - name: requestId
      value: string

DELETE examples

delete

Deletes the specified Route resource.

DELETE FROM google.compute.routes
WHERE project = '{{ project }}' --required
AND route = '{{ route }}' --required
AND requestId = '{{ requestId }}';