Blame - docs/dyn/compute_v1.routers.html - platform/external/python/google-api-python-client

2016-08-16 12:44:29 -0700

[diff] [blame]

79

<p class="firstline">Retrieves an aggregated list of routers.</p>

80

81

<code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>

82

<p class="firstline">Retrieves the next page of results.</p>

83

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

84

<code><a href="#close">close()</a></code></p>

85

<p class="firstline">Close httplib2 connections.</p>

86

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

87

<code><a href="#delete">delete(project, region, router, requestId=None)</a></code></p>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

88

<p class="firstline">Deletes the specified Router resource.</p>

89

90

<code><a href="#get">get(project, region, router)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

91

<p class="firstline">Returns the specified Router resource. Gets a list of available routers by making a list() request.</p>

92

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

93

<code><a href="#getNatMappingInfo">getNatMappingInfo(project, region, router, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

94

<p class="firstline">Retrieves runtime Nat mapping information of VM endpoints.</p>

95

96

<code><a href="#getNatMappingInfo_next">getNatMappingInfo_next(previous_request, previous_response)</a></code></p>

97

<p class="firstline">Retrieves the next page of results.</p>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

98

99

<code><a href="#getRouterStatus">getRouterStatus(project, region, router)</a></code></p>

100

<p class="firstline">Retrieves runtime information of the specified router.</p>

101

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

102

<code><a href="#insert">insert(project, region, body=None, requestId=None)</a></code></p>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

103

<p class="firstline">Creates a Router resource in the specified project and region using the data included in the request.</p>

104

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

105

<code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

106

<p class="firstline">Retrieves a list of Router resources available to the specified project.</p>

107

108

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

109

<p class="firstline">Retrieves the next page of results.</p>

110

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

111

<code><a href="#patch">patch(project, region, router, body=None, requestId=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

112

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

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

113

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

114

<code><a href="#preview">preview(project, region, router, body=None)</a></code></p>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

115

<p class="firstline">Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.</p>

116

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

117

<code><a href="#update">update(project, region, router, body=None, requestId=None)</a></code></p>

118

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

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

119

<h3>Method Details</h3>

120

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

121

<code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

122

<pre>Retrieves an aggregated list of routers.

123

124

Args:

125

project: string, Project ID for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

126

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

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

127

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

128

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

129

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

130

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.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

131

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

132

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

133

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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

134

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

135

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

136

137

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.

138

139

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

140

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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

141

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

142

143

Returns:

144

An object of the form:

145

146

{ # Contains a list of routers.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

147

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

148

"items": { # A list of Router resources.

149

"a_key": { # Name of the scope containing this set of routers.

150

"routers": [ # A list of routers contained in this scope.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

151

{ # Represents a Cloud Router resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

152

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

153

# For more information about Cloud Router, read the Cloud Router overview.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

154

"bgp": { # BGP information specific to this router.

155

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM.

156

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

157

"A String",

158

],

159

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

160

{ # Description-tagged IP ranges for the router to advertise.

161

"description": "A String", # User-specified description for the IP range.

162

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

163

},

164

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

165

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

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

166

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

167

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

168

{

169

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement.

170

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, which can take one of the following options:

171

# - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets.

172

# - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets.

173

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

174

"A String",

175

],

176

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

177

{ # Description-tagged IP ranges for the router to advertise.

178

"description": "A String", # User-specified description for the IP range.

179

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

180

},

181

],

182

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

183

"interfaceName": "A String", # Name of the interface the BGP peer is associated with.

184

"ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.

185

"managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer.

186

# - MANAGED_BY_USER is the default value and can be managed by you or other users

187

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

188

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

189

"peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.

190

"peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.

191

},

192

],

193

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

194

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

195

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

196

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

197

{

198

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

199

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

200

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

201

"managementType": "A String", # [Output Only] The resource that configures and manages this interface.

202

# - MANAGED_BY_USER is the default value and can be managed directly by users.

203

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

204

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

205

},

206

],

207

"kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.

208

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

209

"nats": [ # A list of NAT services created in this router.

210

{ # 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.

211

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

212

"A String",

213

],

214

"icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.

215

"logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT.

216

"enable": True or False, # Indicates whether or not to export logs. This is false by default.

217

"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:

218

# - ERRORS_ONLY: Export logs only for connection failures.

219

# - TRANSLATIONS_ONLY: Export logs only for successful connections.

220

# - ALL: Export logs for all connections, successful and unsuccessful.

221

},

222

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

223

"name": "A String", # Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.

224

"natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following values:

225

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

226

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

227

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

228

"A String",

229

],

230

"sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values:

231

# - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat.

232

# - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat.

233

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

234

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

235

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

236

"name": "A String", # URL for the subnetwork resource that will use NAT.

237

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

238

"A String",

239

],

240

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

246

"tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.

247

"udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.

248

},

249

],

250

"network": "A String", # URI of the network to which this router belongs.

251

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

252

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

253

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

254

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

255

"warning": { # Informational warning which replaces the list of routers when the list is empty.

256

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

257

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

258

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

259

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

260

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

261

"value": "A String", # [Output Only] A warning data value corresponding to the key.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

262

},

263

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

264

"message": "A String", # [Output Only] A human-readable description of the warning code.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

265

},

266

},

267

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

268

"kind": "compute#routerAggregatedList", # Type of resource.

269

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

270

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

271

"unreachables": [ # [Output Only] Unreachable resources.

272

"A String",

273

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

274

"warning": { # [Output Only] Informational warning message.

275

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

276

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

277

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

278

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

279

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

280

"value": "A String", # [Output Only] A warning data value corresponding to the key.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

281

},

282

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

283

"message": "A String", # [Output Only] A human-readable description of the warning code.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

284

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>

290

<pre>Retrieves the next page of results.

291

292

Args:

293

previous_request: The request for the previous page. (required)

294

previous_response: The response from the request for the previous page. (required)

295

296

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

297

A request object that you can call 'execute()' on to request the next

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

298

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

303

<code class="details" id="close">close()</code>

304

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

308

<code class="details" id="delete">delete(project, region, router, requestId=None)</code>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

309

<pre>Deletes the specified Router resource.

310

311

Args:

312

project: string, Project ID for this request. (required)

313

region: string, Name of the region for this request. (required)

314

router: string, Name of the Router resource to delete. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

315

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.

316

317

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.

318

319

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

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

320

321

Returns:

322

An object of the form:

323

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

324

{ # Represents an Operation resource.

325

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

326

# Google Compute Engine has three Operation resources:

327

#

328

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

329

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

330

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

331

#

332

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

333

# - For global operations, use the `globalOperations` resource.

334

# - For regional operations, use the `regionOperations` resource.

335

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

336

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

337

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

338

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

339

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

340

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

341

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

342

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

343

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

344

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

345

"code": "A String", # [Output Only] The error type identifier for this error.

346

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

347

"message": "A String", # [Output Only] An optional, human-readable error message.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

348

},

349

],

350

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

351

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

352

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

353

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

354

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

355

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

356

"name": "A String", # [Output Only] Name of the operation.

357

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

358

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

359

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

360

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

361

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

362

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

363

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

364

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

365

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

366

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

367

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

368

{

369

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

370

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

371

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

372

{

373

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

374

"value": "A String", # [Output Only] A warning data value corresponding to the key.

375

},

376

],

377

"message": "A String", # [Output Only] A human-readable description of the warning code.

378

},

379

],

380

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="get">get(project, region, router)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

386

<pre>Returns the specified Router resource. Gets a list of available routers by making a list() request.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

387

388

Args:

389

project: string, Project ID for this request. (required)

390

region: string, Name of the region for this request. (required)

391

router: string, Name of the Router resource to return. (required)

392

393

Returns:

394

An object of the form:

395

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

396

{ # Represents a Cloud Router resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

397

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

398

# For more information about Cloud Router, read the Cloud Router overview.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

399

"bgp": { # BGP information specific to this router.

400

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM.

401

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

402

"A String",

403

],

404

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

405

{ # Description-tagged IP ranges for the router to advertise.

406

"description": "A String", # User-specified description for the IP range.

407

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

408

},

409

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

410

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

411

},

412

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

413

{

414

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement.

415

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, which can take one of the following options:

416

# - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets.

417

# - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets.

418

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

419

"A String",

420

],

421

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

422

{ # Description-tagged IP ranges for the router to advertise.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

423

"description": "A String", # User-specified description for the IP range.

424

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

425

},

426

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

427

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

428

"interfaceName": "A String", # Name of the interface the BGP peer is associated with.

429

"ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.

430

"managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer.

431

# - MANAGED_BY_USER is the default value and can be managed by you or other users

432

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

433

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

434

"peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.

435

"peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

436

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

437

],

438

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

439

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

440

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

441

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

442

{

443

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

444

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

445

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

446

"managementType": "A String", # [Output Only] The resource that configures and manages this interface.

447

# - MANAGED_BY_USER is the default value and can be managed directly by users.

448

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

449

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

450

},

451

],

452

"kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.

453

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

454

"nats": [ # A list of NAT services created in this router.

455

{ # 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.

456

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

457

"A String",

458

],

459

"icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.

460

"logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT.

461

"enable": True or False, # Indicates whether or not to export logs. This is false by default.

462

"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:

463

# - ERRORS_ONLY: Export logs only for connection failures.

464

# - TRANSLATIONS_ONLY: Export logs only for successful connections.

465

# - ALL: Export logs for all connections, successful and unsuccessful.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

466

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

467

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

468

"name": "A String", # Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.

469

"natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following values:

470

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

471

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

472

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

473

"A String",

474

],

