- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Retrieves the list of Route resources available to the specified project.
HTTP request
GET https://compute.googleapis.com/compute/v1/projects/{project}/global/routes
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
Project ID for this request. |
Query parameters
Parameters | |
---|---|
maxResults |
The maximum number of results per page that should be returned. If the number of available results is larger than |
pageToken |
Specifies a page token to use. Set |
filter |
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 For example, if you are filtering Compute Engine instances, you can exclude instances named The
You can also filter nested fields. For example, you could specify To filter on multiple expressions, provide each separate expression within parentheses. For example:
By default, each expression is an
If you want to use a regular expression, use the
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 You cannot combine constraints on multiple fields using regular expressions. |
orderBy |
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 Currently, only sorting by |
returnPartialSuccess |
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, "selfLink": string, "routeType": enum, "asPaths": [ { "pathSegmentType": enum, "asLists": [ integer ] } ], "routeStatus": enum } ], "nextPageToken": string, "selfLink": string, "warning": { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] } } |
Fields | |
---|---|
kind |
Type of resource. |
id |
[Output Only] Unique identifier for the resource; defined by the server. |
items[] |
A list of Route resources. |
items[].kind |
[Output Only] Type of this resource. Always |
items[].id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
items[].creationTimestamp |
[Output Only] Creation timestamp in RFC3339 text format. |
items[].name |
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 |
items[].description |
An optional description of this resource. Provide this field when you create the resource. |
items[].network |
Fully-qualified URL of the network that this route applies to. |
items[].tags[] |
A list of instance tags to which this route applies. |
items[].destRange |
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 |
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 |
items[].nextHopInstance |
The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: |
items[].nextHopIp |
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 |
The URL of the local network if it should handle matching packets. |
items[].nextHopGateway |
The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: |
items[].nextHopPeering |
[Output Only] The network peering name that should handle matching packets, which should conform to RFC1035. |
items[].nextHopIlb |
The URL to a forwarding rule of type
|
items[].warnings[] |
[Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages. |
items[].warnings[].code |
[Output Only] A warning code, if applicable. For example, Compute Engine returns |
items[].warnings[].message |
[Output Only] A human-readable description of the warning code. |
items[].warnings[].data[] |
[Output Only] Metadata about this warning in "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
items[].warnings[].data[].key |
[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 |
items[].warnings[].data[].value |
[Output Only] A warning data value corresponding to the key. |
items[].nextHopVpnTunnel |
The URL to a VpnTunnel that should handle matching packets. |
items[].nextHopHub |
[Output Only] The full resource name of the Network Connectivity Center hub that will handle matching packets. |
items[].selfLink |
[Output Only] Server-defined fully-qualified URL for this resource. |
items[].routeType |
[Output Only] The type of this route, which can be one of the following values: |
items[].asPaths[] |
[Output Only] AS path. |
items[].asPaths[].pathSegmentType |
[Output Only] The type of the AS Path, which can be one of the following values: |
items[].asPaths[].asLists[] |
[Output Only] The AS numbers of the AS Path. |
items[].routeStatus |
[Output only] The status of the route. |
nextPageToken |
[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than |
selfLink |
[Output Only] Server-defined URL for this resource. |
warning |
[Output Only] Informational warning message. |
warning.code |
[Output Only] A warning code, if applicable. For example, Compute Engine returns |
warning.message |
[Output Only] A human-readable description of the warning code. |
warning.data[] |
[Output Only] Metadata about this warning in "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
warning.data[].key |
[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 |
warning.data[].value |
[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.