Resource: Route
Represents a Route resource.
A route defines a path from VM instances in the VPC network to a specific destination. This destination can be inside or outside the VPC network. For more information, read the Routes overview.
JSON representation |
---|
{ "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 } |
Fields | |
---|---|
kind |
[Output Only] Type of this resource. Always |
id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
creationTimestamp |
[Output Only] Creation timestamp in RFC3339 text format. |
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 |
description |
An optional description of this resource. Provide this field when you create the resource. |
network |
Fully-qualified URL of the network that this route applies to. |
tags[] |
A list of instance tags to which this route applies. |
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. |
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 |
nextHopInstance |
The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: |
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. |
nextHopNetwork |
The URL of the local network if it should handle matching packets. |
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: |
nextHopPeering |
[Output Only] The network peering name that should handle matching packets, which should conform to RFC1035. |
nextHopIlb |
The URL to a forwarding rule of type
|
warnings[] |
[Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages. |
warnings[].code |
[Output Only] A warning code, if applicable. For example, Compute Engine returns |
warnings[].message |
[Output Only] A human-readable description of the warning code. |
warnings[].data[] |
[Output Only] Metadata about this warning in "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
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 |
warnings[].data[].value |
[Output Only] A warning data value corresponding to the key. |
nextHopVpnTunnel |
The URL to a VpnTunnel that should handle matching packets. |
nextHopHub |
[Output Only] The full resource name of the Network Connectivity Center hub that will handle matching packets. |
selfLink |
[Output Only] Server-defined fully-qualified URL for this resource. |
routeType |
[Output Only] The type of this route, which can be one of the following values: |
asPaths[] |
[Output Only] AS path. |
asPaths[].pathSegmentType |
[Output Only] The type of the AS Path, which can be one of the following values: |
asPaths[].asLists[] |
[Output Only] The AS numbers of the AS Path. |
routeStatus |
[Output only] The status of the route. |
Methods |
|
---|---|
|
Deletes the specified Route resource. |
|
Returns the specified Route resource. |
|
Creates a Route resource in the specified project using the data included in the request. |
|
Retrieves the list of Route resources available to the specified project. |