475

"sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values:

476

# - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat.

477

# - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat.

478

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

479

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

480

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

481

"name": "A String", # URL for the subnetwork resource that will use NAT.

482

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

483

"A String",

484

],

485

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

491

"tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.

492

"udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.

493

},

494

],

495

"network": "A String", # URI of the network to which this router belongs.

496

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

497

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

498

}</pre>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

502

<code class="details" id="getNatMappingInfo">getNatMappingInfo(project, region, router, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

503

<pre>Retrieves runtime Nat mapping information of VM endpoints.

504

505

Args:

506

project: string, Project ID for this request. (required)

507

region: string, Name of the region for this request. (required)

508

router: string, Name of the Router resource to query for Nat Mapping information of VM endpoints. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

509

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

510

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

511

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

512

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

513

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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

514

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

515

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

516

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

517

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

518

519

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.

520

521

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

522

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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

523

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

524

525

Returns:

526

An object of the form:

527

528

{ # Contains a list of VmEndpointNatMappings.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

529

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

530

"kind": "compute#vmEndpointNatMappingsList", # [Output Only] Type of resource. Always compute#vmEndpointNatMappingsList for lists of Nat mappings of VM endpoints.

531

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

532

"result": [ # [Output Only] A list of Nat mapping information of VM endpoints.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

533

{ # Contain information of Nat mapping for a VM endpoint (i.e., NIC).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

534

"instanceName": "A String", # Name of the VM instance which the endpoint belongs to

535

"interfaceNatMappings": [

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

536

{ # Contain information of Nat mapping for an interface of this endpoint.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

537

"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"].

538

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

539

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

540

"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"].

541

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

542

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

543

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

544

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

545

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

546

"sourceVirtualIp": "A String", # Primary IP of the VM for this NIC.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

547

},

548

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

549

},

550

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

551

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

552

"warning": { # [Output Only] Informational warning message.

553

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

554

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

555

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

556

{

557

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

558

"value": "A String", # [Output Only] A warning data value corresponding to the key.

559

},

560

],

561

"message": "A String", # [Output Only] A human-readable description of the warning code.

562

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="getNatMappingInfo_next">getNatMappingInfo_next(previous_request, previous_response)</code>

568

<pre>Retrieves the next page of results.

569

570

Args:

571

previous_request: The request for the previous page. (required)

572

previous_response: The response from the request for the previous page. (required)

573

574

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

575

A request object that you can call 'execute()' on to request the next

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

576

page. Returns None if there are no more items in the collection.

</pre>

</div>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

581

<code class="details" id="getRouterStatus">getRouterStatus(project, region, router)</code>

582

<pre>Retrieves runtime information of the specified router.

583

584

Args:

585

project: string, Project ID for this request. (required)

586

region: string, Name of the region for this request. (required)

587

router: string, Name of the Router resource to query. (required)

588

589

Returns:

590

An object of the form:

591

592

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

593

"kind": "compute#routerStatusResponse", # Type of resource.

594

"result": {

595

"bestRoutes": [ # Best routes for this router's network.

596

{ # Represents a Route resource.

597

#

598

# 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 ==)

599

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

600

"description": "A String", # An optional description of this resource. Provide this field when you create the resource.

601

"destRange": "A String", # The destination range of outgoing packets that this route applies to. Only IPv4 is supported.

602

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

603

"kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.

604

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

605

"network": "A String", # Fully-qualified URL of the network that this route applies to.

606

"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

607

"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:

608

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule

609

# - regions/region/forwardingRules/forwardingRule

610

"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:

611

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/

612

"nextHopIp": "A String", # The network IP address of an instance that should handle matching packets. Only IPv4 is supported.

613

"nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.

614

"nextHopPeering": "A String", # [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.

615

"nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.

616

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

617

"selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.

618

"tags": [ # A list of instance tags to which this route applies.

619

"A String",

620

],

621

"warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.

622

{

623

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

624

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

625

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

626

{

627

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

628

"value": "A String", # [Output Only] A warning data value corresponding to the key.

629

},

630

],

631

"message": "A String", # [Output Only] A human-readable description of the warning code.

},

],

},

],

"bestRoutesForRouter": [ # Best routes learned by this router.

637

{ # Represents a Route resource.

638

#

639

# 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 ==)

640

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

641

"description": "A String", # An optional description of this resource. Provide this field when you create the resource.

642

"destRange": "A String", # The destination range of outgoing packets that this route applies to. Only IPv4 is supported.

643

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

644

"kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.

645

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

646

"network": "A String", # Fully-qualified URL of the network that this route applies to.

647

"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

648

"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:

649

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule

650

# - regions/region/forwardingRules/forwardingRule

651

"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:

652

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/

653

"nextHopIp": "A String", # The network IP address of an instance that should handle matching packets. Only IPv4 is supported.

654

"nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.

655

"nextHopPeering": "A String", # [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.

656

"nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.

657

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

658

"selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.

659

"tags": [ # A list of instance tags to which this route applies.

660

"A String",

661

],

662

"warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.

663

{

664

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

665

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

666

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

667

{

668

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

669

"value": "A String", # [Output Only] A warning data value corresponding to the key.

670

},

671

],

672

"message": "A String", # [Output Only] A human-readable description of the warning code.

},

],

},

],

"bgpPeerStatus": [

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

678

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

679

"advertisedRoutes": [ # Routes that were advertised to the remote BGP peer

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

680

{ # Represents a Route resource.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

681

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

682

# 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 ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

683

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

684

"description": "A String", # An optional description of this resource. Provide this field when you create the resource.

685

"destRange": "A String", # The destination range of outgoing packets that this route applies to. Only IPv4 is supported.

686

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

687

"kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.

688

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

689

"network": "A String", # Fully-qualified URL of the network that this route applies to.

690

"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

691

"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:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

692

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule

693

# - regions/region/forwardingRules/forwardingRule

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

694

"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:

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

695

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

696

"nextHopIp": "A String", # The network IP address of an instance that should handle matching packets. Only IPv4 is supported.

697

"nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.

698

"nextHopPeering": "A String", # [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.

699

"nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.

700

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

701

"selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.

702

"tags": [ # A list of instance tags to which this route applies.

703

"A String",

704

],

705

"warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

706

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

707

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

708

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

709

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

710

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

711

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

712

"value": "A String", # [Output Only] A warning data value corresponding to the key.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

713

},

714

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

715

"message": "A String", # [Output Only] A human-readable description of the warning code.

Sai Cheemalapati

4ba8c23

2017-06-06 18:46:08 -0400

[diff] [blame]

},

],

},

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

720

"ipAddress": "A String", # IP address of the local BGP interface.

721

"linkedVpnTunnel": "A String", # URL of the VPN tunnel that this BGP peer controls.

722

"name": "A String", # Name of this BGP peer. Unique within the Routers resource.

723

"numLearnedRoutes": 42, # Number of routes learned from the remote BGP Peer.

724

"peerIpAddress": "A String", # IP address of the remote BGP interface.

725

"state": "A String", # BGP state as specified in RFC1771.

726

"status": "A String", # Status of the BGP peer: {UP, DOWN}

727

"uptime": "A String", # Time this session has been up. Format: 14 years, 51 weeks, 6 days, 23 hours, 59 minutes, 59 seconds

728

"uptimeSeconds": "A String", # Time this session has been up, in seconds. Format: 145

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

729

},

730

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

731

"natStatus": [

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

732

{ # Status of a NAT contained in this router.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

733

"autoAllocatedNatIps": [ # A list of IPs auto-allocated for NAT. Example: ["1.1.1.1", "129.2.16.89"]

734

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

735

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

736

"drainAutoAllocatedNatIps": [ # A list of IPs auto-allocated for NAT that are in drain mode. Example: ["1.1.1.1", "179.12.26.133"].

737

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

738

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

739

"drainUserAllocatedNatIps": [ # A list of IPs user-allocated for NAT that are in drain mode. Example: ["1.1.1.1", "179.12.26.133"].

740

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

741

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

742

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

743

"name": "A String", # Unique name of this NAT.

744

"numVmEndpointsWithNatMappings": 42, # Number of VM endpoints (i.e., Nics) that can use NAT.

745

"userAllocatedNatIpResources": [ # A list of fully qualified URLs of reserved IP address resources.

746

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

747

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

748

"userAllocatedNatIps": [ # A list of IPs user-allocated for NAT. They will be raw IP strings like "179.12.26.133".

749

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

750

],

Sai Cheemalapati

4ba8c23

2017-06-06 18:46:08 -0400

[diff] [blame]

751

},

752

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

753

"network": "A String", # URI of the network to which this router belongs.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

},

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

759

<code class="details" id="insert">insert(project, region, body=None, requestId=None)</code>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

760

<pre>Creates a Router resource in the specified project and region using the data included in the request.

761

762

Args:

763

project: string, Project ID for this request. (required)

764

region: string, Name of the region for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

765

body: object, The request body.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

766

The object takes the form of:

767

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

768

{ # Represents a Cloud Router resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

769

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

770

# For more information about Cloud Router, read the Cloud Router overview.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

771

"bgp": { # BGP information specific to this router.

772

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM.

773

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

774

"A String",

775

],

776

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

777

{ # Description-tagged IP ranges for the router to advertise.

778

"description": "A String", # User-specified description for the IP range.

779

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

780

},

781

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

782

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

783

},

784

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

785

{

786

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement.

787

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, which can take one of the following options:

788

# - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets.

789

# - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets.

790

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

791

"A String",

792

],

793

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

794

{ # Description-tagged IP ranges for the router to advertise.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

795

"description": "A String", # User-specified description for the IP range.

796

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

797

},

798

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

799

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

800

"interfaceName": "A String", # Name of the interface the BGP peer is associated with.

801

"ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.

802

"managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer.

803

# - MANAGED_BY_USER is the default value and can be managed by you or other users

804

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

805

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

806

"peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.

807

"peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

808

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

809

],

810

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

811

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

812

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

813

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

814

{

815

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

816

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

817

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

818

"managementType": "A String", # [Output Only] The resource that configures and manages this interface.

819

# - MANAGED_BY_USER is the default value and can be managed directly by users.

820

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

821

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

822

},

823

],

824

"kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.

825

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

826

"nats": [ # A list of NAT services created in this router.

827

{ # 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.

828

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

829

"A String",

830

],

831

"icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.

832

"logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT.

833

"enable": True or False, # Indicates whether or not to export logs. This is false by default.

834

"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:

835

# - ERRORS_ONLY: Export logs only for connection failures.

836

# - TRANSLATIONS_ONLY: Export logs only for successful connections.

837

# - ALL: Export logs for all connections, successful and unsuccessful.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

838

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

839

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

840

"name": "A String", # Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.

841

"natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following values:

842

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

843

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

844

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

845

"A String",

846

],

847

"sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values:

848

# - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat.

849

# - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat.

850

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

851

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

852

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

853

"name": "A String", # URL for the subnetwork resource that will use NAT.

854

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

855

"A String",

856

],

857

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

863

"tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.

864

"udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.

865

},

866

],

867

"network": "A String", # URI of the network to which this router belongs.

868

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

869

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

870

}

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

871

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

872

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.

873

874

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.

875

876

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

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

877

878

Returns:

879

An object of the form:

880

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

881

{ # Represents an Operation resource.

882

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

883

# Google Compute Engine has three Operation resources:

884

#

885

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

886

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

887

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

888

#

889

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

890

# - For global operations, use the `globalOperations` resource.

891

# - For regional operations, use the `regionOperations` resource.

892

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

893

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

894

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

895

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

896

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

897

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

898

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

899

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

900

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

901

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

902

"code": "A String", # [Output Only] The error type identifier for this error.

903

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

904

"message": "A String", # [Output Only] An optional, human-readable error message.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

905

},

906

],

907

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

908

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

909

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

910

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

911

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

912

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

913

"name": "A String", # [Output Only] Name of the operation.

914

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

915

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

916

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

917

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

918

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

919

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

920

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

921

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

922

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

923

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

924

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

925

{

926

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

927

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

928

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

929

{

930

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

931

"value": "A String", # [Output Only] A warning data value corresponding to the key.

932

},

933

],

934

"message": "A String", # [Output Only] A human-readable description of the warning code.

935

},

936

],

937

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

942

<code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

943

<pre>Retrieves a list of Router resources available to the specified project.

944

945

Args:

946

project: string, Project ID for this request. (required)

947

region: string, Name of the region for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

948

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

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

949

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

950

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

951

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

952

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.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

953

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

954

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

955

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

956

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

957

958

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.

959

960

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

961

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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

962

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

963

964

Returns:

965

An object of the form:

966

967

{ # Contains a list of Router resources.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

968

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

969

"items": [ # A list of Router resources.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

970

{ # Represents a Cloud Router resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

971

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

972

# For more information about Cloud Router, read the Cloud Router overview.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

973

"bgp": { # BGP information specific to this router.

974

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM.

975

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

976

"A String",

977

],

978

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

979

{ # Description-tagged IP ranges for the router to advertise.

980

"description": "A String", # User-specified description for the IP range.

981

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

982

},

983

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

984

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

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

985

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

986

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

987

{

988

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement.

989

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, which can take one of the following options:

990

# - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets.

991

# - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets.

992

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

993

"A String",

994

],

995

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

996

{ # Description-tagged IP ranges for the router to advertise.

997

"description": "A String", # User-specified description for the IP range.

998

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

999

},

1000

],

1001

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

1002

"interfaceName": "A String", # Name of the interface the BGP peer is associated with.

1003

"ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.

1004

"managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer.

1005

# - MANAGED_BY_USER is the default value and can be managed by you or other users

1006

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

1007

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

1008

"peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.

1009

"peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.

1010

},

1011

],

1012

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

1013

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

1014

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

1015

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

1016

{

1017

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

1018

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

1019

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

1020

"managementType": "A String", # [Output Only] The resource that configures and manages this interface.

1021

# - MANAGED_BY_USER is the default value and can be managed directly by users.

1022

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

1023

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

1024

},

1025

],

1026

"kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.

1027

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

1028

"nats": [ # A list of NAT services created in this router.

1029

{ # 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.

1030

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

1031

"A String",

1032

],

1033

"icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.

1034

"logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT.

1035

"enable": True or False, # Indicates whether or not to export logs. This is false by default.

1036

"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:

1037

# - ERRORS_ONLY: Export logs only for connection failures.

1038

# - TRANSLATIONS_ONLY: Export logs only for successful connections.

1039

# - ALL: Export logs for all connections, successful and unsuccessful.

1040

},

1041

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

1042

"name": "A String", # Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.

1043

"natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following values:

1044

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

1045

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

1046

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

1047

"A String",

1048

],

1049

"sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values:

1050

# - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat.

1051

# - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat.

1052

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

1053

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

1054

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

1055

"name": "A String", # URL for the subnetwork resource that will use NAT.

1056

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

1057

"A String",

1058

],

1059

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

1065

"tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.

1066

"udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.

1067

},

1068

],

1069

"network": "A String", # URI of the network to which this router belongs.

1070

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

1071

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1072

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1073

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1074

"kind": "compute#routerList", # [Output Only] Type of resource. Always compute#router for routers.

1075

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

1076

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

1077

"warning": { # [Output Only] Informational warning message.

1078

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

1079

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1080

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1081

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1082

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

1083

"value": "A String", # [Output Only] A warning data value corresponding to the key.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1084

},

1085

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1086

"message": "A String", # [Output Only] A human-readable description of the warning code.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1087

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

1093

<pre>Retrieves the next page of results.

1094

1095

Args:

1096

previous_request: The request for the previous page. (required)

1097

previous_response: The response from the request for the previous page. (required)

1098

1099

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1100

A request object that you can call 'execute()' on to request the next

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1101

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1106

<code class="details" id="patch">patch(project, region, router, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1107

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

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1108

1109

Args:

1110

project: string, Project ID for this request. (required)

1111

region: string, Name of the region for this request. (required)

Sai Cheemalapati

4ba8c23

2017-06-06 18:46:08 -0400

[diff] [blame]

1112

router: string, Name of the Router resource to patch. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1113

body: object, The request body.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1114

The object takes the form of:

1115

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1116

{ # Represents a Cloud Router resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1117

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1118

# For more information about Cloud Router, read the Cloud Router overview.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1119

"bgp": { # BGP information specific to this router.

1120

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM.

1121

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

1122

"A String",

1123

],

1124

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

1125

{ # Description-tagged IP ranges for the router to advertise.

1126

"description": "A String", # User-specified description for the IP range.

1127

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1128

},

1129

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1130

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

1131

},

1132

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

1133

{

1134

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement.

1135

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, which can take one of the following options:

1136

# - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets.

1137

# - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets.

1138

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

1139

"A String",

1140

],

1141

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1142

{ # Description-tagged IP ranges for the router to advertise.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1143

"description": "A String", # User-specified description for the IP range.

1144

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1145

},

1146

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1147

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

1148

"interfaceName": "A String", # Name of the interface the BGP peer is associated with.

1149

"ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.

1150

"managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer.

1151

# - MANAGED_BY_USER is the default value and can be managed by you or other users

1152

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

1153

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

1154

"peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.

1155

"peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1156

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1157

],

1158

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

1159

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

1160

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

1161

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

1162

{

1163

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

1164

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

1165

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

1166

"managementType": "A String", # [Output Only] The resource that configures and manages this interface.

1167

# - MANAGED_BY_USER is the default value and can be managed directly by users.

1168

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

1169

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

1170

},

1171

],

1172

"kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.

1173

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

1174

"nats": [ # A list of NAT services created in this router.

1175

{ # 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.

1176

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

1177

"A String",

1178

],

1179

"icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.

1180

"logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT.

1181

"enable": True or False, # Indicates whether or not to export logs. This is false by default.

1182

"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:

1183

# - ERRORS_ONLY: Export logs only for connection failures.

1184

# - TRANSLATIONS_ONLY: Export logs only for successful connections.

1185

# - ALL: Export logs for all connections, successful and unsuccessful.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1186

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1187

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

1188

"name": "A String", # Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.

1189

"natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following values:

1190

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

1191

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

1192

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

1193

"A String",

1194

],

1195

"sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values:

1196

# - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat.

1197

# - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat.

1198

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

1199

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

1200

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

1201

"name": "A String", # URL for the subnetwork resource that will use NAT.

1202

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

1203

"A String",

1204

],

1205

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

1211

"tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.

1212

"udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.

1213

},

1214

],

1215

"network": "A String", # URI of the network to which this router belongs.

1216

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

1217

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1218

}

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1219

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1220

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.

1221

1222

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.

1223

1224

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

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1225

1226

Returns:

1227

An object of the form:

1228

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1229

{ # Represents an Operation resource.

1230

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1231

# Google Compute Engine has three Operation resources:

1232

#

1233

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

1234

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1235

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

1236

#

1237

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1238

# - For global operations, use the `globalOperations` resource.

1239

# - For regional operations, use the `regionOperations` resource.

1240

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1241

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1242

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1243

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1244

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1245

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1246

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1247

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1248

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1249

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1250

"code": "A String", # [Output Only] The error type identifier for this error.

1251

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1252

"message": "A String", # [Output Only] An optional, human-readable error message.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1253

},

1254

],

1255

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1256

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1257

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

1258

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

1259

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1260

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1261

"name": "A String", # [Output Only] Name of the operation.

1262

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1263

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

1264

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

1265

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1266

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1267

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

1268

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1269

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1270

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

1271

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1272

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1273

{

1274

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

1275

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1276

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

1277

{

1278

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

1279

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1280

},

1281

],

1282

"message": "A String", # [Output Only] A human-readable description of the warning code.

1283

},

1284

],

1285

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1290

<code class="details" id="preview">preview(project, region, router, body=None)</code>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1291

<pre>Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.

1292

1293

Args:

1294

project: string, Project ID for this request. (required)

1295

region: string, Name of the region for this request. (required)

1296

router: string, Name of the Router resource to query. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1297

body: object, The request body.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1298

The object takes the form of:

1299

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1300

{ # Represents a Cloud Router resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1301

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1302

# For more information about Cloud Router, read the Cloud Router overview.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1303

"bgp": { # BGP information specific to this router.

1304

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM.

1305

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

1306

"A String",

1307

],

1308

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

1309

{ # Description-tagged IP ranges for the router to advertise.

1310

"description": "A String", # User-specified description for the IP range.

1311

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1312

},

1313

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1314

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

1315

},

1316

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

1317

{

1318

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement.

1319

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, which can take one of the following options:

1320

# - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets.

1321

# - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets.

1322

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

1323

"A String",

1324

],

1325

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1326

{ # Description-tagged IP ranges for the router to advertise.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1327

"description": "A String", # User-specified description for the IP range.

1328

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1329

},

1330

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1331

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

1332

"interfaceName": "A String", # Name of the interface the BGP peer is associated with.

1333

"ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.

1334

"managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer.

1335

# - MANAGED_BY_USER is the default value and can be managed by you or other users

1336

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

1337

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

1338

"peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.

1339

"peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1340

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1341

],

1342

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

1343

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

1344

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

1345

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

1346

{

1347

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

1348

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

1349

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

1350

"managementType": "A String", # [Output Only] The resource that configures and manages this interface.

1351

# - MANAGED_BY_USER is the default value and can be managed directly by users.

1352

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

1353

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

1354

},

1355

],

1356

"kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.

1357

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

1358

"nats": [ # A list of NAT services created in this router.

1359

{ # 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.

1360

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

1361

"A String",

1362

],

1363

"icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.

1364

"logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT.

1365

"enable": True or False, # Indicates whether or not to export logs. This is false by default.

1366

"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:

1367

# - ERRORS_ONLY: Export logs only for connection failures.

1368

# - TRANSLATIONS_ONLY: Export logs only for successful connections.

1369

# - ALL: Export logs for all connections, successful and unsuccessful.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1370

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1371

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

1372

"name": "A String", # Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.

1373

"natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following values:

1374

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

1375

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

1376

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

1377

"A String",

1378

],

1379

"sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values:

1380

# - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat.

1381

# - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat.

1382

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

1383

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

1384

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

1385

"name": "A String", # URL for the subnetwork resource that will use NAT.

1386

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

1387

"A String",

1388

],

1389

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

1395

"tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.

1396

"udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.

1397

},

1398

],

1399

"network": "A String", # URI of the network to which this router belongs.

1400

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

1401

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1402

}

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

Returns:

An object of the form:

1407

1408

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1409

"resource": { # Represents a Cloud Router resource. # Preview of given router.

1410

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1411

# For more information about Cloud Router, read the Cloud Router overview.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1412

"bgp": { # BGP information specific to this router.

1413

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM.

1414

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

1415

"A String",

1416

],

1417

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

1418

{ # Description-tagged IP ranges for the router to advertise.

1419

"description": "A String", # User-specified description for the IP range.

1420

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1421

},

1422

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1423

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

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1424

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1425

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

1426

{

1427

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement.

1428

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, which can take one of the following options:

1429

# - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets.

1430

# - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets.

1431

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

1432

"A String",

1433

],

1434

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

1435

{ # Description-tagged IP ranges for the router to advertise.

1436

"description": "A String", # User-specified description for the IP range.

1437

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

1438

},

1439

],

1440

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

1441

"interfaceName": "A String", # Name of the interface the BGP peer is associated with.

1442

"ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.

1443

"managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer.

1444

# - MANAGED_BY_USER is the default value and can be managed by you or other users

1445

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

1446

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

1447

"peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.

1448

"peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.

1449

},

1450

],

1451

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

1452

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

1453

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

1454

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

1455

{

1456

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

1457

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

1458

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

1459

"managementType": "A String", # [Output Only] The resource that configures and manages this interface.

1460

# - MANAGED_BY_USER is the default value and can be managed directly by users.

1461

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

1462

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

1463

},

1464

],

1465

"kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.

1466

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

1467

"nats": [ # A list of NAT services created in this router.

1468

{ # 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.

1469

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

1470

"A String",

1471

],

1472

"icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.

1473

"logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT.

1474

"enable": True or False, # Indicates whether or not to export logs. This is false by default.

1475

"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:

1476

# - ERRORS_ONLY: Export logs only for connection failures.

1477

# - TRANSLATIONS_ONLY: Export logs only for successful connections.

1478

# - ALL: Export logs for all connections, successful and unsuccessful.

1479

},

1480

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

1481

"name": "A String", # Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.

1482

"natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following values:

1483

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

1484

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

1485

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

1486

"A String",

1487

],

1488

"sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values:

1489

# - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat.

1490

# - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat.

1491

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

1492

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

1493

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

1494

"name": "A String", # URL for the subnetwork resource that will use NAT.

1495

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

1496

"A String",

1497

],

1498

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

1504

"tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.

1505

"udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.

1506

},

1507

],

1508

"network": "A String", # URI of the network to which this router belongs.

1509

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

1510

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1511

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1516

<code class="details" id="update">update(project, region, router, body=None, requestId=None)</code>

1517

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

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1518

1519

Args:

1520

project: string, Project ID for this request. (required)

1521

region: string, Name of the region for this request. (required)

1522

router: string, Name of the Router resource to update. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1523

body: object, The request body.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1524

The object takes the form of:

1525

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1526

{ # Represents a Cloud Router resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1527

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1528

# For more information about Cloud Router, read the Cloud Router overview.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1529

"bgp": { # BGP information specific to this router.

1530

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM.

1531

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

1532

"A String",

1533

],

1534

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

1535

{ # Description-tagged IP ranges for the router to advertise.

1536

"description": "A String", # User-specified description for the IP range.

1537

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1538

},

1539

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1540

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

1541

},

1542

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

1543

{

1544

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement.

1545

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, which can take one of the following options:

1546

# - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets.

1547

# - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets.

1548

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

1549

"A String",

1550

],

1551

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1552

{ # Description-tagged IP ranges for the router to advertise.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1553

"description": "A String", # User-specified description for the IP range.

1554

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1555

},

1556

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1557

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

1558

"interfaceName": "A String", # Name of the interface the BGP peer is associated with.

1559

"ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.

1560

"managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer.

1561

# - MANAGED_BY_USER is the default value and can be managed by you or other users

1562

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

1563

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

1564

"peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.

1565

"peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1566

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1567

],

1568

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

1569

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

1570

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

1571

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

1572

{

1573

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

1574

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

1575

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

1576

"managementType": "A String", # [Output Only] The resource that configures and manages this interface.

1577

# - MANAGED_BY_USER is the default value and can be managed directly by users.

1578

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

1579

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

1580

},

1581

],

1582

"kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.

1583

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

1584

"nats": [ # A list of NAT services created in this router.

1585

{ # 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.

1586

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

1587

"A String",

1588

],

1589

"icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.

1590

"logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT.

1591

"enable": True or False, # Indicates whether or not to export logs. This is false by default.

1592

"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:

1593

# - ERRORS_ONLY: Export logs only for connection failures.

1594

# - TRANSLATIONS_ONLY: Export logs only for successful connections.

1595

# - ALL: Export logs for all connections, successful and unsuccessful.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1596

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1597

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

1598

"name": "A String", # Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.

1599

"natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following values:

1600

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

1601

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

1602

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

1603

"A String",

1604

],

1605

"sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values:

1606

# - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat.

1607

# - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat.

1608

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

1609

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

1610

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

1611

"name": "A String", # URL for the subnetwork resource that will use NAT.

1612

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

1613

"A String",

1614

],

1615

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

1621

"tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.

1622

"udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.

1623

},

1624

],

1625

"network": "A String", # URI of the network to which this router belongs.

1626

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

1627

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1628

}

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1629

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1630

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.

1631

1632

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.

1633

1634

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

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1635

1636

Returns:

1637

An object of the form:

1638

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1639

{ # Represents an Operation resource.

1640

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1641

# Google Compute Engine has three Operation resources:

1642

#

1643

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

1644

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1645

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

1646

#

1647

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1648

# - For global operations, use the `globalOperations` resource.

1649

# - For regional operations, use the `regionOperations` resource.

1650

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1651

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1652

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1653

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1654

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1655

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1656

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1657

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1658

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1659

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1660

"code": "A String", # [Output Only] The error type identifier for this error.

1661

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1662

"message": "A String", # [Output Only] An optional, human-readable error message.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1663

},

1664

],

1665

},

Bu Sun Kim