Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-131,0021,0174.3 MB
routes

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

post/projects/{project}/global/routes

Path parameters

projectstring required

Project ID for this request.

Query parameters

requestIdstring

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Request body

networkstring

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

destRangestring

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.

selfLinkstring

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

nextHopGatewaystring

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

nextHopIlbstring

The URL to a forwarding rule of typeloadBalancingScheme=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.

routeStatus'ACTIVE' | 'DROPPED' | 'INACTIVE' | 'PENDING'

[Output only] The status of the route. This status applies to dynamic routes learned by Cloud Routers. It is also applicable to routes undergoing migration.

descriptionstring

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

nextHopInstancestring

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/

nextHopNetworkstring

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

nextHopInterconnectAttachmentstring

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

routeType'BGP' | 'STATIC' | 'SUBNET' | 'TRANSIT'

Output only. [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
kindstring

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

nextHopHubstring

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

tagsstring[]

A list of instance tags to which this route applies.

nextHopIpstring

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.

idstring uint64

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

nextHopVpnTunnelstring

The URL to a VpnTunnel that should handle matching packets.

priorityinteger

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.

nextHopMedinteger

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

creationTimestampstring

Output only. [Output Only] Creation timestamp inRFC3339 text format.

nextHopPeeringstring

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

namestring

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. 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.

nextHopOrigin'EGP' | 'IGP' | 'INCOMPLETE'

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

nextHopInterRegionCostinteger

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

Response

Successful response