Method: routers.patch

HTTP request
Path parameters
Query parameters
Request body
- JSON representation
Response body
- JSON representation
Authorization scopes
IAM Permissions
Try it!

Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

HTTP request

PATCH https://compute.googleapis.com/compute/beta/projects/{project}/regions/{region}/routers/{router}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

Parameters
`project`	`string` Project ID for this request.
`region`	`string` Name of the region for this request.
`router`	`string` Name of the Router resource to patch.

project

string

Project ID for this request.

region

string

Name of the region for this request.

router

string

Name of the Router resource to patch.

Query parameters

Parameters

Parameters
`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`).

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).

Request body

The request body contains data with the following structure:

JSON representation
{ "kind": string, "id": string, "creationTimestamp": string, "name": string, "description": string, "region": string, "network": string, "interfaces": [ { "name": string, "linkedVpnTunnel": string, "linkedInterconnectAttachment": string, "ipRange": string, "managementType": enum, "privateIpAddress": string, "redundantInterface": string, "subnetwork": string, "ipVersion": enum } ], "bgpPeers": [ { "name": string, "interfaceName": string, "ipAddress": string, "peerIpAddress": string, "peerAsn": integer, "advertisedRoutePriority": integer, "advertiseMode": enum, "advertisedGroups": [ enum ], "advertisedIpRanges": [ { "range": string, "description": string } ], "managementType": enum, "enable": enum, "bfd": { "sessionInitializationMode": enum, "minTransmitInterval": integer, "minReceiveInterval": integer, "multiplier": integer }, "routerApplianceInstance": string, "enableIpv6": boolean, "ipv6NexthopAddress": string, "peerIpv6NexthopAddress": string, "md5AuthenticationKeyName": string, "customLearnedRoutePriority": integer, "customLearnedIpRanges": [ { "range": string } ], "enableIpv4": boolean, "ipv4NexthopAddress": string, "peerIpv4NexthopAddress": string, "exportPolicies": [ string ], "importPolicies": [ string ] } ], "bgp": { "asn": integer, "advertiseMode": enum, "advertisedGroups": [ enum ], "advertisedIpRanges": [ { "range": string, "description": string } ], "keepaliveInterval": integer, "identifierRange": string }, "selfLink": string, "nats": [ { "name": string, "type": enum, "autoNetworkTier": enum, "endpointTypes": [ enum ], "sourceSubnetworkIpRangesToNat": enum, "subnetworks": [ { "name": string, "sourceIpRangesToNat": [ enum ], "secondaryIpRangeNames": [ string ] } ], "sourceSubnetworkIpRangesToNat64": enum, "nat64Subnetworks": [ { "name": string } ], "natIps": [ string ], "drainNatIps": [ string ], "natIpAllocateOption": enum, "minPortsPerVm": integer, "maxPortsPerVm": integer, "enableDynamicPortAllocation": boolean, "udpIdleTimeoutSec": integer, "icmpIdleTimeoutSec": integer, "tcpEstablishedIdleTimeoutSec": integer, "tcpTransitoryIdleTimeoutSec": integer, "tcpTimeWaitTimeoutSec": integer, "logConfig": { "enable": boolean, "filter": enum }, "rules": [ { "ruleNumber": integer, "description": string, "match": string, "action": { "sourceNatActiveIps": [ string ], "sourceNatDrainIps": [ string ], "sourceNatActiveRanges": [ string ], "sourceNatDrainRanges": [ string ] } } ], "enableEndpointIndependentMapping": boolean } ], "encryptedInterconnectRouter": boolean, "md5AuthenticationKeys": [ { "name": string, "key": string } ] }

JSON representation

{
  "kind": string,
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "region": string,
  "network": string,
  "interfaces": [
    {
      "name": string,
      "linkedVpnTunnel": string,
      "linkedInterconnectAttachment": string,
      "ipRange": string,
      "managementType": enum,
      "privateIpAddress": string,
      "redundantInterface": string,
      "subnetwork": string,
      "ipVersion": enum
    }
  ],
  "bgpPeers": [
    {
      "name": string,
      "interfaceName": string,
      "ipAddress": string,
      "peerIpAddress": string,
      "peerAsn": integer,
      "advertisedRoutePriority": integer,
      "advertiseMode": enum,
      "advertisedGroups": [
        enum
      ],
      "advertisedIpRanges": [
        {
          "range": string,
          "description": string
        }
      ],
      "managementType": enum,
      "enable": enum,
      "bfd": {
        "sessionInitializationMode": enum,
        "minTransmitInterval": integer,
        "minReceiveInterval": integer,
        "multiplier": integer
      },
      "routerApplianceInstance": string,
      "enableIpv6": boolean,
      "ipv6NexthopAddress": string,
      "peerIpv6NexthopAddress": string,
      "md5AuthenticationKeyName": string,
      "customLearnedRoutePriority": integer,
      "customLearnedIpRanges": [
        {
          "range": string
        }
      ],
      "enableIpv4": boolean,
      "ipv4NexthopAddress": string,
      "peerIpv4NexthopAddress": string,
      "exportPolicies": [
        string
      ],
      "importPolicies": [
        string
      ]
    }
  ],
  "bgp": {
    "asn": integer,
    "advertiseMode": enum,
    "advertisedGroups": [
      enum
    ],
    "advertisedIpRanges": [
      {
        "range": string,
        "description": string
      }
    ],
    "keepaliveInterval": integer,
    "identifierRange": string
  },
  "selfLink": string,
  "nats": [
    {
      "name": string,
      "type": enum,
      "autoNetworkTier": enum,
      "endpointTypes": [
        enum
      ],
      "sourceSubnetworkIpRangesToNat": enum,
      "subnetworks": [
        {
          "name": string,
          "sourceIpRangesToNat": [
            enum
          ],
          "secondaryIpRangeNames": [
            string
          ]
        }
      ],
      "sourceSubnetworkIpRangesToNat64": enum,
      "nat64Subnetworks": [
        {
          "name": string
        }
      ],
      "natIps": [
        string
      ],
      "drainNatIps": [
        string
      ],
      "natIpAllocateOption": enum,
      "minPortsPerVm": integer,
      "maxPortsPerVm": integer,
      "enableDynamicPortAllocation": boolean,
      "udpIdleTimeoutSec": integer,
      "icmpIdleTimeoutSec": integer,
      "tcpEstablishedIdleTimeoutSec": integer,
      "tcpTransitoryIdleTimeoutSec": integer,
      "tcpTimeWaitTimeoutSec": integer,
      "logConfig": {
        "enable": boolean,
        "filter": enum
      },
      "rules": [
        {
          "ruleNumber": integer,
          "description": string,
          "match": string,
          "action": {
            "sourceNatActiveIps": [
              string
            ],
            "sourceNatDrainIps": [
              string
            ],
            "sourceNatActiveRanges": [
              string
            ],
            "sourceNatDrainRanges": [
              string
            ]
          }
        }
      ],
      "enableEndpointIndependentMapping": boolean
    }
  ],
  "encryptedInterconnectRouter": boolean,
  "md5AuthenticationKeys": [
    {
      "name": string,
      "key": string
    }
  ]
}

Fields
`kind`	`string` [Output Only] Type of resource. Always `compute#router` for routers.
`id`	`string (uint64 format)` [Output Only] The unique identifier for the resource. This identifier is defined by the server.
`creationTimestamp`	`string` [Output Only] Creation timestamp in RFC3339 text format.
`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.
`description`	`string` An optional description of this resource. Provide this property when you create the resource.
`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.
`network`	`string` URI of the network to which this router belongs. Authorization requires the following IAM permission on the specified resource `network`: `compute.networks.updatePolicy`
`interfaces[]`	`object` Router interfaces. To create a BGP peer that uses a router interface, the interface must have one of the following fields specified: linkedVpnTunnel linkedInterconnectAttachment subnetwork You can create a router interface without any of these fields specified. However, you cannot create a BGP peer that uses that interface.
`interfaces[].name`	`string` Name of this interface entry. 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.
`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 a VPN tunnel, an Interconnect attachment, or a subnetwork.
`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 a VPN tunnel, an Interconnect attachment, or a subnetwork.
`interfaces[].ipRange`	`string` IP address and range of the interface. For Internet Protocol version 4 (IPv4), 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 IP address, as it represents the IP address of the interface. For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from `fdff:1::/64` with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, `fc00:0:1:1::1/112`. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose.
`interfaces[].managementType`	`enum` [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[].privateIpAddress`	`string` The regional private internal IP address that is used to establish BGP sessions to a VM instance acting as a third-party Router Appliance, such as a Next Gen Firewall, a Virtual Router, or an SD-WAN VM.
`interfaces[].redundantInterface`	`string` Name of the interface that will be redundant with the current interface you are creating. The redundantInterface must belong to the same Cloud Router as the interface here. To establish the BGP session to a Router Appliance VM, you must create two BGP peers. The two BGP peers must be attached to two separate interfaces that are redundant with each other. The redundantInterface must be 1-63 characters long, and comply with RFC1035. Specifically, the redundantInterface 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.
`interfaces[].subnetwork`	`string` The URI of the subnetwork resource that this interface belongs to, which must be in the same region as the Cloud Router. When you establish a BGP session to a VM instance using this interface, the VM instance must belong to the same subnetwork as the subnetwork specified here.
`interfaces[].ipVersion`	`enum` IP version of this interface.
`bgpPeers[]`	`object` BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273.
`bgpPeers[].name`	`string` Name of this BGP peer. 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.
`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.
`bgpPeers[].peerIpAddress`	`string` IP address of the BGP interface outside Google Cloud Platform.
`bgpPeers[].peerAsn`	`integer (uint32 format)` Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.
`bgpPeers[].advertisedRoutePriority`	`integer (uint32 format)` 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[].advertiseMode`	`enum` User-specified flag to indicate which mode to use for advertisement.
`bgpPeers[].advertisedGroups[]`	`enum` User-specified list of prefix groups to advertise in custom mode, which currently supports the following option: ALL_SUBNETS: Advertises all of the router's own VPC subnets. This excludes any routes learned for subnets that use VPC Network Peering. Note that this field can only be populated if advertiseMode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These groups are advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.
`bgpPeers[].advertisedIpRanges[]`	`object` User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertiseMode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These IP ranges are advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.
`bgpPeers[].advertisedIpRanges[].range`	`string` The IP range to advertise. The value must be a CIDR-formatted string.
`bgpPeers[].advertisedIpRanges[].description`	`string` User-specified description for the IP range.
`bgpPeers[].managementType`	`enum` [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[].enable`	`enum` The status of the BGP peer connection. If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE.
`bgpPeers[].bfd`	`object` BFD configuration for the BGP peering.
`bgpPeers[].bfd.sessionInitializationMode`	`enum` The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is DISABLED.
`bgpPeers[].bfd.minTransmitInterval`	`integer (uint32 format)` The minimum interval, in milliseconds, between BFD control packets transmitted to the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the corresponding receive interval of the other router. If set, this value must be between 1000 and 30000. The default is 1000.
`bgpPeers[].bfd.minReceiveInterval`	`integer (uint32 format)` The minimum interval, in milliseconds, between BFD control packets received from the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the transmit interval of the other router. If set, this value must be between 1000 and 30000. The default is 1000.
`bgpPeers[].bfd.multiplier`	`integer (uint32 format)` The number of consecutive BFD packets that must be missed before BFD declares that a peer is unavailable. If set, the value must be a value between 5 and 16. The default is 5.
`bgpPeers[].routerApplianceInstance`	`string` URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances. The VM instance must be located in zones contained in the same region as this Cloud Router. The VM instance is the peer side of the BGP session.
`bgpPeers[].enableIpv6`	`boolean` Enable IPv6 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 6.
`bgpPeers[].ipv6NexthopAddress`	`string` IPv6 address of the interface inside Google Cloud Platform.
`bgpPeers[].peerIpv6NexthopAddress`	`string` IPv6 address of the BGP interface outside Google Cloud Platform.
`bgpPeers[].md5AuthenticationKeyName`	`string` Present if MD5 authentication is enabled for the peering. Must be the name of one of the entries in the Router.md5_authentication_keys. The field must comply with RFC1035.
`bgpPeers[].customLearnedRoutePriority`	`integer` The user-defined custom learned route priority for a BGP session. This value is applied to all custom learned route ranges for the session. 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.
`bgpPeers[].customLearnedIpRanges[]`	`object` A list of user-defined custom learned route IP address ranges for a BGP session.
`bgpPeers[].customLearnedIpRanges[].range`	`string` The custom learned route 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`.
`bgpPeers[].enableIpv4`	`boolean` Enable IPv4 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 4.
`bgpPeers[].ipv4NexthopAddress`	`string` IPv4 address of the interface inside Google Cloud Platform.
`bgpPeers[].peerIpv4NexthopAddress`	`string` IPv4 address of the BGP interface outside Google Cloud Platform.
`bgpPeers[].exportPolicies[]`	`string` routers.list of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies.
`bgpPeers[].importPolicies[]`	`string` routers.list of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies.
`bgp`	`object` BGP information specific to this router.
`bgp.asn`	`integer (uint32 format)` 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.
`bgp.advertiseMode`	`enum` User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM.
`bgp.advertisedGroups[]`	`enum` User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertiseMode is CUSTOM and is advertised to all peers of the router. These groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.
`bgp.advertisedIpRanges[]`	`object` User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertiseMode is CUSTOM and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.
`bgp.advertisedIpRanges[].range`	`string` The IP range to advertise. The value must be a CIDR-formatted string.
`bgp.advertisedIpRanges[].description`	`string` User-specified description for the IP range.
`bgp.keepaliveInterval`	`integer (uint32 format)` The interval in seconds between BGP keepalive messages that are sent to the peer. Hold time is three times the interval at which keepalive messages are sent, and the hold time is the maximum number of seconds allowed to elapse between successive keepalive messages that BGP receives from a peer. BGP will use the smaller of either the local hold time value or the peer's hold time value as the hold time for the BGP connection between the two peers. If set, this value must be between 20 and 60. The default is 20.
`bgp.identifierRange`	`string` Explicitly specifies a range of valid BGP Identifiers for this Router. It is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at least /30, even if the BGP sessions are over IPv6. It must not overlap with any IPv4 BGP session ranges. Other vendors commonly call this "router ID".
`selfLink`	`string` [Output Only] Server-defined URL for the resource.
`nats[]`	`object` A list of NAT services created in this router.
`nats[].name`	`string` Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.
`nats[].type`	`enum` Indicates whether this NAT is used for public or private IP translation. If unspecified, it defaults to PUBLIC.
`nats[].autoNetworkTier`	`enum` The network tier to use when automatically reserving NAT IP addresses. Must be one of: PREMIUM, STANDARD. If not specified, then the current project-level default tier is used.
`nats[].endpointTypes[]`	`enum` routers.list of NAT-ted endpoint types supported by the Nat Gateway. If the list is empty, then it will be equivalent to include ENDPOINT_TYPE_VM
`nats[].sourceSubnetworkIpRangesToNat`	`enum` 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 then there should not be any other Router.Nat section in any Router for this network in this region.
`nats[].subnetworks[]`	`object` A list of Subnetwork resources whose traffic should be translated by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the SubnetworkIpRangeToNatOption above.
`nats[].subnetworks[].name`	`string` URL for the subnetwork resource that will use NAT.
`nats[].subnetworks[].sourceIpRangesToNat[]`	`enum` Specify the options for NAT ranges in the Subnetwork. All options of a single value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. The only valid option with multiple values is: ["PRIMARY_IP_RANGE", "LIST_OF_SECONDARY_IP_RANGES"] Default: [ALL_IP_RANGES]
`nats[].subnetworks[].secondaryIpRangeNames[]`	`string` A list of the secondary ranges of the Subnetwork that are allowed to use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES" is one of the values in sourceIpRangesToNat.
`nats[].sourceSubnetworkIpRangesToNat64`	`enum` Specify the Nat option for NAT64, which can take one of the following values: ALL_IPV6_SUBNETWORKS: All of the IP ranges in every Subnetwork are allowed to Nat. LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field nat64Subnetwork below) The default is NAT64_OPTION_UNSPECIFIED. Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other Router.Nat section in this region can also enable NAT64 for any Subnetworks in this network. Other Router.Nat sections can still be present to enable NAT44 only.
`nats[].nat64Subnetworks[]`	`object` routers.list of Subnetwork resources whose traffic should be translated by NAT64 Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is selected for the SubnetworkIpRangeToNat64Option above.
`nats[].nat64Subnetworks[].name`	`string` URL for the subnetwork resource that will use NAT64.
`nats[].natIps[]`	`string` A list of URLs of the IP resources used for this Nat service. These IP addresses must be valid static external IP addresses assigned to the project.
`nats[].drainNatIps[]`	`string` A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT only.
`nats[].natIpAllocateOption`	`enum` 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 natIp should be empty.
`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[].maxPortsPerVm`	`integer` Maximum number of ports allocated to a VM from this NAT config when Dynamic Port Allocation is enabled. If Dynamic Port Allocation is not enabled, this field has no effect. If Dynamic Port Allocation is enabled, and this field is set, it must be set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm is not set. If Dynamic Port Allocation is enabled and this field is not set, a maximum of 65536 ports will be allocated to a VM from this NAT config.
`nats[].enableDynamicPortAllocation`	`boolean` Enable Dynamic Port Allocation. If not specified, it is disabled by default. If set to true, Dynamic Port Allocation will be enabled on this NAT config. enableEndpointIndependentMapping cannot be set to true. If minPorts is set, minPortsPerVm must be set to a power of two greater than or equal to 32. If minPortsPerVm is not set, a minimum of 32 ports will be allocated to a VM from this NAT config.
`nats[].udpIdleTimeoutSec`	`integer` Timeout (in seconds) for UDP connections. Defaults to 30s if not set.
`nats[].icmpIdleTimeoutSec`	`integer` Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.
`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[].tcpTimeWaitTimeoutSec`	`integer` Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults to 120s if not set.
`nats[].logConfig`	`object` Configure logging on this NAT.
`nats[].logConfig.enable`	`boolean` Indicates whether or not to export logs. This is false by default.
`nats[].logConfig.filter`	`enum` Specify the desired filtering of logs on this NAT. If unspecified, logs are exported for all connections handled by this NAT. This option can take one of the following values: ERRORS_ONLY: Export logs only for connection failures. TRANSLATIONS_ONLY: Export logs only for successful connections. ALL: Export logs for all connections, successful and unsuccessful.
`nats[].rules[]`	`object` A list of rules associated with this NAT.
`nats[].rules[].ruleNumber`	`integer (uint32 format)` An integer uniquely identifying a rule in the list. The rule number must be a positive value between 0 and 65000, and must be unique among rules within a NAT.
`nats[].rules[].description`	`string` An optional description of this rule.
`nats[].rules[].match`	`string` CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding `action` is enforced. The following examples are valid match expressions for public NAT: `inIpRange(destination.ip, '1.1.0.0/16') \|\| inIpRange(destination.ip, '2.2.0.0/16')` `destination.ip == '1.1.0.1' \|\| destination.ip == '8.8.8.8'` The following example is a valid match expression for private NAT: `nexthop.hub == '//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1'`
`nats[].rules[].action`	`object` The action to be enforced for traffic that matches this rule.
`nats[].rules[].action.sourceNatActiveIps[]`	`string` A list of URLs of the IP resources used for this NAT rule. These IP addresses must be valid static external IP addresses assigned to the project. This field is used for public NAT.
`nats[].rules[].action.sourceNatDrainIps[]`	`string` A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT rule only. This field is used for public NAT.
`nats[].rules[].action.sourceNatActiveRanges[]`	`string` A list of URLs of the subnetworks used as source ranges for this NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT. This field is used for private NAT.
`nats[].rules[].action.sourceNatDrainRanges[]`	`string` A list of URLs of subnetworks representing source ranges to be drained. This is only supported on patch/update, and these subnetworks must have previously been used as active ranges in this NAT Rule. This field is used for private NAT.
`nats[].enableEndpointIndependentMapping`	`boolean`
`encryptedInterconnectRouter`	`boolean` Indicates if a router is dedicated for use with encrypted VLAN attachments (interconnectAttachments).
`md5AuthenticationKeys[]`	`object` Keys used for MD5 authentication.
`md5AuthenticationKeys[].name`	`string` Name used to identify the key. Must be unique within a router. Must be referenced by exactly one bgpPeer. Must comply with RFC1035.
`md5AuthenticationKeys[].key`	`string` [Input only] Value of the key. For patch and update calls, it can be skipped to copy the value from the previous configuration. This is allowed if the key with the same name existed before the operation. Maximum length is 80 characters. Can only contain printable ASCII characters.

Response body

Represents an Operation resource.

Google Compute Engine has three Operation resources:

You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

Operations can be global, regional or zonal.

For global operations, use the globalOperations resource.
For regional operations, use the regionOperations resource.
For zonal operations, use the zoneOperations resource.

For more information, read Global, Regional, and Zonal Resources.

Note that completed Operation resources have a limited retention period.

If successful, the response body contains data with the following structure:

JSON representation

JSON representation
{ "kind": string, "id": string, "creationTimestamp": string, "name": string, "zone": string, "clientOperationId": string, "operationType": string, "targetLink": string, "targetId": string, "status": enum, "statusMessage": string, "user": string, "progress": integer, "insertTime": string, "startTime": string, "endTime": string, "error": { "errors": [ { "code": string, "location": string, "message": string, "errorDetails": [ { "errorInfo": { "reason": string, "domain": string, "metadatas": { string: string, ... } }, "quotaInfo": { "metricName": string, "limitName": string, "dimensions": { string: string, ... }, "limit": number, "futureLimit": number, "rolloutStatus": enum }, "help": { "links": [ { "description": string, "url": string } ] }, "localizedMessage": { "locale": string, "message": string } } ] } ] }, "warnings": [ { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] } ], "httpErrorStatusCode": integer, "httpErrorMessage": string, "selfLink": string, "region": string, "description": string, "operationGroupId": string, // Union field `metadata` can be only one of the following: "setCommonInstanceMetadataOperationMetadata": { "clientOperationId": string, "perLocationOperations": { string: { "state": enum, "error": { "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } }, ... } }, "instancesBulkInsertOperationMetadata": { "perLocationStatus": { string: { "status": enum, "targetVmCount": integer, "createdVmCount": integer, "failedToCreateVmCount": integer, "deletedVmCount": integer }, ... } } // End of list of possible types for union field `metadata`. }

{
  "kind": string,
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "zone": string,
  "clientOperationId": string,
  "operationType": string,
  "targetLink": string,
  "targetId": string,
  "status": enum,
  "statusMessage": string,
  "user": string,
  "progress": integer,
  "insertTime": string,
  "startTime": string,
  "endTime": string,
  "error": {
    "errors": [
      {
        "code": string,
        "location": string,
        "message": string,
        "errorDetails": [
          {
            "errorInfo": {
              "reason": string,
              "domain": string,
              "metadatas": {
                string: string,
                ...
              }
            },
            "quotaInfo": {
              "metricName": string,
              "limitName": string,
              "dimensions": {
                string: string,
                ...
              },
              "limit": number,
              "futureLimit": number,
              "rolloutStatus": enum
            },
            "help": {
              "links": [
                {
                  "description": string,
                  "url": string
                }
              ]
            },
            "localizedMessage": {
              "locale": string,
              "message": string
            }
          }
        ]
      }
    ]
  },
  "warnings": [
    {
      "code": enum,
      "message": string,
      "data": [
        {
          "key": string,
          "value": string
        }
      ]
    }
  ],
  "httpErrorStatusCode": integer,
  "httpErrorMessage": string,
  "selfLink": string,
  "region": string,
  "description": string,
  "operationGroupId": string,

  // Union field metadata can be only one of the following:
  "setCommonInstanceMetadataOperationMetadata": {
    "clientOperationId": string,
    "perLocationOperations": {
      string: {
        "state": enum,
        "error": {
          "code": integer,
          "message": string,
          "details": [
            {
              "@type": string,
              field1: ...,
              ...
            }
          ]
        }
      },
      ...
    }
  },
  "instancesBulkInsertOperationMetadata": {
    "perLocationStatus": {
      string: {
        "status": enum,
        "targetVmCount": integer,
        "createdVmCount": integer,
        "failedToCreateVmCount": integer,
        "deletedVmCount": integer
      },
      ...
    }
  }
  // End of list of possible types for union field metadata.
}

Fields
`kind`	`string` [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
`id`	`string (uint64 format)` [Output Only] The unique identifier for the operation. This identifier is defined by the server.
`creationTimestamp`	`string` [Deprecated] This field is deprecated.
`name`	`string` [Output Only] Name of the operation.
`zone`	`string` [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
`clientOperationId`	`string` [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
`operationType`	`string` [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
`targetLink`	`string` [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from.
`targetId`	`string (uint64 format)` [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
`status`	`enum` [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.
`user`	`string` [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
`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.
`insertTime`	`string` [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
`startTime`	`string` [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
`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` [Output Only] The array of errors encountered while processing this operation.
`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.
`error.errors[].errorDetails[]`	`object` [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
`error.errors[].errorDetails[].errorInfo`	`object`
`error.errors[].errorDetails[].errorInfo.reason`	`string` The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `[A-Z][A-Z0-9_]+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
`error.errors[].errorDetails[].errorInfo.domain`	`string` The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
`error.errors[].errorDetails[].errorInfo.metadatas`	`map (key: string, value: string)` Additional structured details about this error. Keys must match /[a-z][a-zA-Z0-9-_]+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
`error.errors[].errorDetails[].quotaInfo`	`object`
`error.errors[].errorDetails[].quotaInfo.metricName`	`string` The Compute Engine quota metric name.
`error.errors[].errorDetails[].quotaInfo.limitName`	`string` The name of the quota limit.
`error.errors[].errorDetails[].quotaInfo.dimensions`	`map (key: string, value: string)` The map holding related quota dimensions.
`error.errors[].errorDetails[].quotaInfo.limit`	`number` Current effective quota limit. The limit's unit depends on the quota type or metric.
`error.errors[].errorDetails[].quotaInfo.futureLimit`	`number` Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
`error.errors[].errorDetails[].quotaInfo.rolloutStatus`	`enum` Rollout status of the future quota limit.
`error.errors[].errorDetails[].help`	`object`
`error.errors[].errorDetails[].help.links[]`	`object` URL(s) pointing to additional information on handling the current error.
`error.errors[].errorDetails[].help.links[].description`	`string` Describes what the link offers.
`error.errors[].errorDetails[].help.links[].url`	`string` The URL of the link.
`error.errors[].errorDetails[].localizedMessage`	`object`
`error.errors[].errorDetails[].localizedMessage.locale`	`string` The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
`error.errors[].errorDetails[].localizedMessage.message`	`string` The localized error message in the above locale.
`warnings[]`	`object` [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
`warnings[].code`	`enum` [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[].message`	`string` [Output Only] A human-readable description of the warning code.
`warnings[].data[]`	`object` [Output Only] Metadata about this warning in `key: value` format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
`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.
`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.
`httpErrorMessage`	`string` [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
`selfLink`	`string` [Output Only] Server-defined URL for the resource.
`region`	`string` [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
`description`	`string` [Output Only] A textual description of the operation, which is set when the operation is created.
`operationGroupId`	`string` [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Union field `metadata`. [Output Only] Service-specific metadata attached to this operation. `metadata` can be only one of the following:
`setCommonInstanceMetadataOperationMetadata`	`object` [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
`setCommonInstanceMetadataOperationMetadata.clientOperationId`	`string` [Output Only] The client operation id.
`setCommonInstanceMetadataOperationMetadata.perLocationOperations[]`	`map (key: string, value: object)` [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
`setCommonInstanceMetadataOperationMetadata.perLocationOperations[].state`	`enum` [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
`setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error`	`object` [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
`setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error.code`	`integer` The status code, which should be an enum value of `google.rpc.Code`.
`setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error.message`	`string` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the `google.rpc.Status.details` field, or localized by the client.
`setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error.details[]`	`object` A list of messages that carry the error details. There is a common set of message types for APIs to use. An object containing fields of an arbitrary type. An additional field `"@type"` contains a URI identifying the type. Example: `{ "id": 1234, "@type": "types.example.com/standard/id" }`.
`instancesBulkInsertOperationMetadata`	`object`
`instancesBulkInsertOperationMetadata.perLocationStatus[]`	`map (key: string, value: object)` Status information per location (location name is key). Example key: zones/us-central1-a
`instancesBulkInsertOperationMetadata.perLocationStatus[].status`	`enum` [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
`instancesBulkInsertOperationMetadata.perLocationStatus[].targetVmCount`	`integer` [Output Only] Count of VMs originally planned to be created.
`instancesBulkInsertOperationMetadata.perLocationStatus[].createdVmCount`	`integer` [Output Only] Count of VMs successfully created so far.
`instancesBulkInsertOperationMetadata.perLocationStatus[].failedToCreateVmCount`	`integer` [Output Only] Count of VMs that started creating but encountered an error.
`instancesBulkInsertOperationMetadata.perLocationStatus[].deletedVmCount`	`integer` [Output Only] Count of VMs that got deleted during rollback.

Authorization scopes

Requires one of the following OAuth scopes:

https://www.googleapis.com/auth/compute
https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

In addition to any permissions specified on the fields above, authorization requires one or more of the following IAM permissions:

compute.routers.get
compute.routers.update

To find predefined roles that contain those permissions, see Compute Engine IAM Roles.