Get
|
|||||
|
|
Returns the specified Route resource. Gets a list of available routes by making a list() request
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your data across Google Cloud Platform services
- View and manage your Google Compute Engine resources
- View your Google Compute Engine resources
Input
This building block consumes 2 input parameters
Name | Format | Description |
---|---|---|
project Required |
STRING |
Project ID for this request |
route Required |
STRING |
Name of the Route resource to return |
= Parameter name
= Format
project STRING Required Project ID for this request |
route STRING Required Name of the Route resource to return |
Output
This building block provides 22 output parameters
Name | Format | Description |
---|---|---|
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. Only IPv4 is supported |
id |
INTEGER |
[Output Only] The unique identifier for the resource. This identifier is defined by the server |
kind |
STRING |
[Output Only] Type of this resource. Always compute#routes for Route resources |
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 |
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 |
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/ |
nextHopIp |
STRING |
The network IP address of an instance that should handle matching packets. Only IPv4 is supported |
nextHopNetwork |
STRING |
The URL of the local network if it should handle matching packets |
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 |
priority |
INTEGER |
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 |
selfLink |
STRING |
[Output Only] Server-defined fully-qualified URL for this resource |
tags[] |
STRING |
|
warnings[] |
OBJECT |
|
warnings[].code |
ENUMERATION |
[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response |
warnings[].data[] |
OBJECT |
|
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) |
warnings[].data[].value |
STRING |
[Output Only] A warning data value corresponding to the key |
warnings[].message |
STRING |
[Output Only] A human-readable description of the warning code |
= Parameter name
= Format
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. Only IPv4 is supported |
id INTEGER [Output Only] The unique identifier for the resource. This identifier is defined by the server |
kind STRING [Output Only] Type of this resource. Always compute#routes for Route resources |
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 |
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 |
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/ |
nextHopIp STRING The network IP address of an instance that should handle matching packets. Only IPv4 is supported |
nextHopNetwork STRING The URL of the local network if it should handle matching packets |
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 |
priority INTEGER 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 |
selfLink STRING [Output Only] Server-defined fully-qualified URL for this resource |
tags[] STRING |
warnings[] OBJECT |
warnings[].code ENUMERATION [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response |
warnings[].data[] OBJECT |
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) |
warnings[].data[].value STRING [Output Only] A warning data value corresponding to the key |
warnings[].message STRING [Output Only] A human-readable description of the warning code |