Console
    Contact Us Start free

    Method: routes.list

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

    HTTP request

    GET https://compute.googleapis.com/compute/beta/projects/{project}/global/routes

    The URL uses gRPC Transcoding syntax. To know more about valid error responses that can be thrown by this HTTP request, please refer to the service error catalog

    Path parameters

    Parameters
    project

    string

    Project ID for this request.

    Query parameters

    Parameters
    maxResults

    integer ( uint32 format)

    The maximum number of results per page that should be returned. If the number of available results is larger than maxResults , Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500 , inclusive. (Default: 500 )
    pageToken

    string

    Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
    filter

    string

    A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160 . These two types of filter expressions cannot be mixed in one request.

    If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either = , != , > , < , <= , >= or : .

    For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance .

    The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use:

     labels.owner:*

    You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels .

    To filter on multiple expressions, provide each separate expression within parentheses. For example:

     (scheduling.automaticRestart = true)
(cpuPlatform = "Intel Skylake")

    By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example:

     (cpuPlatform = "Intel Skylake") OR
(cpuPlatform = "Intel Broadwell") AND
(scheduling.automaticRestart = true)

    If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples:

    fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal")

    The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field.

    For example, to filter for instances that do not end with name "instance", you would use name ne .*instance .

    You cannot combine constraints on multiple fields using regular expressions.
    orderBy

    string

    Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

    You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc" . This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

    Currently, only sorting by name or creationTimestamp desc is supported.
    returnPartialSuccess

    boolean

    Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

    For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

    Request body

    The request body must be empty.

    Response body

    Contains a list of Route resources.

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

    JSON representation 
     { 
 "kind" 
 : 
 string 
 , 
 "id" 
 : 
 string 
 , 
 "items" 
 : 
 [ 
 { 
 "kind" 
 : 
 string 
 , 
 "id" 
 : 
 string 
 , 
 "creationTimestamp" 
 : 
 string 
 , 
 "name" 
 : 
 string 
 , 
 "description" 
 : 
 string 
 , 
 "network" 
 : 
 string 
 , 
 "tags" 
 : 
 [ 
 string 
 ] 
 , 
 "destRange" 
 : 
 string 
 , 
 "priority" 
 : 
 integer 
 , 
 "nextHopInstance" 
 : 
 string 
 , 
 "nextHopIp" 
 : 
 string 
 , 
 "nextHopNetwork" 
 : 
 string 
 , 
 "nextHopGateway" 
 : 
 string 
 , 
 "nextHopPeering" 
 : 
 string 
 , 
 "nextHopIlb" 
 : 
 string 
 , 
 "warnings" 
 : 
 [ 
 { 
 "code" 
 : 
 enum 
 , 
 "message" 
 : 
 string 
 , 
 "data" 
 : 
 [ 
 { 
 "key" 
 : 
 string 
 , 
 "value" 
 : 
 string 
 } 
 ] 
 } 
 ] 
 , 
 "nextHopVpnTunnel" 
 : 
 string 
 , 
 "nextHopHub" 
 : 
 string 
 , 
 "nextHopInterconnectAttachment" 
 : 
 string 
 , 
 "selfLink" 
 : 
 string 
 , 
 "routeType" 
 : 
 enum 
 , 
 "asPaths" 
 : 
 [ 
 { 
 "pathSegmentType" 
 : 
 enum 
 , 
 "asLists" 
 : 
 [ 
 integer 
 ] 
 } 
 ] 
 , 
 "routeStatus" 
 : 
 enum 
 , 
 "nextHopOrigin" 
 : 
 enum 
 , 
 "nextHopMed" 
 : 
 integer 
 , 
 "nextHopInterRegionCost" 
 : 
 integer 
 , 
 "params" 
 : 
 { 
 "resourceManagerTags" 
 : 
 { 
 string 
 : 
 string 
 , 
 ... 
 } 
 } 
 } 
 ] 
 , 
 "nextPageToken" 
 : 
 string 
 , 
 "selfLink" 
 : 
 string 
 , 
 "warning" 
 : 
 { 
 "code" 
 : 
 enum 
 , 
 "message" 
 : 
 string 
 , 
 "data" 
 : 
 [ 
 { 
 "key" 
 : 
 string 
 , 
 "value" 
 : 
 string 
 } 
 ] 
 } 
 }
    Fields
    kind

    string

    Type of resource.

    id

    string

    [Output Only] Unique identifier for the resource; defined by the server.

    items[]

    object

    A list of Route resources.

    items[].kind

    string

    [Output Only] Type of this resource. Always compute#routes for Route resources.

    items[].id

    string ( uint64 format)

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

    items[].creationTimestamp

    string

    [Output Only] Creation timestamp in RFC3339 text format.

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

    items[].description

    string

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

    items[].network

    string

    Fully-qualified URL of the network that this route applies to.

    items[].tags[]

    string

    A list of instance tags to which this route applies.

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

    items[].priority

    integer ( uint32 format)

    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.

    items[].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/

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

    items[].nextHopNetwork

    string

    The URL of the local network if it should handle matching packets.

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

    items[].nextHopPeering

    string

    [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.

    items[].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:

    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.
    items[].warnings[]

    object

    [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.

    items[].warnings[].code

    enum

    [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

    items[].warnings[].message

    string

    [Output Only] A human-readable description of the warning code.

    items[].warnings[].data[]

    object

    [Output Only] Metadata about this warning in key: value format. For example:

    "data": [  {  "key": "scope",  "value": "zones/us-east1-d"  }
    items[].warnings[].data[].key

    string

    [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

    items[].warnings[].data[].value

    string

    [Output Only] A warning data value corresponding to the key.

    items[].nextHopVpnTunnel

    string

    The URL to a VpnTunnel that should handle matching packets.

    items[].nextHopHub

    string

    [Output Only] The full resource name of the Network Connectivity Center hub that will handle matching packets.

    items[].nextHopInterconnectAttachment

    string

    [Output Only] The URL to an InterconnectAttachment which is the next hop for the route. This field will only be populated for dynamic routes generated by Cloud Router with a linked interconnectAttachment or the static route generated by each L2 Interconnect Attachment.

    items[].selfLink

    string

    [Output Only] Server-defined fully-qualified URL for this resource.

    items[].routeType

    enum

    [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
    • items[].asPaths[]

    object

    [Output Only] AS path.

    items[].asPaths[].pathSegmentType

    enum

    [Output Only] The type of the AS Path, which can be one of the following values:

  • 'AS_SET': unordered set of autonomous systems that the route in has traversed
  • 'AS_SEQUENCE': ordered set of autonomous systems that the route has traversed
  • 'AS_CONFED_SEQUENCE': ordered set of Member Autonomous Systems in the local confederation that the route has traversed
  • 'AS_CONFED_SET': unordered set of Member Autonomous Systems in the local confederation that the route has traversed
    • items[].asPaths[].asLists[]

    integer

    [Output Only] The AS numbers of the AS Path.

    items[].routeStatus

    enum

    [Output only] The status of the route. This status only applies to dynamic routes learned by Cloud Routers. This status is not applicable to static routes.

    items[].nextHopOrigin

    enum

    [Output Only] Indicates the origin of the route. Can be IGP (Interior Gateway Protocol), EGP (Exterior Gateway Protocol), or INCOMPLETE .

    items[].nextHopMed

    integer ( uint32 format)

    [Output Only] Multi-Exit Discriminator, a BGP route metric that indicates the desirability of a particular route in a network.

    items[].nextHopInterRegionCost

    integer ( uint32 format)

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

    items[].params

    object

    Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.

    items[].params.resourceManagerTags

    map (key: string, value: string)

    Tag keys/values directly bound to this resource. Tag keys and values have the same definition as resource manager tags . The field is allowed for INSERT only. The keys/values to set on the resource should be specified in either ID { : } or Namespaced format { : }. For example the following are valid inputs: * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"} * {"123/environment" : "production", "345/abc" : "xyz"} Note: * Invalid combinations of ID & namespaced format is not supported. For instance: {"123/environment" : "tagValues/444"} is invalid.

    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.

    warning

    object

    [Output Only] Informational warning message.

    warning.code

    enum

    [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

    warning.message

    string

    [Output Only] A human-readable description of the warning code.

    warning.data[]

    object

    [Output Only] Metadata about this warning in key: value format. For example:

    "data": [  {  "key": "scope",  "value": "zones/us-east1-d"  }
    warning.data[].key

    string

    [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

    warning.data[].value

    string

    [Output Only] A warning data value corresponding to the key.

    Authorization scopes

    Requires one of the following OAuth scopes:

    • https://www.googleapis.com/auth/compute.readonly
    • 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 IAM permissions:

    • compute.routes.list

    To find predefined roles that contain those permissions, see Compute Engine IAM Roles .
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: