| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.routers.html">routers</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None)</a></code></p> |
| <p class="firstline">Retrieves an aggregated list of routers.</p> |
| <p class="toc_element"> |
| <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(project, region, router, requestId=None)</a></code></p> |
| <p class="firstline">Deletes the specified Router resource.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(project, region, router)</a></code></p> |
| <p class="firstline">Returns the specified Router resource. Gets a list of available routers by making a list() request.</p> |
| <p class="toc_element"> |
| <code><a href="#getNatMappingInfo">getNatMappingInfo(project, region, router, filter=None, maxResults=None, orderBy=None, pageToken=None)</a></code></p> |
| <p class="firstline">Retrieves runtime Nat mapping information of VM endpoints.</p> |
| <p class="toc_element"> |
| <code><a href="#getNatMappingInfo_next">getNatMappingInfo_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#getRouterStatus">getRouterStatus(project, region, router)</a></code></p> |
| <p class="firstline">Retrieves runtime information of the specified router.</p> |
| <p class="toc_element"> |
| <code><a href="#insert">insert(project, region, body=None, requestId=None)</a></code></p> |
| <p class="firstline">Creates a Router resource in the specified project and region using the data included in the request.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None)</a></code></p> |
| <p class="firstline">Retrieves a list of Router resources available to the specified project.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(project, region, router, body=None, requestId=None)</a></code></p> |
| <p class="firstline">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.</p> |
| <p class="toc_element"> |
| <code><a href="#preview">preview(project, region, router, body=None)</a></code></p> |
| <p class="firstline">Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.</p> |
| <p class="toc_element"> |
| <code><a href="#update">update(project, region, router, body=None, requestId=None)</a></code></p> |
| <p class="firstline">Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None)</code> |
| <pre>Retrieves an aggregated list of routers. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. |
| |
| For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. |
| |
| You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. |
| |
| To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` |
| includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. |
| maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) |
| orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. |
| |
| You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. |
| |
| Currently, only sorting by `name` or `creationTimestamp desc` is supported. |
| pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. |
| |
| Returns: |
| An object of the form: |
| |
| { # Contains a list of routers. |
| "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. |
| "items": { # A list of Router resources. |
| "a_key": { # Name of the scope containing this set of routers. |
| "routers": [ # A list of routers contained in this scope. |
| { # Represents a Cloud Router resource. |
| # |
| # For more information about Cloud Router, read the Cloud Router overview. |
| "bgp": { # BGP information specific to this router. |
| "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM. |
| "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode 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. |
| "A String", |
| ], |
| "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode 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. |
| { # Description-tagged IP ranges for the router to advertise. |
| "description": "A String", # User-specified description for the IP range. |
| "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string. |
| }, |
| ], |
| "asn": 42, # 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": [ # 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. |
| { |
| "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. |
| "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, which can take one of the following options: |
| # - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets. |
| # - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets. |
| # - ALL_PEER_VPC_SUBNETS: Advertises peer subnets of the router's VPC network. Note that this field can only be populated if advertise_mode 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. |
| "A String", |
| ], |
| "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode 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. |
| { # Description-tagged IP ranges for the router to advertise. |
| "description": "A String", # User-specified description for the IP range. |
| "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string. |
| }, |
| ], |
| "advertisedRoutePriority": 42, # 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. |
| "interfaceName": "A String", # Name of the interface the BGP peer is associated with. |
| "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. Only IPv4 is supported. |
| "managementType": "A String", # [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. |
| "name": "A 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. |
| "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value. |
| "peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported. |
| }, |
| ], |
| "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| "interfaces": [ # Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both. |
| { |
| "ipRange": "A 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. |
| "linkedInterconnectAttachment": "A 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 virtual machine instance. |
| "linkedVpnTunnel": "A 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 virtual machine instance. |
| "managementType": "A String", # [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. |
| "name": "A 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. |
| }, |
| ], |
| "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers. |
| "name": "A 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": [ # A list of NAT services created in this router. |
| { # 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. |
| "drainNatIps": [ # 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. |
| "A String", |
| ], |
| "icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set. |
| "logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT. |
| "enable": True or False, # Indicates whether or not to export logs. This is false by default. |
| "filter": "A String", # 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. |
| }, |
| "minPortsPerVm": 42, # 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. |
| "name": "A String", # Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035. |
| "natIpAllocateOption": "A String", # 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. |
| "natIps": [ # 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. |
| "A String", |
| ], |
| "sourceSubnetworkIpRangesToNat": "A String", # 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. |
| "subnetworks": [ # 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. |
| { # Defines the IP ranges that want to use NAT for a subnetwork. |
| "name": "A String", # URL for the subnetwork resource that will use NAT. |
| "secondaryIpRangeNames": [ # 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 source_ip_ranges_to_nat. |
| "A String", |
| ], |
| "sourceIpRangesToNat": [ # 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] |
| "A String", |
| ], |
| }, |
| ], |
| "tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set. |
| "tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set. |
| "udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set. |
| }, |
| ], |
| "network": "A String", # URI of the network to which this router belongs. |
| "region": "A 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": "A String", # [Output Only] Server-defined URL for the resource. |
| }, |
| ], |
| "warning": { # Informational warning which replaces the list of routers when the list is empty. |
| "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. |
| "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| { |
| "key": "A 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). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| }, |
| }, |
| "kind": "compute#routerAggregatedList", # Type of resource. |
| "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. |
| "selfLink": "A String", # [Output Only] Server-defined URL for this resource. |
| "warning": { # [Output Only] Informational warning message. |
| "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. |
| "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| { |
| "key": "A 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). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(project, region, router, requestId=None)</code> |
| <pre>Deletes the specified Router resource. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, Name of the region for this request. (required) |
| router: string, Name of the Router resource to delete. (required) |
| 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). |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) |
| # |
| # 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 `zonalOperations` resource. |
| # |
| # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) |
| "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| { |
| "code": "A String", # [Output Only] The error type identifier for this error. |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| }, |
| ], |
| }, |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. |
| "httpErrorStatusCode": 42, # [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": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| "progress": 42, # [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": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| "targetLink": "A 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": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| { |
| "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. |
| "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| { |
| "key": "A 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). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| ], |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(project, region, router)</code> |
| <pre>Returns the specified Router resource. Gets a list of available routers by making a list() request. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, Name of the region for this request. (required) |
| router: string, Name of the Router resource to return. (required) |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents a Cloud Router resource. |
| # |
| # For more information about Cloud Router, read the Cloud Router overview. |
| "bgp": { # BGP information specific to this router. |
| "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM. |
| "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode 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. |
| "A String", |
| ], |
| "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode 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. |
| { # Description-tagged IP ranges for the router to advertise. |
| "description": "A String", # User-specified description for the IP range. |
| "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string. |
| }, |
| ], |
| "asn": 42, # 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": [ # 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. |
| { |
| "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. |
| "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, which can take one of the following options: |
| # - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets. |
| # - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets. |
| # - ALL_PEER_VPC_SUBNETS: Advertises peer subnets of the router's VPC network. Note that this field can only be populated if advertise_mode 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. |
| "A String", |
| ], |
| "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode 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. |
| { # Description-tagged IP ranges for the router to advertise. |
| "description": "A String", # User-specified description for the IP range. |
| "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string. |
| }, |
| ], |
| "advertisedRoutePriority": 42, # 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. |
| "interfaceName": "A String", # Name of the interface the BGP peer is associated with. |
| "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. Only IPv4 is supported. |
| "managementType": "A String", # [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. |
| "name": "A 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. |
| "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value. |
| "peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported. |
| }, |
| ], |
| "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| "interfaces": [ # Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both. |
| { |
| "ipRange": "A 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. |
| "linkedInterconnectAttachment": "A 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 virtual machine instance. |
| "linkedVpnTunnel": "A 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 virtual machine instance. |
| "managementType": "A String", # [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. |
| "name": "A 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. |
| }, |
| ], |
| "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers. |
| "name": "A 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": [ # A list of NAT services created in this router. |
| { # 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. |
| "drainNatIps": [ # 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. |
| "A String", |
| ], |
| "icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set. |
| "logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT. |
| "enable": True or False, # Indicates whether or not to export logs. This is false by default. |
| "filter": "A String", # 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. |
| }, |
| "minPortsPerVm": 42, # 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. |
| "name": "A String", # Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035. |
| "natIpAllocateOption": "A String", # 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. |
| "natIps": [ # 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. |
| "A String", |
| ], |
| "sourceSubnetworkIpRangesToNat": "A String", # 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. |
| "subnetworks": [ # 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. |
| { # Defines the IP ranges that want to use NAT for a subnetwork. |
| "name": "A String", # URL for the subnetwork resource that will use NAT. |
| "secondaryIpRangeNames": [ # 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 source_ip_ranges_to_nat. |
| "A String", |
| ], |
| "sourceIpRangesToNat": [ # 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] |
| "A String", |
| ], |
| }, |
| ], |
| "tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set. |
| "tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set. |
| "udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set. |
| }, |
| ], |
| "network": "A String", # URI of the network to which this router belongs. |
| "region": "A 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": "A String", # [Output Only] Server-defined URL for the resource. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="getNatMappingInfo">getNatMappingInfo(project, region, router, filter=None, maxResults=None, orderBy=None, pageToken=None)</code> |
| <pre>Retrieves runtime Nat mapping information of VM endpoints. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, Name of the region for this request. (required) |
| router: string, Name of the Router resource to query for Nat Mapping information of VM endpoints. (required) |
| filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. |
| |
| For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. |
| |
| You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. |
| |
| To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` |
| maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) |
| orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. |
| |
| You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. |
| |
| Currently, only sorting by `name` or `creationTimestamp desc` is supported. |
| pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. |
| |
| Returns: |
| An object of the form: |
| |
| { # Contains a list of VmEndpointNatMappings. |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| "kind": "compute#vmEndpointNatMappingsList", # [Output Only] Type of resource. Always compute#vmEndpointNatMappingsList for lists of Nat mappings of VM endpoints. |
| "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. |
| "result": [ # [Output Only] A list of Nat mapping information of VM endpoints. |
| { # Contain information of Nat mapping for a VM endpoint (i.e., NIC). |
| "instanceName": "A String", # Name of the VM instance which the endpoint belongs to |
| "interfaceNatMappings": [ |
| { # Contain information of Nat mapping for an interface of this endpoint. |
| "drainNatIpPortRanges": [ # List of all drain IP:port-range mappings assigned to this interface. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: ["2.2.2.2:12345-12355", "1.1.1.1:2234-2234"]. |
| "A String", |
| ], |
| "natIpPortRanges": [ # A list of all IP:port-range mappings assigned to this interface. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: ["2.2.2.2:12345-12355", "1.1.1.1:2234-2234"]. |
| "A String", |
| ], |
| "numTotalDrainNatPorts": 42, # Total number of drain ports across all NAT IPs allocated to this interface. It equals to the aggregated port number in the field drain_nat_ip_port_ranges. |
| "numTotalNatPorts": 42, # Total number of ports across all NAT IPs allocated to this interface. It equals to the aggregated port number in the field nat_ip_port_ranges. |
| "sourceAliasIpRange": "A String", # Alias IP range for this interface endpoint. It will be a private (RFC 1918) IP range. Examples: "10.33.4.55/32", or "192.168.5.0/24". |
| "sourceVirtualIp": "A String", # Primary IP of the VM for this NIC. |
| }, |
| ], |
| }, |
| ], |
| "selfLink": "A String", # [Output Only] Server-defined URL for this resource. |
| "warning": { # [Output Only] Informational warning message. |
| "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. |
| "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| { |
| "key": "A 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). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="getNatMappingInfo_next">getNatMappingInfo_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="getRouterStatus">getRouterStatus(project, region, router)</code> |
| <pre>Retrieves runtime information of the specified router. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, Name of the region for this request. (required) |
| router: string, Name of the Router resource to query. (required) |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "kind": "compute#routerStatusResponse", # Type of resource. |
| "result": { |
| "bestRoutes": [ # Best routes for this router's network. |
| { # 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. (== resource_for {$api_version}.routes ==) |
| "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| "description": "A String", # An optional description of this resource. Provide this field when you create the resource. |
| "destRange": "A String", # The destination range of outgoing packets that this route applies to. Only IPv4 is supported. |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources. |
| "name": "A 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])?`. 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. |
| "network": "A String", # Fully-qualified URL of the network that this route applies to. |
| "nextHopGateway": "A String", # 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 |
| "nextHopIlb": "A String", # The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets. You can only specify the forwarding rule as a partial or full URL. For example, the following are all valid URLs: |
| # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule |
| # - regions/region/forwardingRules/forwardingRule |
| "nextHopInstance": "A String", # 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/ |
| "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets. Only IPv4 is supported. |
| "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets. |
| "nextHopPeering": "A String", # [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035. |
| "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets. |
| "priority": 42, # 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. |
| "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. |
| "tags": [ # A list of instance tags to which this route applies. |
| "A String", |
| ], |
| "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages. |
| { |
| "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. |
| "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| { |
| "key": "A 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). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| ], |
| }, |
| ], |
| "bestRoutesForRouter": [ # Best routes learned by this router. |
| { # 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. (== resource_for {$api_version}.routes ==) |
| "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| "description": "A String", # An optional description of this resource. Provide this field when you create the resource. |
| "destRange": "A String", # The destination range of outgoing packets that this route applies to. Only IPv4 is supported. |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources. |
| "name": "A 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])?`. 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. |
| "network": "A String", # Fully-qualified URL of the network that this route applies to. |
| "nextHopGateway": "A String", # 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 |
| "nextHopIlb": "A String", # The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets. You can only specify the forwarding rule as a partial or full URL. For example, the following are all valid URLs: |
| # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule |
| # - regions/region/forwardingRules/forwardingRule |
| "nextHopInstance": "A String", # 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/ |
| "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets. Only IPv4 is supported. |
| "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets. |
| "nextHopPeering": "A String", # [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035. |
| "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets. |
| "priority": 42, # 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. |
| "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. |
| "tags": [ # A list of instance tags to which this route applies. |
| "A String", |
| ], |
| "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages. |
| { |
| "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. |
| "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| { |
| "key": "A 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). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| ], |
| }, |
| ], |
| "bgpPeerStatus": [ |
| { |
| "advertisedRoutes": [ # Routes that were advertised to the remote BGP peer |
| { # 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. (== resource_for {$api_version}.routes ==) |
| "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| "description": "A String", # An optional description of this resource. Provide this field when you create the resource. |
| "destRange": "A String", # The destination range of outgoing packets that this route applies to. Only IPv4 is supported. |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources. |
| "name": "A 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])?`. 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. |
| "network": "A String", # Fully-qualified URL of the network that this route applies to. |
| "nextHopGateway": "A String", # 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 |
| "nextHopIlb": "A String", # The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets. You can only specify the forwarding rule as a partial or full URL. For example, the following are all valid URLs: |
| # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule |
| # - regions/region/forwardingRules/forwardingRule |
| "nextHopInstance": "A String", # 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/ |
| "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets. Only IPv4 is supported. |
| "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets. |
| "nextHopPeering": "A String", # [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035. |
| "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets. |
| "priority": 42, # 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. |
| "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. |
| "tags": [ # A list of instance tags to which this route applies. |
| "A String", |
| ], |
| "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages. |
| { |
| "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. |
| "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| { |
| "key": "A 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). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| ], |
| }, |
| ], |
| "ipAddress": "A String", # IP address of the local BGP interface. |
| "linkedVpnTunnel": "A String", # URL of the VPN tunnel that this BGP peer controls. |
| "name": "A String", # Name of this BGP peer. Unique within the Routers resource. |
| "numLearnedRoutes": 42, # Number of routes learned from the remote BGP Peer. |
| "peerIpAddress": "A String", # IP address of the remote BGP interface. |
| "state": "A String", # BGP state as specified in RFC1771. |
| "status": "A String", # Status of the BGP peer: {UP, DOWN} |
| "uptime": "A String", # Time this session has been up. Format: 14 years, 51 weeks, 6 days, 23 hours, 59 minutes, 59 seconds |
| "uptimeSeconds": "A String", # Time this session has been up, in seconds. Format: 145 |
| }, |
| ], |
| "natStatus": [ |
| { # Status of a NAT contained in this router. |
| "autoAllocatedNatIps": [ # A list of IPs auto-allocated for NAT. Example: ["1.1.1.1", "129.2.16.89"] |
| "A String", |
| ], |
| "drainAutoAllocatedNatIps": [ # A list of IPs auto-allocated for NAT that are in drain mode. Example: ["1.1.1.1", "179.12.26.133"]. |
| "A String", |
| ], |
| "drainUserAllocatedNatIps": [ # A list of IPs user-allocated for NAT that are in drain mode. Example: ["1.1.1.1", "179.12.26.133"]. |
| "A String", |
| ], |
| "minExtraNatIpsNeeded": 42, # The number of extra IPs to allocate. This will be greater than 0 only if user-specified IPs are NOT enough to allow all configured VMs to use NAT. This value is meaningful only when auto-allocation of NAT IPs is *not* used. |
| "name": "A String", # Unique name of this NAT. |
| "numVmEndpointsWithNatMappings": 42, # Number of VM endpoints (i.e., Nics) that can use NAT. |
| "userAllocatedNatIpResources": [ # A list of fully qualified URLs of reserved IP address resources. |
| "A String", |
| ], |
| "userAllocatedNatIps": [ # A list of IPs user-allocated for NAT. They will be raw IP strings like "179.12.26.133". |
| "A String", |
| ], |
| }, |
| ], |
| "network": "A String", # URI of the network to which this router belongs. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="insert">insert(project, region, body=None, requestId=None)</code> |
| <pre>Creates a Router resource in the specified project and region using the data included in the request. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, Name of the region for this request. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Represents a Cloud Router resource. |
| # |
| # For more information about Cloud Router, read the Cloud Router overview. |
| "bgp": { # BGP information specific to this router. |
| "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM. |
| "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode 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. |
| "A String", |
| ], |
| "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode 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. |
| { # Description-tagged IP ranges for the router to advertise. |
| "description": "A String", # User-specified description for the IP range. |
| "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string. |
| }, |
| ], |
| "asn": 42, # 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": [ # 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. |
| { |
| "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. |
| "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, which can take one of the following options: |
| # - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets. |
| # - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets. |
| # - ALL_PEER_VPC_SUBNETS: Advertises peer subnets of the router's VPC network. Note that this field can only be populated if advertise_mode 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. |
| "A String", |
| ], |
| "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode 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. |
| { # Description-tagged IP ranges for the router to advertise. |
| "description": "A String", # User-specified description for the IP range. |
| "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string. |
| }, |
| ], |
| "advertisedRoutePriority": 42, # 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. |
| "interfaceName": "A String", # Name of the interface the BGP peer is associated with. |
| "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. Only IPv4 is supported. |
| "managementType": "A String", # [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. |
| "name": "A 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. |
| "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value. |
| "peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported. |
| }, |
| ], |
| "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| "interfaces": [ # Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both. |
| { |
| "ipRange": "A 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. |
| "linkedInterconnectAttachment": "A 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 virtual machine instance. |
| "linkedVpnTunnel": "A 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 virtual machine instance. |
| "managementType": "A String", # [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. |
| "name": "A 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. |
| }, |
| ], |
| "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers. |
| "name": "A 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": [ # A list of NAT services created in this router. |
| { # 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. |
| "drainNatIps": [ # 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. |
| "A String", |
| ], |
| "icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set. |
| "logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT. |
| "enable": True or False, # Indicates whether or not to export logs. This is false by default. |
| "filter": "A String", # 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. |
| }, |
| "minPortsPerVm": 42, # 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. |
| "name": "A String", # Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035. |
| "natIpAllocateOption": "A String", # 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. |
| "natIps": [ # 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. |
| "A String", |
| ], |
| "sourceSubnetworkIpRangesToNat": "A String", # 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. |
| "subnetworks": [ # 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. |
| { # Defines the IP ranges that want to use NAT for a subnetwork. |
| "name": "A String", # URL for the subnetwork resource that will use NAT. |
| "secondaryIpRangeNames": [ # 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 source_ip_ranges_to_nat. |
| "A String", |
| ], |
| "sourceIpRangesToNat": [ # 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] |
| "A String", |
| ], |
| }, |
| ], |
| "tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set. |
| "tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set. |
| "udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set. |
| }, |
| ], |
| "network": "A String", # URI of the network to which this router belongs. |
| "region": "A 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": "A String", # [Output Only] Server-defined URL for the resource. |
| } |
| |
| 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). |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) |
| # |
| # 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 `zonalOperations` resource. |
| # |
| # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) |
| "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| { |
| "code": "A String", # [Output Only] The error type identifier for this error. |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| }, |
| ], |
| }, |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. |
| "httpErrorStatusCode": 42, # [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": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| "progress": 42, # [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": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| "targetLink": "A 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": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| { |
| "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. |
| "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| { |
| "key": "A 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). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| ], |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None)</code> |
| <pre>Retrieves a list of Router resources available to the specified project. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, Name of the region for this request. (required) |
| filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. |
| |
| For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. |
| |
| You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. |
| |
| To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` |
| maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) |
| orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. |
| |
| You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. |
| |
| Currently, only sorting by `name` or `creationTimestamp desc` is supported. |
| pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. |
| |
| Returns: |
| An object of the form: |
| |
| { # Contains a list of Router resources. |
| "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. |
| "items": [ # A list of Router resources. |
| { # Represents a Cloud Router resource. |
| # |
| # For more information about Cloud Router, read the Cloud Router overview. |
| "bgp": { # BGP information specific to this router. |
| "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM. |
| "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode 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. |
| "A String", |
| ], |
| "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode 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. |
| { # Description-tagged IP ranges for the router to advertise. |
| "description": "A String", # User-specified description for the IP range. |
| "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string. |
| }, |
| ], |
| "asn": 42, # 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": [ # 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. |
| { |
| "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. |
| "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, which can take one of the following options: |
| # - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets. |
| # - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets. |
| # - ALL_PEER_VPC_SUBNETS: Advertises peer subnets of the router's VPC network. Note that this field can only be populated if advertise_mode 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. |
| "A String", |
| ], |
| "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode 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. |
| { # Description-tagged IP ranges for the router to advertise. |
| "description": "A String", # User-specified description for the IP range. |
| "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string. |
| }, |
| ], |
| "advertisedRoutePriority": 42, # 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. |
| "interfaceName": "A String", # Name of the interface the BGP peer is associated with. |
| "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. Only IPv4 is supported. |
| "managementType": "A String", # [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. |
| "name": "A 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. |
| "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value. |
| "peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported. |
| }, |
| ], |
| "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| "interfaces": [ # Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both. |
| { |
| "ipRange": "A 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. |
| "linkedInterconnectAttachment": "A 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 virtual machine instance. |
| "linkedVpnTunnel": "A 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 virtual machine instance. |
| "managementType": "A String", # [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. |
| "name": "A 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. |
| }, |
| ], |
| "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers. |
| "name": "A 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": [ # A list of NAT services created in this router. |
| { # 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. |
| "drainNatIps": [ # 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. |
| "A String", |
| ], |
| "icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set. |
| "logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT. |
| "enable": True or False, # Indicates whether or not to export logs. This is false by default. |
| "filter": "A String", # 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. |
| }, |
| "minPortsPerVm": 42, # 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. |
| "name": "A String", # Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035. |
| "natIpAllocateOption": "A String", # 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. |
| "natIps": [ # 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. |
| "A String", |
| ], |
| "sourceSubnetworkIpRangesToNat": "A String", # 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. |
| "subnetworks": [ # 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. |
| { # Defines the IP ranges that want to use NAT for a subnetwork. |
| "name": "A String", # URL for the subnetwork resource that will use NAT. |
| "secondaryIpRangeNames": [ # 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 source_ip_ranges_to_nat. |
| "A String", |
| ], |
| "sourceIpRangesToNat": [ # 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] |
| "A String", |
| ], |
| }, |
| ], |
| "tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set. |
| "tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set. |
| "udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set. |
| }, |
| ], |
| "network": "A String", # URI of the network to which this router belongs. |
| "region": "A 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": "A String", # [Output Only] Server-defined URL for the resource. |
| }, |
| ], |
| "kind": "compute#routerList", # [Output Only] Type of resource. Always compute#router for routers. |
| "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. |
| "selfLink": "A String", # [Output Only] Server-defined URL for this resource. |
| "warning": { # [Output Only] Informational warning message. |
| "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. |
| "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| { |
| "key": "A 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). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(project, region, router, body=None, requestId=None)</code> |
| <pre>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. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, Name of the region for this request. (required) |
| router: string, Name of the Router resource to patch. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Represents a Cloud Router resource. |
| # |
| # For more information about Cloud Router, read the Cloud Router overview. |
| "bgp": { # BGP information specific to this router. |
| "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM. |
| "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode 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. |
| "A String", |
| ], |
| "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode 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. |
| { # Description-tagged IP ranges for the router to advertise. |
| "description": "A String", # User-specified description for the IP range. |
| "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string. |
| }, |
| ], |
| "asn": 42, # 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": [ # 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. |
| { |
| "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. |
| "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, which can take one of the following options: |
| # - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets. |
| # - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets. |
| # - ALL_PEER_VPC_SUBNETS: Advertises peer subnets of the router's VPC network. Note that this field can only be populated if advertise_mode 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. |
| "A String", |
| ], |
| "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode 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. |
| { # Description-tagged IP ranges for the router to advertise. |
| "description": "A String", # User-specified description for the IP range. |
| "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string. |
| }, |
| ], |
| "advertisedRoutePriority": 42, # 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. |
| "interfaceName": "A String", # Name of the interface the BGP peer is associated with. |
| "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. Only IPv4 is supported. |
| "managementType": "A String", # [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. |
| "name": "A 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. |
| "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value. |
| "peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported. |
| }, |
| ], |
| "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| "interfaces": [ # Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both. |
| { |
| "ipRange": "A 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. |
| "linkedInterconnectAttachment": "A 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 virtual machine instance. |
| "linkedVpnTunnel": "A 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 virtual machine instance. |
| "managementType": "A String", # [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. |
| "name": "A 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. |
| }, |
| ], |
| "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers. |
| "name": "A 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": [ # A list of NAT services created in this router. |
| { # 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. |
| "drainNatIps": [ # 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. |
| "A String", |
| ], |
| "icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set. |
| "logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT. |
| "enable": True or False, # Indicates whether or not to export logs. This is false by default. |
| "filter": "A String", # 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. |
| }, |
| "minPortsPerVm": 42, # 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. |
| "name": "A String", # Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035. |
| "natIpAllocateOption": "A String", # 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. |
| "natIps": [ # 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. |
| "A String", |
| ], |
| "sourceSubnetworkIpRangesToNat": "A String", # 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. |
| "subnetworks": [ # 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. |
| { # Defines the IP ranges that want to use NAT for a subnetwork. |
| "name": "A String", # URL for the subnetwork resource that will use NAT. |
| "secondaryIpRangeNames": [ # 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 source_ip_ranges_to_nat. |
| "A String", |
| ], |
| "sourceIpRangesToNat": [ # 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] |
| "A String", |
| ], |
| }, |
| ], |
| "tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set. |
| "tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set. |
| "udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set. |
| }, |
| ], |
| "network": "A String", # URI of the network to which this router belongs. |
| "region": "A 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": "A String", # [Output Only] Server-defined URL for the resource. |
| } |
| |
| 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). |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) |
| # |
| # 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 `zonalOperations` resource. |
| # |
| # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) |
| "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| { |
| "code": "A String", # [Output Only] The error type identifier for this error. |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| }, |
| ], |
| }, |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. |
| "httpErrorStatusCode": 42, # [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": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| "progress": 42, # [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": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| "targetLink": "A 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": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| { |
| "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. |
| "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| { |
| "key": "A 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). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| ], |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="preview">preview(project, region, router, body=None)</code> |
| <pre>Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, Name of the region for this request. (required) |
| router: string, Name of the Router resource to query. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Represents a Cloud Router resource. |
| # |
| # For more information about Cloud Router, read the Cloud Router overview. |
| "bgp": { # BGP information specific to this router. |
| "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM. |
| "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode 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. |
| "A String", |
| ], |
| "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode 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. |
| { # Description-tagged IP ranges for the router to advertise. |
| "description": "A String", # User-specified description for the IP range. |
| "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string. |
| }, |
| ], |
| "asn": 42, # 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": [ # 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. |
| { |
| "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. |
| "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, which can take one of the following options: |
| # - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets. |
| # - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets. |
| # - ALL_PEER_VPC_SUBNETS: Advertises peer subnets of the router's VPC network. Note that this field can only be populated if advertise_mode 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. |
| "A String", |
| ], |
| "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode 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. |
| { # Description-tagged IP ranges for the router to advertise. |
| "description": "A String", # User-specified description for the IP range. |
| "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string. |
| }, |
| ], |
| "advertisedRoutePriority": 42, # 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. |
| "interfaceName": "A String", # Name of the interface the BGP peer is associated with. |
| "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. Only IPv4 is supported. |
| "managementType": "A String", # [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. |
| "name": "A 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. |
| "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value. |
| "peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported. |
| }, |
| ], |
| "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| "interfaces": [ # Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both. |
| { |
| "ipRange": "A 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. |
| "linkedInterconnectAttachment": "A 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 virtual machine instance. |
| "linkedVpnTunnel": "A 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 virtual machine instance. |
| "managementType": "A String", # [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. |
| "name": "A 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. |
| }, |
| ], |
| "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers. |
| "name": "A 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": [ # A list of NAT services created in this router. |
| { # 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. |
| "drainNatIps": [ # 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. |
| "A String", |
| ], |
| "icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set. |
| "logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT. |
| "enable": True or False, # Indicates whether or not to export logs. This is false by default. |
| "filter": "A String", # 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. |
| }, |
| "minPortsPerVm": 42, # 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. |
| "name": "A String", # Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035. |
| "natIpAllocateOption": "A String", # 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. |
| "natIps": [ # 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. |
| "A String", |
| ], |
| "sourceSubnetworkIpRangesToNat": "A String", # 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. |
| "subnetworks": [ # 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. |
| { # Defines the IP ranges that want to use NAT for a subnetwork. |
| "name": "A String", # URL for the subnetwork resource that will use NAT. |
| "secondaryIpRangeNames": [ # 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 source_ip_ranges_to_nat. |
| "A String", |
| ], |
| "sourceIpRangesToNat": [ # 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] |
| "A String", |
| ], |
| }, |
| ], |
| "tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set. |
| "tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set. |
| "udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set. |
| }, |
| ], |
| "network": "A String", # URI of the network to which this router belongs. |
| "region": "A 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": "A String", # [Output Only] Server-defined URL for the resource. |
| } |
| |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "resource": { # Represents a Cloud Router resource. # Preview of given router. |
| # |
| # For more information about Cloud Router, read the Cloud Router overview. |
| "bgp": { # BGP information specific to this router. |
| "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM. |
| "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode 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. |
| "A String", |
| ], |
| "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode 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. |
| { # Description-tagged IP ranges for the router to advertise. |
| "description": "A String", # User-specified description for the IP range. |
| "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string. |
| }, |
| ], |
| "asn": 42, # 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": [ # 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. |
| { |
| "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. |
| "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, which can take one of the following options: |
| # - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets. |
| # - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets. |
| # - ALL_PEER_VPC_SUBNETS: Advertises peer subnets of the router's VPC network. Note that this field can only be populated if advertise_mode 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. |
| "A String", |
| ], |
| "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode 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. |
| { # Description-tagged IP ranges for the router to advertise. |
| "description": "A String", # User-specified description for the IP range. |
| "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string. |
| }, |
| ], |
| "advertisedRoutePriority": 42, # 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. |
| "interfaceName": "A String", # Name of the interface the BGP peer is associated with. |
| "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. Only IPv4 is supported. |
| "managementType": "A String", # [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. |
| "name": "A 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. |
| "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value. |
| "peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported. |
| }, |
| ], |
| "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| "interfaces": [ # Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both. |
| { |
| "ipRange": "A 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. |
| "linkedInterconnectAttachment": "A 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 virtual machine instance. |
| "linkedVpnTunnel": "A 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 virtual machine instance. |
| "managementType": "A String", # [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. |
| "name": "A 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. |
| }, |
| ], |
| "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers. |
| "name": "A 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": [ # A list of NAT services created in this router. |
| { # 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. |
| "drainNatIps": [ # 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. |
| "A String", |
| ], |
| "icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set. |
| "logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT. |
| "enable": True or False, # Indicates whether or not to export logs. This is false by default. |
| "filter": "A String", # 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. |
| }, |
| "minPortsPerVm": 42, # 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. |
| "name": "A String", # Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035. |
| "natIpAllocateOption": "A String", # 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. |
| "natIps": [ # 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. |
| "A String", |
| ], |
| "sourceSubnetworkIpRangesToNat": "A String", # 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. |
| "subnetworks": [ # 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. |
| { # Defines the IP ranges that want to use NAT for a subnetwork. |
| "name": "A String", # URL for the subnetwork resource that will use NAT. |
| "secondaryIpRangeNames": [ # 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 source_ip_ranges_to_nat. |
| "A String", |
| ], |
| "sourceIpRangesToNat": [ # 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] |
| "A String", |
| ], |
| }, |
| ], |
| "tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set. |
| "tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set. |
| "udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set. |
| }, |
| ], |
| "network": "A String", # URI of the network to which this router belongs. |
| "region": "A 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": "A String", # [Output Only] Server-defined URL for the resource. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="update">update(project, region, router, body=None, requestId=None)</code> |
| <pre>Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, Name of the region for this request. (required) |
| router: string, Name of the Router resource to update. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Represents a Cloud Router resource. |
| # |
| # For more information about Cloud Router, read the Cloud Router overview. |
| "bgp": { # BGP information specific to this router. |
| "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM. |
| "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode 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. |
| "A String", |
| ], |
| "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode 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. |
| { # Description-tagged IP ranges for the router to advertise. |
| "description": "A String", # User-specified description for the IP range. |
| "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string. |
| }, |
| ], |
| "asn": 42, # 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": [ # 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. |
| { |
| "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. |
| "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, which can take one of the following options: |
| # - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets. |
| # - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets. |
| # - ALL_PEER_VPC_SUBNETS: Advertises peer subnets of the router's VPC network. Note that this field can only be populated if advertise_mode 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. |
| "A String", |
| ], |
| "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode 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. |
| { # Description-tagged IP ranges for the router to advertise. |
| "description": "A String", # User-specified description for the IP range. |
| "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string. |
| }, |
| ], |
| "advertisedRoutePriority": 42, # 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. |
| "interfaceName": "A String", # Name of the interface the BGP peer is associated with. |
| "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. Only IPv4 is supported. |
| "managementType": "A String", # [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. |
| "name": "A 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. |
| "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value. |
| "peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported. |
| }, |
| ], |
| "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| "interfaces": [ # Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both. |
| { |
| "ipRange": "A 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. |
| "linkedInterconnectAttachment": "A 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 virtual machine instance. |
| "linkedVpnTunnel": "A 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 virtual machine instance. |
| "managementType": "A String", # [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. |
| "name": "A 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. |
| }, |
| ], |
| "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers. |
| "name": "A 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": [ # A list of NAT services created in this router. |
| { # 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. |
| "drainNatIps": [ # 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. |
| "A String", |
| ], |
| "icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set. |
| "logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT. |
| "enable": True or False, # Indicates whether or not to export logs. This is false by default. |
| "filter": "A String", # 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. |
| }, |
| "minPortsPerVm": 42, # 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. |
| "name": "A String", # Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035. |
| "natIpAllocateOption": "A String", # 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. |
| "natIps": [ # 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. |
| "A String", |
| ], |
| "sourceSubnetworkIpRangesToNat": "A String", # 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. |
| "subnetworks": [ # 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. |
| { # Defines the IP ranges that want to use NAT for a subnetwork. |
| "name": "A String", # URL for the subnetwork resource that will use NAT. |
| "secondaryIpRangeNames": [ # 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 source_ip_ranges_to_nat. |
| "A String", |
| ], |
| "sourceIpRangesToNat": [ # 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] |
| "A String", |
| ], |
| }, |
| ], |
| "tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set. |
| "tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set. |
| "udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set. |
| }, |
| ], |
| "network": "A String", # URI of the network to which this router belongs. |
| "region": "A 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": "A String", # [Output Only] Server-defined URL for the resource. |
| } |
| |
| 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). |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) |
| # |
| # 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 `zonalOperations` resource. |
| # |
| # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) |
| "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| { |
| "code": "A String", # [Output Only] The error type identifier for this error. |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| }, |
| ], |
| }, |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. |
| "httpErrorStatusCode": 42, # [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": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| "progress": 42, # [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": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| "targetLink": "A 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": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| { |
| "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. |
| "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| { |
| "key": "A 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). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| ], |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| }</pre> |
| </div> |
| |
| </body></html> |
