project STRING Required

Project ID for this request

region STRING Required

Name of the region for this request

router STRING Required

Name of the Router resource to patch

requestId STRING

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)

bgp OBJECT

bgp.advertiseMode ENUMERATION

User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM

bgp.advertisedGroups[] ENUMERATION

bgp.advertisedIpRanges[] OBJECT

Description-tagged IP ranges for the router to advertise

bgp.advertisedIpRanges[].description STRING

User-specified description for the IP range

bgp.advertisedIpRanges[].range STRING

The IP range to advertise. The value must be a CIDR-formatted string

bgp.asn INTEGER

Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN

bgpPeers[] OBJECT

bgpPeers[].advertiseMode ENUMERATION

User-specified flag to indicate which mode to use for advertisement

bgpPeers[].advertisedGroups[] ENUMERATION

bgpPeers[].advertisedIpRanges[] OBJECT

Description-tagged IP ranges for the router to advertise

bgpPeers[].advertisedIpRanges[].description STRING

User-specified description for the IP range

bgpPeers[].advertisedIpRanges[].range STRING

The IP range to advertise. The value must be a CIDR-formatted string

bgpPeers[].advertisedRoutePriority INTEGER

The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win

bgpPeers[].interfaceName STRING

Name of the interface the BGP peer is associated with

bgpPeers[].ipAddress STRING

IP address of the interface inside Google Cloud Platform. Only IPv4 is supported

bgpPeers[].managementType ENUMERATION

[Output Only] The resource that configures and manages this BGP peer.

• MANAGED_BY_USER is the default value and can be managed by you or other users
• MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted.

bgpPeers[].name STRING

Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035

bgpPeers[].peerAsn INTEGER

Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value

bgpPeers[].peerIpAddress STRING

IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported

creationTimestamp STRING

[Output Only] Creation timestamp in RFC3339 text format

description STRING

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

id INTEGER

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

interfaces[] OBJECT

interfaces[].ipRange STRING

IP address and range of the interface. The IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface

interfaces[].linkedInterconnectAttachment STRING

URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be either be a VPN tunnel or an Interconnect attachment

interfaces[].linkedVpnTunnel STRING

URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be either a VPN tunnel or an Interconnect attachment

interfaces[].managementType ENUMERATION

[Output Only] The resource that configures and manages this interface.

• MANAGED_BY_USER is the default value and can be managed directly by users.
• MANAGED_BY_ATTACHMENT is an interface that is configured and managed by Cloud Interconnect, specifically, by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of interface when the PARTNER InterconnectAttachment is created, updated, or deleted.

interfaces[].name STRING

Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035

kind STRING

[Output Only] Type of resource. Always compute#router for routers

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 [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash

nats[] OBJECT

Represents a Nat resource. It enables the VMs within the specified subnetworks to access Internet without external IP addresses. It specifies a list of subnetworks (and the ranges within) that want to use NAT. Customers can also provide the external IPs that would be used for NAT. GCP would auto-allocate ephemeral IPs if no external IPs are provided

nats[].icmpIdleTimeoutSec INTEGER

Timeout (in seconds) for ICMP connections. Defaults to 30s if not set

nats[].logConfig OBJECT

Configuration of logging on a NAT

nats[].logConfig.enable BOOLEAN

Indicates whether or not to export logs. This is false by default

nats[].logConfig.filter ENUMERATION

Specifies the desired filtering of logs on this NAT. If unspecified, logs are exported for all connections handled by this NAT

nats[].minPortsPerVm INTEGER

Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. This is rounded up to the nearest power of 2. For example, if the value of this field is 50, at least 64 ports are allocated to a VM

nats[].name STRING

Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035

nats[].natIpAllocateOption ENUMERATION

Specify the NatIpAllocateOption, which can take one of the following values:

• MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there are not enough specified Nat IPs, the Nat service fails for new VMs.
• AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should be empty.

nats[].natIps[] STRING

nats[].sourceSubnetworkIpRangesToNat ENUMERATION

Specify the Nat option, which can take one of the following values:

• ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat.
• ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat.
• LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field subnetwork below) The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, then there should not be any other Router.Nat section in any Router for this network in this region.

nats[].subnetworks[] OBJECT

Defines the IP ranges that want to use NAT for a subnetwork

nats[].subnetworks[].name STRING

URL for the subnetwork resource that will use NAT

nats[].subnetworks[].secondaryIpRangeNames[] STRING

nats[].subnetworks[].sourceIpRangesToNat[] ENUMERATION

nats[].tcpEstablishedIdleTimeoutSec INTEGER

Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set

nats[].tcpTransitoryIdleTimeoutSec INTEGER

Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set

nats[].udpIdleTimeoutSec INTEGER

Timeout (in seconds) for UDP connections. Defaults to 30s if not set

network STRING

URI of the network to which this router belongs

region STRING

[Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body

selfLink STRING

[Output Only] Server-defined URL for the resource

clientOperationId STRING

[Output Only] The value of requestId if you provided it in the request. Not present otherwise

creationTimestamp STRING

[Deprecated] This field is deprecated

description STRING

[Output Only] A textual description of the operation, which is set when the operation is created

endTime STRING

[Output Only] The time that this operation was completed. This value is in RFC3339 text format

error OBJECT

[Output Only] If errors are generated during processing of the operation, this field will be populated

error.errors[] OBJECT

error.errors[].code STRING

[Output Only] The error type identifier for this error

error.errors[].location STRING

[Output Only] Indicates the field in the request that caused the error. This property is optional

error.errors[].message STRING

[Output Only] An optional, human-readable error message

httpErrorMessage STRING

[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND

httpErrorStatusCode INTEGER

[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found

id INTEGER

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

insertTime STRING

[Output Only] The time that this operation was requested. This value is in RFC3339 text format

kind STRING

[Output Only] Type of the resource. Always compute#operation for Operation resources

name STRING

[Output Only] Name of the resource

operationType STRING

[Output Only] The type of operation, such as insert, update, or delete, and so on

progress INTEGER

[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses

region STRING

[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations

selfLink STRING

[Output Only] Server-defined URL for the resource

startTime STRING

[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format

status ENUMERATION

[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE

statusMessage STRING

[Output Only] An optional textual description of the current status of the operation

targetId INTEGER

[Output Only] The unique target ID, which identifies a specific incarnation of the target resource

targetLink STRING

[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from

user STRING

[Output Only] User who requested the operation, for example: [email protected]

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

zone STRING

[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations