Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1348107211.1 KB
projects

Create a GatewayAdvertisedRoute

post/v1/{+parent}/gatewayAdvertisedRoutes

Path parameters

parentstring required

Required. The parent resource.

Query parameters

gatewayAdvertisedRouteIdstring

Required. Unique id for the route to create.

requestIdstring

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. 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 to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly 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

ipRangestring

Immutable. This route's advertised IP address range. Must be a valid CIDR-formatted prefix. If an IP address is provided without a subnet mask, it is interpreted as, for IPv4, a /32 singular IP address range, and, for IPv6, /128.

createTimestring google-datetime

Output only. The time the gateway advertised route was created.

recipient'RECIPIENT_UNSPECIFIED' | 'ADVERTISE_TO_HUB'

Optional. The recipient of this advertised route.

descriptionstring

An optional description of the gateway advertised route.

priorityinteger

Optional. The priority of this advertised route. You can choose a value from 0 to 65335. If you don't provide a value, Google Cloud assigns a priority of 100 to the ranges.

updateTimestring google-datetime

Output only. The time the gateway advertised route was last updated.

state'STATE_UNSPECIFIED' | 'CREATING' | 'ACTIVE' | 'DELETING' | 'ACCEPTING' | 'REJECTING' | 'UPDATING' | 'INACTIVE' | 'OBSOLETE' | 'FAILED'

Output only. The current lifecycle state of this gateway advertised route.

namestring

Identifier. The name of the gateway advertised route. Route names must be unique and use the following form: projects/{project_number}/locations/{region}/spokes/{spoke}/gatewayAdvertisedRoutes/{gateway_advertised_route_id}

labelsobject

Optional labels in key-value pair format. For more information about labels, see Requirements for labels.

uniqueIdstring

Output only. The Google-generated UUID for the gateway advertised route. This value is unique across all gateway advertised route resources. If a gateway advertised route is deleted and another with the same name is created, the new route is assigned a different unique_id.

Response

Successful response