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

2017-01-06 09:58:29 -0800

[diff] [blame]

82

<p class="firstline">Retrieves the list of all BackendService resources, regional and global, available to the specified project.</p>

83

84

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

85

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

86

Bu Sun Kim

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

[diff] [blame]

87

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

88

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

89

Bu Sun Kim

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

[diff] [blame]

90

<code><a href="#deleteSignedUrlKey">deleteSignedUrlKey(project, backendService, keyName, requestId=None)</a></code></p>

91

<p class="firstline">Deletes a key for validating requests with signed URLs for this backend service.</p>

92

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

93

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

Bu Sun Kim

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

[diff] [blame]

94

<p class="firstline">Returns the specified BackendService resource. Gets a list of available backend services.</p>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

95

Dan O'Meara

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

[diff] [blame]

96

<code><a href="#getHealth">getHealth(project, backendService, body=None)</a></code></p>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

97

<p class="firstline">Gets the most recent health check results for this BackendService.</p>

98

Dan O'Meara

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

[diff] [blame]

99

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

100

<p class="firstline">Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read Understanding backend services for more information.</p>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

101

Bu Sun Kim

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

[diff] [blame^]

102

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

103

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

104

105

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

106

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

107

Dan O'Meara

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

[diff] [blame]

108

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

109

<p class="firstline">Patches the specified BackendService resource with the data included in the request. There are several Understanding backend services to keep in mind when updating a backend service. Read Understanding backend services for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.</p>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

110

Dan O'Meara

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

[diff] [blame]

111

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

Bu Sun Kim

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

[diff] [blame]

112

<p class="firstline">Sets the security policy for the specified backend service.</p>

113

Dan O'Meara

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

[diff] [blame]

114

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

115

<p class="firstline">Updates the specified BackendService resource with the data included in the request. There are several Understanding backend services to keep in mind when updating a backend service. Read Understanding backend services for more information.</p>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

116

<h3>Method Details</h3>

117

Dan O'Meara

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

[diff] [blame]

118

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

Bu Sun Kim

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

[diff] [blame]

119

<pre>Adds a key for validating requests with signed URLs for this backend service.

120

121

Args:

122

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

123

backendService: string, Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035. (required)

Dan O'Meara

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

[diff] [blame]

124

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

125

The object takes the form of:

126

127

{ # Represents a customer-supplied Signing Key used by Cloud CDN Signed URLs

Bu Sun Kim

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

[diff] [blame^]

128

"keyName": "A String", # Name of the key. 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.

129

"keyValue": "A String", # 128-bit key value used for signing the URL. The key value must be a valid RFC 4648 Section 5 base64url encoded string.

Bu Sun Kim

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

[diff] [blame]

130

}

131

132

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.

133

134

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.

135

136

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

137

138

Returns:

139

An object of the form:

140

141

{ # Represents an Operation resource.

142

#

Dan O'Meara

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

[diff] [blame]

143

# Google Compute Engine has three Operation resources:

144

#

145

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

146

#

Bu Sun Kim

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

[diff] [blame]

147

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

148

#

149

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

150

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

151

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

152

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

Bu Sun Kim

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

[diff] [blame]

153

#

Dan O'Meara

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

[diff] [blame]

154

# 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^]

155

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

156

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

157

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

158

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

159

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

160

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

Bu Sun Kim

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

[diff] [blame]

161

{

Bu Sun Kim

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

[diff] [blame^]

162

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

163

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

164

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

Bu Sun Kim

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

[diff] [blame]

165

},

166

],

167

},

Bu Sun Kim

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

[diff] [blame^]

168

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

169

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

170

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

171

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

172

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

173

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

174

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

175

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

176

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

177

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

178

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

179

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

180

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

181

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

182

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

183

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

184

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

185

{

186

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

187

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

188

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

189

{

190

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

191

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

192

},

193

],

194

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

195

},

196

],

197

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame^]

202

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

203

<pre>Retrieves the list of all BackendService resources, regional and global, available to the specified project.

204

205

Args:

206

project: string, Name of the project scoping this request. (required)

Dan O'Meara

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

[diff] [blame]

207

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

2017-01-06 09:58:29 -0800

[diff] [blame]

208

Dan O'Meara

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

[diff] [blame]

209

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

210

Dan O'Meara

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

[diff] [blame]

211

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

2017-01-06 09:58:29 -0800

[diff] [blame]

212

Bu Sun Kim

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

[diff] [blame^]

213

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]

214

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

215

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

216

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

217

218

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.

219

220

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

221

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.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

222

223

Returns:

224

An object of the form:

225

226

{ # Contains a list of BackendServicesScopedList.

Bu Sun Kim

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

[diff] [blame^]

227

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

228

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

229

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

230

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

231

{ # Represents a Backend Service resource.

232

#

233

# A backend service contains configuration values for Google Cloud Platform load balancing services.

234

#

235

# Backend services in Google Compute Engine can be either regionally or globally scoped.

236

#

237

# * [Global](/compute/docs/reference/rest/{$api_version}/backendServices) * [Regional](/compute/docs/reference/rest/{$api_version}/regionBackendServices)

238

#

239

# For more information, read Backend Services.

240

#

241

# (== resource_for {$api_version}.backendService ==)

242

"affinityCookieTtlSec": 42, # If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value is one day (86,400).

243

"backends": [ # The list of backends that serve this BackendService.

244

{ # Message containing information of one individual backend.

245

"balancingMode": "A String", # Specifies the balancing mode for the backend.

246

#

247

# When choosing a balancing mode, you need to consider the loadBalancingScheme, and protocol for the backend service, as well as the type of backend (instance group or NEG).

248

#

249

#

250

# - If the load balancing mode is CONNECTION, then the load is spread based on how many concurrent connections the backend can handle.

251

# You can use the CONNECTION balancing mode if the protocol for the backend service is SSL, TCP, or UDP.

252

#

253

# If the loadBalancingScheme for the backend service is EXTERNAL (SSL Proxy and TCP Proxy load balancers), you must also specify exactly one of the following parameters: maxConnections (except for regional managed instance groups), maxConnectionsPerInstance, or maxConnectionsPerEndpoint.

254

#

255

# If the loadBalancingScheme for the backend service is INTERNAL (internal TCP/UDP load balancers), you cannot specify any additional parameters.

256

#

257

# - If the load balancing mode is RATE, the load is spread based on the rate of HTTP requests per second (RPS).

258

# You can use the RATE balancing mode if the protocol for the backend service is HTTP or HTTPS. You must specify exactly one of the following parameters: maxRate (except for regional managed instance groups), maxRatePerInstance, or maxRatePerEndpoint.

259

#

260

# - If the load balancing mode is UTILIZATION, the load is spread based on the backend utilization of instances in an instance group.

261

# You can use the UTILIZATION balancing mode if the loadBalancingScheme of the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED and the backends are instance groups. There are no restrictions on the backend service protocol.

262

"capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].

263

#

264

# This cannot be used for internal load balancing.

265

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

266

"failover": True or False, # This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService.

267

"group": "A String", # The fully-qualified URL of an instance group or network endpoint group (NEG) resource. The type of backend that a backend service supports depends on the backend service's loadBalancingScheme.

268

#

269

#

270

# - When the loadBalancingScheme for the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, the backend can be either an instance group or a NEG. The backends on the backend service must be either all instance groups or all NEGs. You cannot mix instance group and NEG backends on the same backend service.

271

#

272

#

273

# - When the loadBalancingScheme for the backend service is INTERNAL, the backend must be an instance group in the same region as the backend service. NEGs are not supported.

274

#

275

# You must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported.

276

"maxConnections": 42, # Defines a target maximum number of simultaneous connections that the backend can handle. Valid for network endpoint group and instance group backends (except for regional managed instance groups). If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnectionsPerInstance, or maxConnectionsPerEndpoint.

277

#

278

# Not available if the backend's balancingMode is RATE. If the loadBalancingScheme is INTERNAL, then maxConnections is not supported, even though the backend requires a balancing mode of CONNECTION.

279

"maxConnectionsPerEndpoint": 42, # Defines a target maximum number of simultaneous connections for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a maximum number of target maximum simultaneous connections for the NEG. If the backend's balancingMode is CONNECTION, and the backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerInstance.

280

#

281

# Not available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerEndpoint even though its backends require a balancing mode of CONNECTION.

282

"maxConnectionsPerInstance": 42, # Defines a target maximum number of simultaneous connections for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum number of simultaneous connections for the whole instance group. If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerEndpoint.

283

#

284

# Not available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerInstance even though its backends require a balancing mode of CONNECTION.

285

"maxRate": 42, # Defines a maximum number of HTTP requests per second (RPS) that the backend can handle. Valid for network endpoint group and instance group backends (except for regional managed instance groups). Must not be defined if the backend is a managed instance group that uses autoscaling based on load balancing.

286

#

287

# If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is RATE, you must specify maxRate, maxRatePerInstance, or maxRatePerEndpoint.

288

#

289

# Not available if the backend's balancingMode is CONNECTION.

290

"maxRatePerEndpoint": 3.14, # Defines a maximum target for requests per second (RPS) for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a target maximum rate for the NEG.

291

#

292

# If the backend's balancingMode is RATE, you must specify either this parameter, maxRate (except for regional managed instance groups), or maxRatePerInstance.

293

#

294

# Not available if the backend's balancingMode is CONNECTION.

295

"maxRatePerInstance": 3.14, # Defines a maximum target for requests per second (RPS) for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum rate for the whole instance group.

296

#

297

# If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is RATE, you must specify either this parameter, maxRate (except for regional managed instance groups), or maxRatePerEndpoint.

298

#

299

# Not available if the backend's balancingMode is CONNECTION.

300

"maxUtilization": 3.14, # Defines the maximum average backend utilization of a backend VM in an instance group. The valid range is [0.0, 1.0]. This is an optional parameter if the backend's balancingMode is UTILIZATION.

301

#

302

# This parameter can be used in conjunction with maxRate, maxRatePerInstance, maxConnections (except for regional managed instance groups), or maxConnectionsPerInstance.

303

},

304

],

305

"cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService.

306

"cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy.

307

"includeHost": True or False, # If true, requests to different hosts will be cached separately.

308

"includeProtocol": True or False, # If true, http and https requests will be cached separately.

309

"includeQueryString": True or False, # If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.

310

"queryStringBlacklist": [ # Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

311

"A String",

312

],

313

"queryStringWhitelist": [ # Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

"A String",

],

},

"signedUrlCacheMaxAgeSec": "A String", # Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.

318

"signedUrlKeyNames": [ # [Output Only] Names of the keys for signing request URLs.

"A String",

],

},

"circuitBreakers": { # Settings controlling the volume of connections to a backend service. # Settings controlling the volume of connections to a backend service. If not set, this feature is considered disabled.

323

#

324

# This field is applicable to either:

325

# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.

326

# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

327

"maxConnections": 42, # The maximum number of connections to the backend service. If not specified, there is no limit.

328

"maxPendingRequests": 42, # The maximum number of pending requests allowed to the backend service. If not specified, there is no limit.

329

"maxRequests": 42, # The maximum number of parallel requests that allowed to the backend service. If not specified, there is no limit.

330

"maxRequestsPerConnection": 42, # Maximum requests for a single connection to the backend service. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive.

331

"maxRetries": 42, # The maximum number of parallel retries allowed to the backend cluster. If not specified, the default is 1.

332

},

333

"connectionDraining": { # Message containing connection draining configuration.

334

"drainingTimeoutSec": 42, # The amount of time in seconds to allow existing connections to persist while on unhealthy backend VMs. Only applicable if the protocol is not UDP. The valid range is [0, 3600].

335

},

336

"consistentHash": { # This message defines settings for a consistent hash style load balancer. # Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field is only applicable when localityLbPolicy is set to MAGLEV or RING_HASH.

337

#

338

# This field is applicable to either:

339

# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.

340

# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

341

"httpCookie": { # The information about the HTTP Cookie on which the hash function is based for load balancing policies that use a consistent hash. # Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE.

342

"name": "A String", # Name of the cookie.

343

"path": "A String", # Path to set for the cookie.

344

"ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie.

345

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

346

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

347

},

348

},

349

"httpHeaderName": "A String", # The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.

350

"minimumRingSize": "A String", # The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node.

351

},

352

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

353

"customRequestHeaders": [ # Headers that the HTTP/S load balancer should add to proxied requests.

354

"A String",

355

],

356

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

357

"enableCDN": True or False, # If true, enables Cloud CDN for the backend service. Only applicable if the loadBalancingScheme is EXTERNAL and the protocol is HTTP or HTTPS.

358

"failoverPolicy": { # Applicable only to Failover for Internal TCP/UDP Load Balancing. On failover or failback, this field indicates whether connection draining will be honored. GCP has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes). # Applicable only to Failover for Internal TCP/UDP Load Balancing. Requires at least one backend instance group to be defined as a backup (failover) backend.

359

"disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol is TCP.

360

#

361

# The default is false.

362

"dropTrafficIfUnhealthy": True or False, # Applicable only to Failover for Internal TCP/UDP Load Balancing. If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy. If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy.

363

#

364

# The default is false.

365

"failoverRatio": 3.14, # Applicable only to Failover for Internal TCP/UDP Load Balancing. The value of the field must be in the range [0, 1]. If the value is 0, the load balancer performs a failover when the number of healthy primary VMs equals zero. For all other values, the load balancer performs a failover when the total number of healthy primary VMs is less than this ratio.

366

},

367

"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet.

368

#

369

# To see the latest fingerprint, make a get() request to retrieve a BackendService.

370

"healthChecks": [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently at most one health check can be specified. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet NEG backends must not have a health check. A health check must

371

"A String",

372

],

373

"iap": { # Identity-Aware Proxy

374

"enabled": True or False,

375

"oauth2ClientId": "A String",

376

"oauth2ClientSecret": "A String",

377

"oauth2ClientSecretSha256": "A String", # [Output Only] SHA256 hash value for the field oauth2_client_secret above.

378

},

379

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

380

"kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.

381

"loadBalancingScheme": "A String", # Specifies the load balancer type. Choose EXTERNAL for load balancers that receive traffic from external clients. Choose INTERNAL for Internal TCP/UDP Load Balancing. Choose INTERNAL_MANAGED for Internal HTTP(S) Load Balancing. Choose INTERNAL_SELF_MANAGED for Traffic Director. A backend service created for one type of load balancing cannot be used with another. For more information, refer to Choosing a load balancer.

382

"localityLbPolicy": "A String", # The load balancing algorithm used within the scope of the locality. The possible values are:

383

# - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default.

384

# - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.

385

# - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.

386

# - RANDOM: The load balancer selects a random healthy host.

387

# - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer.

388

# - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, refer to https://ai.google/research/pubs/pub44824

389

#

390

# This field is applicable to either:

391

# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.

392

# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

393

#

394

# If sessionAffinity is not NONE, and this field is not set to >MAGLEV or RING_HASH, session affinity settings will not take effect.

395

"logConfig": { # The available logging options for the load balancer traffic served by this backend service. # This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver.

396

"enable": True or False, # This field denotes whether to enable logging for the load balancer traffic served by this backend service.

397

"sampleRate": 3.14, # This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.

398

},

399

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

400

"network": "A String", # The URL of the network to which this backend service belongs. This field can only be spcified when the load balancing scheme is set to INTERNAL.

401

"outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled.

402

#

403

# This field is applicable to either:

404

# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.

405

# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

406

"baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s.

407

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

408

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

409

},

410

"consecutiveErrors": 42, # Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.

411

"consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3.

412

"enforcingConsecutiveErrors": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.

413

"enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.

414

"enforcingSuccessRate": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.

415

"interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second.

416

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

417

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

418

},

419

"maxEjectionPercent": 42, # Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%.

420

"successRateMinimumHosts": 42, # The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.

421

"successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100.

422

"successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.

423

},

424

"port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.

425

#

426

# This cannot be used if the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing).

427

"portName": "A String", # A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the loadBalancingScheme is EXTERNAL, INTERNAL_MANAGED, or INTERNAL_SELF_MANAGED and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs.

#

#

#

# Must be omitted when the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing).

432

"protocol": "A String", # The protocol this BackendService uses to communicate with backends.

433

#

434

# Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, or UDP. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancer or for Traffic Director for more information.

435

"region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

436

"securityPolicy": "A String", # [Output Only] The resource URL for the security policy associated with this backend service.

437

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

438

"sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Session affinity is not applicable if the --protocol is UDP.

439

#

440

# When the loadBalancingScheme is EXTERNAL, possible values are NONE, CLIENT_IP, or GENERATED_COOKIE. You can use GENERATED_COOKIE if the protocol is HTTP or HTTPS.

441

#

442

# When the loadBalancingScheme is INTERNAL, possible values are NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.

443

#

444

# When the loadBalancingScheme is INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, possible values are NONE, CLIENT_IP, GENERATED_COOKIE, HEADER_FIELD, or HTTP_COOKIE.

445

"timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information read, Backend service settings The default is 30 seconds.

446

},

447

],

448

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

449

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

450

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

451

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

452

{

Bu Sun Kim

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

[diff] [blame^]

453

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

454

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

455

},

456

],

Bu Sun Kim

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

[diff] [blame^]

457

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

458

},

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

459

},

460

},

Bu Sun Kim

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

[diff] [blame^]

461

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

462

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

463

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

464

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

465

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

466

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

467

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

Bu Sun Kim

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

[diff] [blame]

468

{

Bu Sun Kim

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

[diff] [blame^]

469

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

470

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

471

},

472

],

Bu Sun Kim

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

[diff] [blame^]

473

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

474

},

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

}</pre>

</div>

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

480

<pre>Retrieves the next page of results.

481

482

Args:

483

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

484

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

485

486

Returns:

Bu Sun Kim

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

[diff] [blame^]

487

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

488

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

</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

493

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

494

<pre>Deletes the specified BackendService resource.

495

496

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

497

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

498

backendService: string, Name of the BackendService resource to delete. (required)

Bu Sun Kim

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

[diff] [blame]

499

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.

500

501

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.

502

503

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

504

505

Returns:

506

An object of the form:

507

Bu Sun Kim

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

[diff] [blame]

508

{ # Represents an Operation resource.

509

#

Dan O'Meara

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

[diff] [blame]

510

# Google Compute Engine has three Operation resources:

511

#

512

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

513

#

Bu Sun Kim

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

[diff] [blame]

514

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

515

#

516

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

517

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

518

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

519

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

Bu Sun Kim

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

[diff] [blame]

520

#

Dan O'Meara

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

[diff] [blame]

521

# 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^]

522

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

523

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

524

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

525

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

526

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

527

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

Bu Sun Kim

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

[diff] [blame]

528

{

Bu Sun Kim

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

[diff] [blame^]

529

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

530

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

531

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

Bu Sun Kim

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

[diff] [blame]

532

},

533

],

534

},

Bu Sun Kim

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

[diff] [blame^]

535

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

536

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

537

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

538

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

539

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

540

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

541

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

542

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

543

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

544

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

545

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

546

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

547

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

548

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

549

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

550

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

551

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

552

{

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

},

563

],

564

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

<code class="details" id="deleteSignedUrlKey">deleteSignedUrlKey(project, backendService, keyName, requestId=None)</code>

570

<pre>Deletes a key for validating requests with signed URLs for this backend service.

571

572

Args:

573

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

574

backendService: string, Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035. (required)

575

keyName: string, The name of the Signed URL Key to delete. (required)

576

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.

577

578

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.

579

580

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

581

582

Returns:

583

An object of the form:

584

585

{ # Represents an Operation resource.

586

#

Dan O'Meara

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

[diff] [blame]

587

# Google Compute Engine has three Operation resources:

588

#

589

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

590

#

Bu Sun Kim

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

[diff] [blame]

591

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

592

#

593

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

594

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

595

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

596

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

Bu Sun Kim

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

[diff] [blame]

597

#

Dan O'Meara

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

[diff] [blame]

598

# 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^]

599

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

600

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

601

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

602

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

603

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

604

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

605

{

Bu Sun Kim

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

[diff] [blame^]

606

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

607

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

608

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

609

},

610

],

611

},

Bu Sun Kim

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

[diff] [blame^]

612

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

613

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

614

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

615

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

616

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

617

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

618

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

619

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

620

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

621

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

622

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

623

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

624

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

625

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

626

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

627

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

628

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

629

{

630

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

631

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

632

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

633

{

634

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

635

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

636

},

637

],

638

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

639

},

640

],

641

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

}</pre>

</div>

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

Bu Sun Kim

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

[diff] [blame]

647

<pre>Returns the specified BackendService resource. Gets a list of available backend services.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

648

649

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

650

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

651

backendService: string, Name of the BackendService resource to return. (required)

652

653

Returns:

654

An object of the form:

655

Dan O'Meara

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

[diff] [blame]

656

{ # Represents a Backend Service resource.

Bu Sun Kim

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

[diff] [blame^]

657

#

Dan O'Meara

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

[diff] [blame]

658

# A backend service contains configuration values for Google Cloud Platform load balancing services.

Bu Sun Kim

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

[diff] [blame^]

659

#

Dan O'Meara

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

[diff] [blame]

660

# Backend services in Google Compute Engine can be either regionally or globally scoped.

Bu Sun Kim

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

[diff] [blame^]

661

#

Dan O'Meara

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

[diff] [blame]

662

# * [Global](/compute/docs/reference/rest/{$api_version}/backendServices) * [Regional](/compute/docs/reference/rest/{$api_version}/regionBackendServices)

Bu Sun Kim

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

[diff] [blame^]

663

#

Dan O'Meara

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

[diff] [blame]

664

# For more information, read Backend Services.

Bu Sun Kim

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

[diff] [blame^]

665

#

Dan O'Meara

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

[diff] [blame]

666

# (== resource_for {$api_version}.backendService ==)

Bu Sun Kim

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

[diff] [blame^]

667

"affinityCookieTtlSec": 42, # If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value is one day (86,400).

668

"backends": [ # The list of backends that serve this BackendService.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

669

{ # Message containing information of one individual backend.

Bu Sun Kim

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

[diff] [blame^]

670

"balancingMode": "A String", # Specifies the balancing mode for the backend.

Dan O'Meara

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

[diff] [blame]

671

#

672

# When choosing a balancing mode, you need to consider the loadBalancingScheme, and protocol for the backend service, as well as the type of backend (instance group or NEG).

673

#

674

#

675

# - If the load balancing mode is CONNECTION, then the load is spread based on how many concurrent connections the backend can handle.

676

# You can use the CONNECTION balancing mode if the protocol for the backend service is SSL, TCP, or UDP.

677

#

678

# If the loadBalancingScheme for the backend service is EXTERNAL (SSL Proxy and TCP Proxy load balancers), you must also specify exactly one of the following parameters: maxConnections (except for regional managed instance groups), maxConnectionsPerInstance, or maxConnectionsPerEndpoint.

679

#

680

# If the loadBalancingScheme for the backend service is INTERNAL (internal TCP/UDP load balancers), you cannot specify any additional parameters.

681

#

682

# - If the load balancing mode is RATE, the load is spread based on the rate of HTTP requests per second (RPS).

683

# You can use the RATE balancing mode if the protocol for the backend service is HTTP or HTTPS. You must specify exactly one of the following parameters: maxRate (except for regional managed instance groups), maxRatePerInstance, or maxRatePerEndpoint.

684

#

685

# - If the load balancing mode is UTILIZATION, the load is spread based on the backend utilization of instances in an instance group.

686

# You can use the UTILIZATION balancing mode if the loadBalancingScheme of the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED and the backends are instance groups. There are no restrictions on the backend service protocol.

Bu Sun Kim

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

[diff] [blame^]

687

"capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].

688

#

689

# This cannot be used for internal load balancing.

690

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

691

"failover": True or False, # This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService.

692

"group": "A String", # The fully-qualified URL of an instance group or network endpoint group (NEG) resource. The type of backend that a backend service supports depends on the backend service's loadBalancingScheme.

693

#

694

#

695

# - When the loadBalancingScheme for the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, the backend can be either an instance group or a NEG. The backends on the backend service must be either all instance groups or all NEGs. You cannot mix instance group and NEG backends on the same backend service.

696

#

697

#

698

# - When the loadBalancingScheme for the backend service is INTERNAL, the backend must be an instance group in the same region as the backend service. NEGs are not supported.

699

#

700

# You must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported.

701

"maxConnections": 42, # Defines a target maximum number of simultaneous connections that the backend can handle. Valid for network endpoint group and instance group backends (except for regional managed instance groups). If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnectionsPerInstance, or maxConnectionsPerEndpoint.

702

#

703

# Not available if the backend's balancingMode is RATE. If the loadBalancingScheme is INTERNAL, then maxConnections is not supported, even though the backend requires a balancing mode of CONNECTION.

704

"maxConnectionsPerEndpoint": 42, # Defines a target maximum number of simultaneous connections for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a maximum number of target maximum simultaneous connections for the NEG. If the backend's balancingMode is CONNECTION, and the backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerInstance.

705

#

706

# Not available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerEndpoint even though its backends require a balancing mode of CONNECTION.

707

"maxConnectionsPerInstance": 42, # Defines a target maximum number of simultaneous connections for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum number of simultaneous connections for the whole instance group. If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerEndpoint.

708

#

709

# Not available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerInstance even though its backends require a balancing mode of CONNECTION.

710

"maxRate": 42, # Defines a maximum number of HTTP requests per second (RPS) that the backend can handle. Valid for network endpoint group and instance group backends (except for regional managed instance groups). Must not be defined if the backend is a managed instance group that uses autoscaling based on load balancing.

711

#

712

# If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is RATE, you must specify maxRate, maxRatePerInstance, or maxRatePerEndpoint.

713

#

714

# Not available if the backend's balancingMode is CONNECTION.

715

"maxRatePerEndpoint": 3.14, # Defines a maximum target for requests per second (RPS) for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a target maximum rate for the NEG.

716

#

717

# If the backend's balancingMode is RATE, you must specify either this parameter, maxRate (except for regional managed instance groups), or maxRatePerInstance.

718

#

719

# Not available if the backend's balancingMode is CONNECTION.

720

"maxRatePerInstance": 3.14, # Defines a maximum target for requests per second (RPS) for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum rate for the whole instance group.

721

#

722

# If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is RATE, you must specify either this parameter, maxRate (except for regional managed instance groups), or maxRatePerEndpoint.

723

#

724

# Not available if the backend's balancingMode is CONNECTION.

725

"maxUtilization": 3.14, # Defines the maximum average backend utilization of a backend VM in an instance group. The valid range is [0.0, 1.0]. This is an optional parameter if the backend's balancingMode is UTILIZATION.

726

#

727

# This parameter can be used in conjunction with maxRate, maxRatePerInstance, maxConnections (except for regional managed instance groups), or maxConnectionsPerInstance.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

728

},

729

],

Bu Sun Kim

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

[diff] [blame^]

730

"cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService.

731

"cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy.

732

"includeHost": True or False, # If true, requests to different hosts will be cached separately.

733

"includeProtocol": True or False, # If true, http and https requests will be cached separately.

734

"includeQueryString": True or False, # If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.

735

"queryStringBlacklist": [ # Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

736

"A String",

737

],

738

"queryStringWhitelist": [ # Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

"A String",

],

},

"signedUrlCacheMaxAgeSec": "A String", # Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.

743

"signedUrlKeyNames": [ # [Output Only] Names of the keys for signing request URLs.

744

"A String",

745

],

Sai Cheemalapati

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

[diff] [blame]

746

},

Bu Sun Kim

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

[diff] [blame^]

747

"circuitBreakers": { # Settings controlling the volume of connections to a backend service. # Settings controlling the volume of connections to a backend service. If not set, this feature is considered disabled.

748

#

749

# This field is applicable to either:

750

# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.

751

# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

752

"maxConnections": 42, # The maximum number of connections to the backend service. If not specified, there is no limit.

753

"maxPendingRequests": 42, # The maximum number of pending requests allowed to the backend service. If not specified, there is no limit.

754

"maxRequests": 42, # The maximum number of parallel requests that allowed to the backend service. If not specified, there is no limit.

755

"maxRequestsPerConnection": 42, # Maximum requests for a single connection to the backend service. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive.

756

"maxRetries": 42, # The maximum number of parallel retries allowed to the backend cluster. If not specified, the default is 1.

757

},

758

"connectionDraining": { # Message containing connection draining configuration.

759

"drainingTimeoutSec": 42, # The amount of time in seconds to allow existing connections to persist while on unhealthy backend VMs. Only applicable if the protocol is not UDP. The valid range is [0, 3600].

760

},

761

"consistentHash": { # This message defines settings for a consistent hash style load balancer. # Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field is only applicable when localityLbPolicy is set to MAGLEV or RING_HASH.

762

#

763

# This field is applicable to either:

764

# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.

765

# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

766

"httpCookie": { # The information about the HTTP Cookie on which the hash function is based for load balancing policies that use a consistent hash. # Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE.

767

"name": "A String", # Name of the cookie.

768

"path": "A String", # Path to set for the cookie.

769

"ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie.

770

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

771

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

772

},

773

},

774

"httpHeaderName": "A String", # The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.

775

"minimumRingSize": "A String", # The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node.

776

},

777

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

778

"customRequestHeaders": [ # Headers that the HTTP/S load balancer should add to proxied requests.

779

"A String",

Bu Sun Kim

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

[diff] [blame]

780

],

Bu Sun Kim

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

[diff] [blame^]

781

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

782

"enableCDN": True or False, # If true, enables Cloud CDN for the backend service. Only applicable if the loadBalancingScheme is EXTERNAL and the protocol is HTTP or HTTPS.

783

"failoverPolicy": { # Applicable only to Failover for Internal TCP/UDP Load Balancing. On failover or failback, this field indicates whether connection draining will be honored. GCP has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes). # Applicable only to Failover for Internal TCP/UDP Load Balancing. Requires at least one backend instance group to be defined as a backup (failover) backend.

784

"disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol is TCP.

785

#

786

# The default is false.

787

"dropTrafficIfUnhealthy": True or False, # Applicable only to Failover for Internal TCP/UDP Load Balancing. If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy. If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy.

788

#

789

# The default is false.

790

"failoverRatio": 3.14, # Applicable only to Failover for Internal TCP/UDP Load Balancing. The value of the field must be in the range [0, 1]. If the value is 0, the load balancer performs a failover when the number of healthy primary VMs equals zero. For all other values, the load balancer performs a failover when the total number of healthy primary VMs is less than this ratio.

791

},

792

"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet.

793

#

Bu Sun Kim

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

[diff] [blame]

794

# To see the latest fingerprint, make a get() request to retrieve a BackendService.

Bu Sun Kim

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

[diff] [blame^]

795

"healthChecks": [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently at most one health check can be specified. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet NEG backends must not have a health check. A health check must

796

"A String",

797

],

798

"iap": { # Identity-Aware Proxy

799

"enabled": True or False,

800

"oauth2ClientId": "A String",

801

"oauth2ClientSecret": "A String",

802

"oauth2ClientSecretSha256": "A String", # [Output Only] SHA256 hash value for the field oauth2_client_secret above.

Dan O'Meara

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

[diff] [blame]

803

},

Bu Sun Kim

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

[diff] [blame^]

804

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

805

"kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.

806

"loadBalancingScheme": "A String", # Specifies the load balancer type. Choose EXTERNAL for load balancers that receive traffic from external clients. Choose INTERNAL for Internal TCP/UDP Load Balancing. Choose INTERNAL_MANAGED for Internal HTTP(S) Load Balancing. Choose INTERNAL_SELF_MANAGED for Traffic Director. A backend service created for one type of load balancing cannot be used with another. For more information, refer to Choosing a load balancer.

807

"localityLbPolicy": "A String", # The load balancing algorithm used within the scope of the locality. The possible values are:

808

# - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default.

809

# - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.

810

# - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.

811

# - RANDOM: The load balancer selects a random healthy host.

812

# - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer.

813

# - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, refer to https://ai.google/research/pubs/pub44824

814

#

815

# This field is applicable to either:

816

# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.

817

# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

818

#

819

# If sessionAffinity is not NONE, and this field is not set to >MAGLEV or RING_HASH, session affinity settings will not take effect.

820

"logConfig": { # The available logging options for the load balancer traffic served by this backend service. # This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver.

821

"enable": True or False, # This field denotes whether to enable logging for the load balancer traffic served by this backend service.

822

"sampleRate": 3.14, # This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.

Dan O'Meara

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

[diff] [blame]

823

},

Bu Sun Kim

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

[diff] [blame^]

824

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

825

"network": "A String", # The URL of the network to which this backend service belongs. This field can only be spcified when the load balancing scheme is set to INTERNAL.

826

"outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled.

827

#

828

# This field is applicable to either:

829

# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.

830

# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

831

"baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s.

832

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

833

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

834

},

835

"consecutiveErrors": 42, # Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.

836

"consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3.

837

"enforcingConsecutiveErrors": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.

838

"enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.

839

"enforcingSuccessRate": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.

840

"interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second.

841

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

842

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

843

},

844

"maxEjectionPercent": 42, # Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%.

845

"successRateMinimumHosts": 42, # The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.

846

"successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100.

847

"successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.

848

},

849

"port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.

850

#

851

# This cannot be used if the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing).

852

"portName": "A String", # A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the loadBalancingScheme is EXTERNAL, INTERNAL_MANAGED, or INTERNAL_SELF_MANAGED and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs.

#

#

#

# Must be omitted when the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing).

857

"protocol": "A String", # The protocol this BackendService uses to communicate with backends.

858

#

859

# Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, or UDP. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancer or for Traffic Director for more information.

860

"region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

861

"securityPolicy": "A String", # [Output Only] The resource URL for the security policy associated with this backend service.

862

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

863

"sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Session affinity is not applicable if the --protocol is UDP.

864

#

865

# When the loadBalancingScheme is EXTERNAL, possible values are NONE, CLIENT_IP, or GENERATED_COOKIE. You can use GENERATED_COOKIE if the protocol is HTTP or HTTPS.

866

#

867

# When the loadBalancingScheme is INTERNAL, possible values are NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.

868

#

869

# When the loadBalancingScheme is INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, possible values are NONE, CLIENT_IP, GENERATED_COOKIE, HEADER_FIELD, or HTTP_COOKIE.

870

"timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information read, Backend service settings The default is 30 seconds.

}</pre>

</div>

<code class="details" id="getHealth">getHealth(project, backendService, body=None)</code>

876

<pre>Gets the most recent health check results for this BackendService.

877

878

Example request body:

879

880

{ "group": "/zones/us-east1-b/instanceGroups/lb-backend-example" }

881

882

Args:

883

project: string, A parameter (required)

884

backendService: string, Name of the BackendService resource to which the queried instance belongs. (required)

885

body: object, The request body.

886

The object takes the form of:

887

888

{

889

"group": "A String", # A URI referencing one of the instance groups or network endpoint groups listed in the backend service.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

890

}

891

Bu Sun Kim

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

[diff] [blame^]

892

893

Returns:

894

An object of the form:

895

896

{

897

"healthStatus": [ # Health state of the backend instances or endpoints in requested instance or network endpoint group, determined based on configured health checks.

898

{

899

"healthState": "A String", # Health state of the instance.

900

"instance": "A String", # URL of the instance resource.

901

"ipAddress": "A String", # A forwarding rule IP address assigned to this instance.

902

"port": 42, # The named port of the instance group, not necessarily the port that is health-checked.

903

},

904

],

905

"kind": "compute#backendServiceGroupHealth", # [Output Only] Type of resource. Always compute#backendServiceGroupHealth for the health of backend services.

}</pre>

</div>

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

911

<pre>Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read Understanding backend services for more information.

912

913

Args:

914

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

915

body: object, The request body.

916

The object takes the form of:

917

918

{ # Represents a Backend Service resource.

919

#

920

# A backend service contains configuration values for Google Cloud Platform load balancing services.

921

#

922

# Backend services in Google Compute Engine can be either regionally or globally scoped.

923

#

924

# * [Global](/compute/docs/reference/rest/{$api_version}/backendServices) * [Regional](/compute/docs/reference/rest/{$api_version}/regionBackendServices)

925

#

926

# For more information, read Backend Services.

927

#

928

# (== resource_for {$api_version}.backendService ==)

929

"affinityCookieTtlSec": 42, # If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value is one day (86,400).

930

"backends": [ # The list of backends that serve this BackendService.

931

{ # Message containing information of one individual backend.

932

"balancingMode": "A String", # Specifies the balancing mode for the backend.

933

#

934

# When choosing a balancing mode, you need to consider the loadBalancingScheme, and protocol for the backend service, as well as the type of backend (instance group or NEG).

935

#

936

#

937

# - If the load balancing mode is CONNECTION, then the load is spread based on how many concurrent connections the backend can handle.

938

# You can use the CONNECTION balancing mode if the protocol for the backend service is SSL, TCP, or UDP.

939

#

940

# If the loadBalancingScheme for the backend service is EXTERNAL (SSL Proxy and TCP Proxy load balancers), you must also specify exactly one of the following parameters: maxConnections (except for regional managed instance groups), maxConnectionsPerInstance, or maxConnectionsPerEndpoint.

941

#

942

# If the loadBalancingScheme for the backend service is INTERNAL (internal TCP/UDP load balancers), you cannot specify any additional parameters.

943

#

944

# - If the load balancing mode is RATE, the load is spread based on the rate of HTTP requests per second (RPS).

945

# You can use the RATE balancing mode if the protocol for the backend service is HTTP or HTTPS. You must specify exactly one of the following parameters: maxRate (except for regional managed instance groups), maxRatePerInstance, or maxRatePerEndpoint.

946

#

947

# - If the load balancing mode is UTILIZATION, the load is spread based on the backend utilization of instances in an instance group.

948

# You can use the UTILIZATION balancing mode if the loadBalancingScheme of the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED and the backends are instance groups. There are no restrictions on the backend service protocol.

949

"capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].

950

#

951

# This cannot be used for internal load balancing.

952

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

953

"failover": True or False, # This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService.

954

"group": "A String", # The fully-qualified URL of an instance group or network endpoint group (NEG) resource. The type of backend that a backend service supports depends on the backend service's loadBalancingScheme.

955

#

956

#

957

# - When the loadBalancingScheme for the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, the backend can be either an instance group or a NEG. The backends on the backend service must be either all instance groups or all NEGs. You cannot mix instance group and NEG backends on the same backend service.

958

#

959

#

960

# - When the loadBalancingScheme for the backend service is INTERNAL, the backend must be an instance group in the same region as the backend service. NEGs are not supported.

961

#

962

# You must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported.

963

"maxConnections": 42, # Defines a target maximum number of simultaneous connections that the backend can handle. Valid for network endpoint group and instance group backends (except for regional managed instance groups). If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnectionsPerInstance, or maxConnectionsPerEndpoint.

964

#

965

# Not available if the backend's balancingMode is RATE. If the loadBalancingScheme is INTERNAL, then maxConnections is not supported, even though the backend requires a balancing mode of CONNECTION.

966

"maxConnectionsPerEndpoint": 42, # Defines a target maximum number of simultaneous connections for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a maximum number of target maximum simultaneous connections for the NEG. If the backend's balancingMode is CONNECTION, and the backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerInstance.

967

#

968

# Not available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerEndpoint even though its backends require a balancing mode of CONNECTION.

969

"maxConnectionsPerInstance": 42, # Defines a target maximum number of simultaneous connections for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum number of simultaneous connections for the whole instance group. If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerEndpoint.

970

#

971

# Not available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerInstance even though its backends require a balancing mode of CONNECTION.

972

"maxRate": 42, # Defines a maximum number of HTTP requests per second (RPS) that the backend can handle. Valid for network endpoint group and instance group backends (except for regional managed instance groups). Must not be defined if the backend is a managed instance group that uses autoscaling based on load balancing.

973

#

974

# If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is RATE, you must specify maxRate, maxRatePerInstance, or maxRatePerEndpoint.

975

#

976

# Not available if the backend's balancingMode is CONNECTION.

977

"maxRatePerEndpoint": 3.14, # Defines a maximum target for requests per second (RPS) for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a target maximum rate for the NEG.

978

#

979

# If the backend's balancingMode is RATE, you must specify either this parameter, maxRate (except for regional managed instance groups), or maxRatePerInstance.

980

#

981

# Not available if the backend's balancingMode is CONNECTION.

982

"maxRatePerInstance": 3.14, # Defines a maximum target for requests per second (RPS) for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum rate for the whole instance group.

983

#

984

# If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is RATE, you must specify either this parameter, maxRate (except for regional managed instance groups), or maxRatePerEndpoint.

985

#

986

# Not available if the backend's balancingMode is CONNECTION.

987

"maxUtilization": 3.14, # Defines the maximum average backend utilization of a backend VM in an instance group. The valid range is [0.0, 1.0]. This is an optional parameter if the backend's balancingMode is UTILIZATION.

988

#

989

# This parameter can be used in conjunction with maxRate, maxRatePerInstance, maxConnections (except for regional managed instance groups), or maxConnectionsPerInstance.

990

},

991

],

992

"cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService.

993

"cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy.

994

"includeHost": True or False, # If true, requests to different hosts will be cached separately.

995

"includeProtocol": True or False, # If true, http and https requests will be cached separately.

996

"includeQueryString": True or False, # If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.

997

"queryStringBlacklist": [ # Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

998

"A String",

999

],

1000

"queryStringWhitelist": [ # Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

"A String",

],

},

"signedUrlCacheMaxAgeSec": "A String", # Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.

1005

"signedUrlKeyNames": [ # [Output Only] Names of the keys for signing request URLs.

"A String",

],

},

"circuitBreakers": { # Settings controlling the volume of connections to a backend service. # Settings controlling the volume of connections to a backend service. If not set, this feature is considered disabled.

1010

#

1011

# This field is applicable to either:

1012

# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.

1013

# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

1014

"maxConnections": 42, # The maximum number of connections to the backend service. If not specified, there is no limit.

1015

"maxPendingRequests": 42, # The maximum number of pending requests allowed to the backend service. If not specified, there is no limit.

1016

"maxRequests": 42, # The maximum number of parallel requests that allowed to the backend service. If not specified, there is no limit.

1017

"maxRequestsPerConnection": 42, # Maximum requests for a single connection to the backend service. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive.

1018

"maxRetries": 42, # The maximum number of parallel retries allowed to the backend cluster. If not specified, the default is 1.

1019

},

1020

"connectionDraining": { # Message containing connection draining configuration.

1021

"drainingTimeoutSec": 42, # The amount of time in seconds to allow existing connections to persist while on unhealthy backend VMs. Only applicable if the protocol is not UDP. The valid range is [0, 3600].

1022

},

1023

"consistentHash": { # This message defines settings for a consistent hash style load balancer. # Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field is only applicable when localityLbPolicy is set to MAGLEV or RING_HASH.

1024

#

1025

# This field is applicable to either:

1026

# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.

1027

# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

1028

"httpCookie": { # The information about the HTTP Cookie on which the hash function is based for load balancing policies that use a consistent hash. # Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE.

1029

"name": "A String", # Name of the cookie.

1030

"path": "A String", # Path to set for the cookie.

1031

"ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie.

1032

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1033

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1034

},

1035

},

1036

"httpHeaderName": "A String", # The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.

1037

"minimumRingSize": "A String", # The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node.

1038

},

1039

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

1040

"customRequestHeaders": [ # Headers that the HTTP/S load balancer should add to proxied requests.

1041

"A String",

1042

],

1043

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

1044

"enableCDN": True or False, # If true, enables Cloud CDN for the backend service. Only applicable if the loadBalancingScheme is EXTERNAL and the protocol is HTTP or HTTPS.

1045

"failoverPolicy": { # Applicable only to Failover for Internal TCP/UDP Load Balancing. On failover or failback, this field indicates whether connection draining will be honored. GCP has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes). # Applicable only to Failover for Internal TCP/UDP Load Balancing. Requires at least one backend instance group to be defined as a backup (failover) backend.

1046

"disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol is TCP.

1047

#

1048

# The default is false.

1049

"dropTrafficIfUnhealthy": True or False, # Applicable only to Failover for Internal TCP/UDP Load Balancing. If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy. If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy.

1050

#

1051

# The default is false.

1052

"failoverRatio": 3.14, # Applicable only to Failover for Internal TCP/UDP Load Balancing. The value of the field must be in the range [0, 1]. If the value is 0, the load balancer performs a failover when the number of healthy primary VMs equals zero. For all other values, the load balancer performs a failover when the total number of healthy primary VMs is less than this ratio.

1053

},

1054

"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet.

1055

#

1056

# To see the latest fingerprint, make a get() request to retrieve a BackendService.

1057

"healthChecks": [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently at most one health check can be specified. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet NEG backends must not have a health check. A health check must

1058

"A String",

1059

],

1060

"iap": { # Identity-Aware Proxy

1061

"enabled": True or False,

1062

"oauth2ClientId": "A String",

1063

"oauth2ClientSecret": "A String",

1064

"oauth2ClientSecretSha256": "A String", # [Output Only] SHA256 hash value for the field oauth2_client_secret above.

1065

},

1066

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

1067

"kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.

1068

"loadBalancingScheme": "A String", # Specifies the load balancer type. Choose EXTERNAL for load balancers that receive traffic from external clients. Choose INTERNAL for Internal TCP/UDP Load Balancing. Choose INTERNAL_MANAGED for Internal HTTP(S) Load Balancing. Choose INTERNAL_SELF_MANAGED for Traffic Director. A backend service created for one type of load balancing cannot be used with another. For more information, refer to Choosing a load balancer.

1069

"localityLbPolicy": "A String", # The load balancing algorithm used within the scope of the locality. The possible values are:

1070

# - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default.

1071

# - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.

1072

# - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.

1073

# - RANDOM: The load balancer selects a random healthy host.

1074

# - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer.

1075

# - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, refer to https://ai.google/research/pubs/pub44824

1076

#

1077

# This field is applicable to either:

1078

# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.

1079

# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

1080

#

1081

# If sessionAffinity is not NONE, and this field is not set to >MAGLEV or RING_HASH, session affinity settings will not take effect.

1082

"logConfig": { # The available logging options for the load balancer traffic served by this backend service. # This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver.

1083

"enable": True or False, # This field denotes whether to enable logging for the load balancer traffic served by this backend service.

1084

"sampleRate": 3.14, # This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.

1085

},

1086

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

1087

"network": "A String", # The URL of the network to which this backend service belongs. This field can only be spcified when the load balancing scheme is set to INTERNAL.

1088

"outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled.

1089

#

1090

# This field is applicable to either:

1091

# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.

1092

# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

1093

"baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s.

1094

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1095

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1096

},

1097

"consecutiveErrors": 42, # Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.

1098

"consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3.

1099

"enforcingConsecutiveErrors": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.

1100

"enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.

1101

"enforcingSuccessRate": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.

1102

"interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second.

1103

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1104

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1105

},

1106

"maxEjectionPercent": 42, # Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%.

1107

"successRateMinimumHosts": 42, # The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.

1108

"successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100.

1109

"successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.

1110

},

1111

"port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.

1112

#

1113

# This cannot be used if the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing).

1114

"portName": "A String", # A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the loadBalancingScheme is EXTERNAL, INTERNAL_MANAGED, or INTERNAL_SELF_MANAGED and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs.

#

#

#

# Must be omitted when the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing).

1119

"protocol": "A String", # The protocol this BackendService uses to communicate with backends.

1120

#

1121

# Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, or UDP. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancer or for Traffic Director for more information.

1122

"region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

1123

"securityPolicy": "A String", # [Output Only] The resource URL for the security policy associated with this backend service.

1124

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

1125

"sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Session affinity is not applicable if the --protocol is UDP.

1126

#

1127

# When the loadBalancingScheme is EXTERNAL, possible values are NONE, CLIENT_IP, or GENERATED_COOKIE. You can use GENERATED_COOKIE if the protocol is HTTP or HTTPS.

1128

#

1129

# When the loadBalancingScheme is INTERNAL, possible values are NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.

1130

#

1131

# When the loadBalancingScheme is INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, possible values are NONE, CLIENT_IP, GENERATED_COOKIE, HEADER_FIELD, or HTTP_COOKIE.

1132

"timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information read, Backend service settings The default is 30 seconds.

1133

}

1134

Bu Sun Kim

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

[diff] [blame]

1135

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.

1136

1137

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.

1138

1139

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1140

1141

Returns:

1142

An object of the form:

1143

Bu Sun Kim

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

[diff] [blame]

1144

{ # Represents an Operation resource.

1145

#

Dan O'Meara

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

[diff] [blame]

1146

# Google Compute Engine has three Operation resources:

1147

#

1148

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

1149

#

Bu Sun Kim

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

[diff] [blame]

1150

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

1151

#

1152

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

1153

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

1154

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

1155

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

Bu Sun Kim

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

[diff] [blame]

1156

#

Dan O'Meara

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

[diff] [blame]

1157

# 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^]

1158

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

1159

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

1160

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

1161

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

1162

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

1163

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1164

{

Bu Sun Kim

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

[diff] [blame^]

1165

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

1166

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

1167

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1168

},

1169

],

1170

},

Bu Sun Kim

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

[diff] [blame^]

1171

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

1172

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

1173

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

1174

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

1175

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

1176

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

1177

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

1178

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

1179

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

1180

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

1181

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

1182

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

1183

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

1184

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

1185

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

1186

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

1187

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

1188

{

1189

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

1190

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

1191

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

1192

{

1193

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

1194

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

1195

},

1196

],

1197

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

1198

},

1199

],

1200

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame^]

1205

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1206

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

1207

1208

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1209

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

Dan O'Meara

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

[diff] [blame]

1210

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

Takashi Matsuo

0669410

2015-09-11 13:55:40 -0700

[diff] [blame]

1211

Dan O'Meara

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

[diff] [blame]

1212

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

Takashi Matsuo

0669410

2015-09-11 13:55:40 -0700

[diff] [blame]

1213

Dan O'Meara

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

[diff] [blame]

1214

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-02-19 16:02:29 -0800

[diff] [blame]

1215

Bu Sun Kim

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

[diff] [blame^]

1216

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

1217

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

1218

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

1219

1220

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.

1221

1222

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

1223

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.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1224

1225

Returns:

1226

An object of the form:

1227

1228

{ # Contains a list of BackendService resources.

Bu Sun Kim

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

[diff] [blame^]

1229

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

1230

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

Dan O'Meara

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

[diff] [blame]

1231

{ # Represents a Backend Service resource.

Bu Sun Kim

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

[diff] [blame^]

1232

#

1233

# A backend service contains configuration values for Google Cloud Platform load balancing services.

1234

#

1235

# Backend services in Google Compute Engine can be either regionally or globally scoped.

1236

#

1237

# * [Global](/compute/docs/reference/rest/{$api_version}/backendServices) * [Regional](/compute/docs/reference/rest/{$api_version}/regionBackendServices)

1238

#

1239

# For more information, read Backend Services.

1240

#

1241

# (== resource_for {$api_version}.backendService ==)

1242

"affinityCookieTtlSec": 42, # If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value is one day (86,400).

1243

"backends": [ # The list of backends that serve this BackendService.

1244

{ # Message containing information of one individual backend.

1245

"balancingMode": "A String", # Specifies the balancing mode for the backend.

1246

#

1247

# When choosing a balancing mode, you need to consider the loadBalancingScheme, and protocol for the backend service, as well as the type of backend (instance group or NEG).

1248

#

1249

#

1250

# - If the load balancing mode is CONNECTION, then the load is spread based on how many concurrent connections the backend can handle.

1251

# You can use the CONNECTION balancing mode if the protocol for the backend service is SSL, TCP, or UDP.

1252

#

1253

# If the loadBalancingScheme for the backend service is EXTERNAL (SSL Proxy and TCP Proxy load balancers), you must also specify exactly one of the following parameters: maxConnections (except for regional managed instance groups), maxConnectionsPerInstance, or maxConnectionsPerEndpoint.

1254

#

1255

# If the loadBalancingScheme for the backend service is INTERNAL (internal TCP/UDP load balancers), you cannot specify any additional parameters.

1256

#

1257

# - If the load balancing mode is RATE, the load is spread based on the rate of HTTP requests per second (RPS).

1258

# You can use the RATE balancing mode if the protocol for the backend service is HTTP or HTTPS. You must specify exactly one of the following parameters: maxRate (except for regional managed instance groups), maxRatePerInstance, or maxRatePerEndpoint.

1259

#

1260

# - If the load balancing mode is UTILIZATION, the load is spread based on the backend utilization of instances in an instance group.

1261

# You can use the UTILIZATION balancing mode if the loadBalancingScheme of the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED and the backends are instance groups. There are no restrictions on the backend service protocol.

1262

"capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].

1263

#

1264

# This cannot be used for internal load balancing.

1265

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

1266

"failover": True or False, # This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService.

1267

"group": "A String", # The fully-qualified URL of an instance group or network endpoint group (NEG) resource. The type of backend that a backend service supports depends on the backend service's loadBalancingScheme.

1268

#

1269

#

1270

# - When the loadBalancingScheme for the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, the backend can be either an instance group or a NEG. The backends on the backend service must be either all instance groups or all NEGs. You cannot mix instance group and NEG backends on the same backend service.

1271

#

1272

#

1273

# - When the loadBalancingScheme for the backend service is INTERNAL, the backend must be an instance group in the same region as the backend service. NEGs are not supported.

1274

#

1275

# You must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported.

1276

"maxConnections": 42, # Defines a target maximum number of simultaneous connections that the backend can handle. Valid for network endpoint group and instance group backends (except for regional managed instance groups). If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnectionsPerInstance, or maxConnectionsPerEndpoint.

1277

#

1278

# Not available if the backend's balancingMode is RATE. If the loadBalancingScheme is INTERNAL, then maxConnections is not supported, even though the backend requires a balancing mode of CONNECTION.

1279

"maxConnectionsPerEndpoint": 42, # Defines a target maximum number of simultaneous connections for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a maximum number of target maximum simultaneous connections for the NEG. If the backend's balancingMode is CONNECTION, and the backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerInstance.

1280

#

1281

# Not available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerEndpoint even though its backends require a balancing mode of CONNECTION.

1282

"maxConnectionsPerInstance": 42, # Defines a target maximum number of simultaneous connections for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum number of simultaneous connections for the whole instance group. If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerEndpoint.

1283

#

1284

# Not available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerInstance even though its backends require a balancing mode of CONNECTION.

1285

"maxRate": 42, # Defines a maximum number of HTTP requests per second (RPS) that the backend can handle. Valid for network endpoint group and instance group backends (except for regional managed instance groups). Must not be defined if the backend is a managed instance group that uses autoscaling based on load balancing.

1286

#

1287

# If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is RATE, you must specify maxRate, maxRatePerInstance, or maxRatePerEndpoint.

1288

#

1289

# Not available if the backend's balancingMode is CONNECTION.

1290

"maxRatePerEndpoint": 3.14, # Defines a maximum target for requests per second (RPS) for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a target maximum rate for the NEG.

1291

#

1292

# If the backend's balancingMode is RATE, you must specify either this parameter, maxRate (except for regional managed instance groups), or maxRatePerInstance.

1293

#

1294

# Not available if the backend's balancingMode is CONNECTION.

1295

"maxRatePerInstance": 3.14, # Defines a maximum target for requests per second (RPS) for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum rate for the whole instance group.

1296

#

1297

# If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is RATE, you must specify either this parameter, maxRate (except for regional managed instance groups), or maxRatePerEndpoint.

1298

#

1299

# Not available if the backend's balancingMode is CONNECTION.

1300

"maxUtilization": 3.14, # Defines the maximum average backend utilization of a backend VM in an instance group. The valid range is [0.0, 1.0]. This is an optional parameter if the backend's balancingMode is UTILIZATION.

1301

#

1302

# This parameter can be used in conjunction with maxRate, maxRatePerInstance, maxConnections (except for regional managed instance groups), or maxConnectionsPerInstance.

Sai Cheemalapati

ea3a5e1

2016-10-12 14:05:53 -0700

[diff] [blame]

1303

},

Bu Sun Kim

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

[diff] [blame^]

1304

],

1305

"cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService.

1306

"cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy.

1307

"includeHost": True or False, # If true, requests to different hosts will be cached separately.

1308

"includeProtocol": True or False, # If true, http and https requests will be cached separately.

1309

"includeQueryString": True or False, # If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.

1310

"queryStringBlacklist": [ # Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

1311

"A String",

Bu Sun Kim

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

[diff] [blame]

1312

],

Bu Sun Kim

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

[diff] [blame^]

1313

"queryStringWhitelist": [ # Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

1314

"A String",

1315

],

Sai Cheemalapati

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

[diff] [blame]

1316

},

Bu Sun Kim

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

[diff] [blame^]

1317

"signedUrlCacheMaxAgeSec": "A String", # Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.

1318

"signedUrlKeyNames": [ # [Output Only] Names of the keys for signing request URLs.

1319

"A String",

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1320

],

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1321

},

Bu Sun Kim

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

[diff] [blame^]

1322

"circuitBreakers": { # Settings controlling the volume of connections to a backend service. # Settings controlling the volume of connections to a backend service. If not set, this feature is considered disabled.

1323

#

1324

# This field is applicable to either:

1325

# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.

1326

# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

1327

"maxConnections": 42, # The maximum number of connections to the backend service. If not specified, there is no limit.

1328

"maxPendingRequests": 42, # The maximum number of pending requests allowed to the backend service. If not specified, there is no limit.

1329

"maxRequests": 42, # The maximum number of parallel requests that allowed to the backend service. If not specified, there is no limit.

1330

"maxRequestsPerConnection": 42, # Maximum requests for a single connection to the backend service. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive.

1331

"maxRetries": 42, # The maximum number of parallel retries allowed to the backend cluster. If not specified, the default is 1.

1332

},

1333

"connectionDraining": { # Message containing connection draining configuration.

1334

"drainingTimeoutSec": 42, # The amount of time in seconds to allow existing connections to persist while on unhealthy backend VMs. Only applicable if the protocol is not UDP. The valid range is [0, 3600].

1335

},

1336

"consistentHash": { # This message defines settings for a consistent hash style load balancer. # Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field is only applicable when localityLbPolicy is set to MAGLEV or RING_HASH.

1337

#

1338

# This field is applicable to either:

1339

# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.

1340

# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

1341

"httpCookie": { # The information about the HTTP Cookie on which the hash function is based for load balancing policies that use a consistent hash. # Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE.

1342

"name": "A String", # Name of the cookie.

1343

"path": "A String", # Path to set for the cookie.

1344

"ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie.

1345

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1346

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1347

},

1348

},

1349

"httpHeaderName": "A String", # The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.

1350

"minimumRingSize": "A String", # The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node.

1351

},

1352

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

1353

"customRequestHeaders": [ # Headers that the HTTP/S load balancer should add to proxied requests.

1354

"A String",

1355

],

1356

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

1357

"enableCDN": True or False, # If true, enables Cloud CDN for the backend service. Only applicable if the loadBalancingScheme is EXTERNAL and the protocol is HTTP or HTTPS.

1358

"failoverPolicy": { # Applicable only to Failover for Internal TCP/UDP Load Balancing. On failover or failback, this field indicates whether connection draining will be honored. GCP has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes). # Applicable only to Failover for Internal TCP/UDP Load Balancing. Requires at least one backend instance group to be defined as a backup (failover) backend.

1359

"disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol is TCP.

1360

#

1361

# The default is false.

1362

"dropTrafficIfUnhealthy": True or False, # Applicable only to Failover for Internal TCP/UDP Load Balancing. If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy. If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy.

1363

#

1364

# The default is false.

1365

"failoverRatio": 3.14, # Applicable only to Failover for Internal TCP/UDP Load Balancing. The value of the field must be in the range [0, 1]. If the value is 0, the load balancer performs a failover when the number of healthy primary VMs equals zero. For all other values, the load balancer performs a failover when the total number of healthy primary VMs is less than this ratio.

1366

},

1367

"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet.

1368

#

1369

# To see the latest fingerprint, make a get() request to retrieve a BackendService.

1370

"healthChecks": [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently at most one health check can be specified. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet NEG backends must not have a health check. A health check must

1371

"A String",

1372

],

1373

"iap": { # Identity-Aware Proxy

1374

"enabled": True or False,

1375

"oauth2ClientId": "A String",

1376

"oauth2ClientSecret": "A String",

1377

"oauth2ClientSecretSha256": "A String", # [Output Only] SHA256 hash value for the field oauth2_client_secret above.

1378

},

1379

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

1380

"kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.

1381

"loadBalancingScheme": "A String", # Specifies the load balancer type. Choose EXTERNAL for load balancers that receive traffic from external clients. Choose INTERNAL for Internal TCP/UDP Load Balancing. Choose INTERNAL_MANAGED for Internal HTTP(S) Load Balancing. Choose INTERNAL_SELF_MANAGED for Traffic Director. A backend service created for one type of load balancing cannot be used with another. For more information, refer to Choosing a load balancer.

1382

"localityLbPolicy": "A String", # The load balancing algorithm used within the scope of the locality. The possible values are:

1383

# - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default.

1384

# - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.

1385

# - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.

1386

# - RANDOM: The load balancer selects a random healthy host.

1387

# - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer.

1388

# - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, refer to https://ai.google/research/pubs/pub44824

1389

#

1390

# This field is applicable to either:

1391

# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.

1392

# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

1393

#

1394

# If sessionAffinity is not NONE, and this field is not set to >MAGLEV or RING_HASH, session affinity settings will not take effect.

1395

"logConfig": { # The available logging options for the load balancer traffic served by this backend service. # This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver.

1396

"enable": True or False, # This field denotes whether to enable logging for the load balancer traffic served by this backend service.

1397

"sampleRate": 3.14, # This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.

1398

},

1399

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

1400

"network": "A String", # The URL of the network to which this backend service belongs. This field can only be spcified when the load balancing scheme is set to INTERNAL.

1401

"outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled.

1402

#

1403

# This field is applicable to either:

1404

# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.

1405

# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

1406

"baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s.

1407

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1408

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1409

},

1410

"consecutiveErrors": 42, # Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.

1411

"consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3.

1412

"enforcingConsecutiveErrors": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.

1413

"enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.

1414

"enforcingSuccessRate": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.

1415

"interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second.

1416

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1417

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1418

},

1419

"maxEjectionPercent": 42, # Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%.

1420

"successRateMinimumHosts": 42, # The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.

1421

"successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100.

1422

"successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.

1423

},

1424

"port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.

1425

#

1426

# This cannot be used if the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing).

1427

"portName": "A String", # A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the loadBalancingScheme is EXTERNAL, INTERNAL_MANAGED, or INTERNAL_SELF_MANAGED and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs.

#

#

#

# Must be omitted when the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing).

1432

"protocol": "A String", # The protocol this BackendService uses to communicate with backends.

1433

#

1434

# Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, or UDP. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancer or for Traffic Director for more information.

1435

"region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

1436

"securityPolicy": "A String", # [Output Only] The resource URL for the security policy associated with this backend service.

1437

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

1438

"sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Session affinity is not applicable if the --protocol is UDP.

1439

#

1440

# When the loadBalancingScheme is EXTERNAL, possible values are NONE, CLIENT_IP, or GENERATED_COOKIE. You can use GENERATED_COOKIE if the protocol is HTTP or HTTPS.

1441

#

1442

# When the loadBalancingScheme is INTERNAL, possible values are NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.

1443

#

1444

# When the loadBalancingScheme is INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, possible values are NONE, CLIENT_IP, GENERATED_COOKIE, HEADER_FIELD, or HTTP_COOKIE.

1445

"timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information read, Backend service settings The default is 30 seconds.

1446

},

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1447

],

Bu Sun Kim

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

[diff] [blame^]

1448

"kind": "compute#backendServiceList", # [Output Only] Type of resource. Always compute#backendServiceList for lists of backend services.

1449

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

1450

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

1451

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

1452

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

1453

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

1454

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

Bu Sun Kim

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

[diff] [blame]

1455

{

Bu Sun Kim

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

[diff] [blame^]

1456

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

1457

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

1458

},

1459

],

Bu Sun Kim

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

[diff] [blame^]

1460

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

1461

},

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

}</pre>

</div>

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

1467

<pre>Retrieves the next page of results.

1468

1469

Args:

1470

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

1471

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

1472

1473

Returns:

Bu Sun Kim

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

[diff] [blame^]

1474

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1475

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]

1480

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

1481

<pre>Patches the specified BackendService resource with the data included in the request. There are several Understanding backend services to keep in mind when updating a backend service. Read Understanding backend services for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1482

1483

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1484

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

Sai Cheemalapati

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

[diff] [blame]

1485

backendService: string, Name of the BackendService resource to patch. (required)

Dan O'Meara

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

[diff] [blame]

1486

body: object, The request body.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1487

The object takes the form of:

1488

Dan O'Meara

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

[diff] [blame]

1489

{ # Represents a Backend Service resource.

Bu Sun Kim

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

[diff] [blame^]

1490

#

1491

# A backend service contains configuration values for Google Cloud Platform load balancing services.

1492

#

1493

# Backend services in Google Compute Engine can be either regionally or globally scoped.

1494

#

1495

# * [Global](/compute/docs/reference/rest/{$api_version}/backendServices) * [Regional](/compute/docs/reference/rest/{$api_version}/regionBackendServices)

1496

#

1497

# For more information, read Backend Services.

1498

#

1499

# (== resource_for {$api_version}.backendService ==)

1500

"affinityCookieTtlSec": 42, # If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value is one day (86,400).

1501

"backends": [ # The list of backends that serve this BackendService.

1502

{ # Message containing information of one individual backend.

1503

"balancingMode": "A String", # Specifies the balancing mode for the backend.

1504

#

1505

# When choosing a balancing mode, you need to consider the loadBalancingScheme, and protocol for the backend service, as well as the type of backend (instance group or NEG).

1506

#

1507

#

1508

# - If the load balancing mode is CONNECTION, then the load is spread based on how many concurrent connections the backend can handle.

1509

# You can use the CONNECTION balancing mode if the protocol for the backend service is SSL, TCP, or UDP.

1510

#

1511

# If the loadBalancingScheme for the backend service is EXTERNAL (SSL Proxy and TCP Proxy load balancers), you must also specify exactly one of the following parameters: maxConnections (except for regional managed instance groups), maxConnectionsPerInstance, or maxConnectionsPerEndpoint.

1512

#

1513

# If the loadBalancingScheme for the backend service is INTERNAL (internal TCP/UDP load balancers), you cannot specify any additional parameters.

1514

#

1515

# - If the load balancing mode is RATE, the load is spread based on the rate of HTTP requests per second (RPS).

1516

# You can use the RATE balancing mode if the protocol for the backend service is HTTP or HTTPS. You must specify exactly one of the following parameters: maxRate (except for regional managed instance groups), maxRatePerInstance, or maxRatePerEndpoint.

1517

#

1518

# - If the load balancing mode is UTILIZATION, the load is spread based on the backend utilization of instances in an instance group.

1519

# You can use the UTILIZATION balancing mode if the loadBalancingScheme of the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED and the backends are instance groups. There are no restrictions on the backend service protocol.

1520

"capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].

1521

#

1522

# This cannot be used for internal load balancing.

1523

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

1524

"failover": True or False, # This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService.

1525

"group": "A String", # The fully-qualified URL of an instance group or network endpoint group (NEG) resource. The type of backend that a backend service supports depends on the backend service's loadBalancingScheme.

1526

#

1527

#

1528

# - When the loadBalancingScheme for the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, the backend can be either an instance group or a NEG. The backends on the backend service must be either all instance groups or all NEGs. You cannot mix instance group and NEG backends on the same backend service.

1529

#

1530

#

1531

# - When the loadBalancingScheme for the backend service is INTERNAL, the backend must be an instance group in the same region as the backend service. NEGs are not supported.

1532

#

1533

# You must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported.

1534

"maxConnections": 42, # Defines a target maximum number of simultaneous connections that the backend can handle. Valid for network endpoint group and instance group backends (except for regional managed instance groups). If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnectionsPerInstance, or maxConnectionsPerEndpoint.

1535

#

1536

# Not available if the backend's balancingMode is RATE. If the loadBalancingScheme is INTERNAL, then maxConnections is not supported, even though the backend requires a balancing mode of CONNECTION.

1537

"maxConnectionsPerEndpoint": 42, # Defines a target maximum number of simultaneous connections for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a maximum number of target maximum simultaneous connections for the NEG. If the backend's balancingMode is CONNECTION, and the backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerInstance.

1538

#

1539

# Not available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerEndpoint even though its backends require a balancing mode of CONNECTION.

1540

"maxConnectionsPerInstance": 42, # Defines a target maximum number of simultaneous connections for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum number of simultaneous connections for the whole instance group. If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerEndpoint.

1541

#

1542

# Not available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerInstance even though its backends require a balancing mode of CONNECTION.

1543

"maxRate": 42, # Defines a maximum number of HTTP requests per second (RPS) that the backend can handle. Valid for network endpoint group and instance group backends (except for regional managed instance groups). Must not be defined if the backend is a managed instance group that uses autoscaling based on load balancing.

1544

#

1545

# If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is RATE, you must specify maxRate, maxRatePerInstance, or maxRatePerEndpoint.

1546

#

1547

# Not available if the backend's balancingMode is CONNECTION.

1548

"maxRatePerEndpoint": 3.14, # Defines a maximum target for requests per second (RPS) for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a target maximum rate for the NEG.

1549

#

1550

# If the backend's balancingMode is RATE, you must specify either this parameter, maxRate (except for regional managed instance groups), or maxRatePerInstance.

1551

#

1552

# Not available if the backend's balancingMode is CONNECTION.

1553

"maxRatePerInstance": 3.14, # Defines a maximum target for requests per second (RPS) for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum rate for the whole instance group.

1554

#

1555

# If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is RATE, you must specify either this parameter, maxRate (except for regional managed instance groups), or maxRatePerEndpoint.

1556

#

1557

# Not available if the backend's balancingMode is CONNECTION.

1558

"maxUtilization": 3.14, # Defines the maximum average backend utilization of a backend VM in an instance group. The valid range is [0.0, 1.0]. This is an optional parameter if the backend's balancingMode is UTILIZATION.

1559

#

1560

# This parameter can be used in conjunction with maxRate, maxRatePerInstance, maxConnections (except for regional managed instance groups), or maxConnectionsPerInstance.

Sai Cheemalapati

ea3a5e1

2016-10-12 14:05:53 -0700

[diff] [blame]

1561

},

Bu Sun Kim

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

[diff] [blame^]

1562

],

1563

"cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService.

1564

"cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy.

1565

"includeHost": True or False, # If true, requests to different hosts will be cached separately.

1566

"includeProtocol": True or False, # If true, http and https requests will be cached separately.

1567

"includeQueryString": True or False, # If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.

1568

"queryStringBlacklist": [ # Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

1569

"A String",

Bu Sun Kim

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

[diff] [blame]

1570

],

Bu Sun Kim

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

[diff] [blame^]

1571

"queryStringWhitelist": [ # Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

1572

"A String",

1573

],

Sai Cheemalapati

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

[diff] [blame]

1574

},

Bu Sun Kim

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

[diff] [blame^]

1575

"signedUrlCacheMaxAgeSec": "A String", # Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.

1576

"signedUrlKeyNames": [ # [Output Only] Names of the keys for signing request URLs.

1577

"A String",

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1578

],

Bu Sun Kim

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

[diff] [blame^]

1579

},

1580

"circuitBreakers": { # Settings controlling the volume of connections to a backend service. # Settings controlling the volume of connections to a backend service. If not set, this feature is considered disabled.

1581

#

1582

# This field is applicable to either:

1583

# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.

1584

# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

1585

"maxConnections": 42, # The maximum number of connections to the backend service. If not specified, there is no limit.

1586

"maxPendingRequests": 42, # The maximum number of pending requests allowed to the backend service. If not specified, there is no limit.

1587

"maxRequests": 42, # The maximum number of parallel requests that allowed to the backend service. If not specified, there is no limit.

1588

"maxRequestsPerConnection": 42, # Maximum requests for a single connection to the backend service. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive.

1589

"maxRetries": 42, # The maximum number of parallel retries allowed to the backend cluster. If not specified, the default is 1.

1590

},

1591

"connectionDraining": { # Message containing connection draining configuration.

1592

"drainingTimeoutSec": 42, # The amount of time in seconds to allow existing connections to persist while on unhealthy backend VMs. Only applicable if the protocol is not UDP. The valid range is [0, 3600].

1593

},

1594

"consistentHash": { # This message defines settings for a consistent hash style load balancer. # Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field is only applicable when localityLbPolicy is set to MAGLEV or RING_HASH.

1595

#

1596

# This field is applicable to either:

1597

# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.

1598

# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

1599

"httpCookie": { # The information about the HTTP Cookie on which the hash function is based for load balancing policies that use a consistent hash. # Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE.

1600

"name": "A String", # Name of the cookie.

1601

"path": "A String", # Path to set for the cookie.

1602

"ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie.

1603

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1604

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1605

},

Sai Cheemalapati

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

[diff] [blame]

1606

},

Bu Sun Kim

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

[diff] [blame^]

1607

"httpHeaderName": "A String", # The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.

1608

"minimumRingSize": "A String", # The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node.

1609

},

1610

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

1611

"customRequestHeaders": [ # Headers that the HTTP/S load balancer should add to proxied requests.

1612

"A String",

1613

],

1614

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

1615

"enableCDN": True or False, # If true, enables Cloud CDN for the backend service. Only applicable if the loadBalancingScheme is EXTERNAL and the protocol is HTTP or HTTPS.

1616

"failoverPolicy": { # Applicable only to Failover for Internal TCP/UDP Load Balancing. On failover or failback, this field indicates whether connection draining will be honored. GCP has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes). # Applicable only to Failover for Internal TCP/UDP Load Balancing. Requires at least one backend instance group to be defined as a backup (failover) backend.

1617

"disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol is TCP.

1618

#

1619

# The default is false.

1620

"dropTrafficIfUnhealthy": True or False, # Applicable only to Failover for Internal TCP/UDP Load Balancing. If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy. If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy.

1621

#

1622

# The default is false.

1623

"failoverRatio": 3.14, # Applicable only to Failover for Internal TCP/UDP Load Balancing. The value of the field must be in the range [0, 1]. If the value is 0, the load balancer performs a failover when the number of healthy primary VMs equals zero. For all other values, the load balancer performs a failover when the total number of healthy primary VMs is less than this ratio.

1624

},

1625

"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet.

1626

#

1627

# To see the latest fingerprint, make a get() request to retrieve a BackendService.

1628

"healthChecks": [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently at most one health check can be specified. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet NEG backends must not have a health check. A health check must

1629

"A String",

1630

],

1631

"iap": { # Identity-Aware Proxy

1632

"enabled": True or False,

1633

"oauth2ClientId": "A String",

1634

"oauth2ClientSecret": "A String",

1635

"oauth2ClientSecretSha256": "A String", # [Output Only] SHA256 hash value for the field oauth2_client_secret above.

1636

},

1637

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

1638

"kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.

1639

"loadBalancingScheme": "A String", # Specifies the load balancer type. Choose EXTERNAL for load balancers that receive traffic from external clients. Choose INTERNAL for Internal TCP/UDP Load Balancing. Choose INTERNAL_MANAGED for Internal HTTP(S) Load Balancing. Choose INTERNAL_SELF_MANAGED for Traffic Director. A backend service created for one type of load balancing cannot be used with another. For more information, refer to Choosing a load balancer.

1640

"localityLbPolicy": "A String", # The load balancing algorithm used within the scope of the locality. The possible values are:

1641

# - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default.

1642

# - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.

1643

# - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.

1644

# - RANDOM: The load balancer selects a random healthy host.

1645

# - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer.

1646

# - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, refer to https://ai.google/research/pubs/pub44824

1647

#

1648

# This field is applicable to either:

1649

# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.

1650

# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

1651

#

1652

# If sessionAffinity is not NONE, and this field is not set to >MAGLEV or RING_HASH, session affinity settings will not take effect.

1653

"logConfig": { # The available logging options for the load balancer traffic served by this backend service. # This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver.

1654

"enable": True or False, # This field denotes whether to enable logging for the load balancer traffic served by this backend service.

1655

"sampleRate": 3.14, # This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.

1656

},

1657

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

1658

"network": "A String", # The URL of the network to which this backend service belongs. This field can only be spcified when the load balancing scheme is set to INTERNAL.

1659

"outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled.

1660

#

1661

# This field is applicable to either:

1662

# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.

1663

# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

1664

"baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s.

1665

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1666

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Dan O'Meara

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

[diff] [blame]

1667

},

Bu Sun Kim

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

[diff] [blame^]

1668

"consecutiveErrors": 42, # Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.

1669

"consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3.

1670

"enforcingConsecutiveErrors": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.

1671

"enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.

1672

"enforcingSuccessRate": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.

1673

"interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second.

1674

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1675

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Dan O'Meara

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

[diff] [blame]

1676

},

Bu Sun Kim

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

[diff] [blame^]

1677

"maxEjectionPercent": 42, # Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%.

1678

"successRateMinimumHosts": 42, # The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.

1679

"successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100.

1680

"successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.

1681

},

1682

"port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.

1683

#

1684

# This cannot be used if the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing).

1685

"portName": "A String", # A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the loadBalancingScheme is EXTERNAL, INTERNAL_MANAGED, or INTERNAL_SELF_MANAGED and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs.

#

#

#

# Must be omitted when the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing).

1690

"protocol": "A String", # The protocol this BackendService uses to communicate with backends.

1691

#

1692

# Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, or UDP. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancer or for Traffic Director for more information.

1693

"region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

1694

"securityPolicy": "A String", # [Output Only] The resource URL for the security policy associated with this backend service.

1695

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

1696

"sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Session affinity is not applicable if the --protocol is UDP.

1697

#

1698

# When the loadBalancingScheme is EXTERNAL, possible values are NONE, CLIENT_IP, or GENERATED_COOKIE. You can use GENERATED_COOKIE if the protocol is HTTP or HTTPS.

1699

#

1700

# When the loadBalancingScheme is INTERNAL, possible values are NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.

1701

#

1702

# When the loadBalancingScheme is INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, possible values are NONE, CLIENT_IP, GENERATED_COOKIE, HEADER_FIELD, or HTTP_COOKIE.

1703

"timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information read, Backend service settings The default is 30 seconds.

1704

}

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1705

Bu Sun Kim

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

[diff] [blame]

1706

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.

1707

1708

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.

1709

1710

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1711

1712

Returns:

1713

An object of the form:

1714

Bu Sun Kim

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

[diff] [blame]

1715

{ # Represents an Operation resource.

1716

#

Dan O'Meara

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

[diff] [blame]

1717

# Google Compute Engine has three Operation resources:

1718

#

1719

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

1720

#

Bu Sun Kim

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

[diff] [blame]

1721

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

1722

#

1723

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

1724

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

1725

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

1726

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

Bu Sun Kim

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

[diff] [blame]

1727

#

Dan O'Meara

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

[diff] [blame]

1728

# 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^]

1729

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

1730

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

1731

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

1732

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

1733

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

1734

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1735

{

Bu Sun Kim

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

[diff] [blame^]

1736

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

1737

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

1738

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1739

},

1740

],

1741

},

Bu Sun Kim

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

[diff] [blame^]

1742

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

1743

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

1744

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

1745

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

1746

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

1747

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

1748

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

1749

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

1750

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

1751

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

1752

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

1753

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

1754

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

1755

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

1756

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

1757

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

1758

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

1759

{

1760

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

1761

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

1762

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

1763

{

1764

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

1765

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

1766

},

1767

],

1768

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

1769

},

1770

],

1771

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

1776

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

Bu Sun Kim

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

[diff] [blame]

1777

<pre>Sets the security policy for the specified backend service.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1778

1779

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1780

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

Bu Sun Kim

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

[diff] [blame]

1781

backendService: string, Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035. (required)

Dan O'Meara

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

[diff] [blame]

1782

body: object, The request body.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1783

The object takes the form of:

1784

Bu Sun Kim

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

[diff] [blame]

1785

{

Bu Sun Kim

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

[diff] [blame^]

1786

"securityPolicy": "A String",

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1787

}

1788

Bu Sun Kim

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

[diff] [blame]

1789

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.

1790

1791

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.

1792

1793

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1794

1795

Returns:

1796

An object of the form:

1797

Bu Sun Kim

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

[diff] [blame]

1798

{ # Represents an Operation resource.

1799

#

Dan O'Meara

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

[diff] [blame]

1800

# Google Compute Engine has three Operation resources:

1801

#

1802

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

1803

#

Bu Sun Kim

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

[diff] [blame]

1804

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

1805

#

1806

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

1807

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

1808

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

1809

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

Bu Sun Kim

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

[diff] [blame]

1810

#

Dan O'Meara

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

[diff] [blame]

1811

# 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^]

1812

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

1813

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

1814

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

1815

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

1816

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

1817

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

Bu Sun Kim

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

[diff] [blame]

1818

{

Bu Sun Kim

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

[diff] [blame^]

1819

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

1820

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

1821

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

Bu Sun Kim

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

[diff] [blame]

1822

},

1823

],

1824

},

Bu Sun Kim

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

[diff] [blame^]

1825

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

1826

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

1827

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

1828

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

1829

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

1830

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

1831

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

1832

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

1833

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

1834

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

1835

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

1836

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

1837

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

1838

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

1839

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

1840

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

1841

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

1842

{

1843

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

1844

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

1845

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

1846

{

1847

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

1848

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

1849

},

1850

],

1851

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

1852

},

1853

],

1854

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

1859

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

1860

<pre>Updates the specified BackendService resource with the data included in the request. There are several Understanding backend services to keep in mind when updating a backend service. Read Understanding backend services for more information.

Bu Sun Kim

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

[diff] [blame]

1861

1862

Args:

1863

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

1864

backendService: string, Name of the BackendService resource to update. (required)

Dan O'Meara

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

[diff] [blame]

1865

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

1866

The object takes the form of:

1867

Dan O'Meara

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

[diff] [blame]

1868

{ # Represents a Backend Service resource.

Bu Sun Kim

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

[diff] [blame^]

1869

#

1870

# A backend service contains configuration values for Google Cloud Platform load balancing services.

1871

#

1872

# Backend services in Google Compute Engine can be either regionally or globally scoped.

1873

#

1874

# * [Global](/compute/docs/reference/rest/{$api_version}/backendServices) * [Regional](/compute/docs/reference/rest/{$api_version}/regionBackendServices)

1875

#

1876

# For more information, read Backend Services.

1877

#

1878

# (== resource_for {$api_version}.backendService ==)

1879

"affinityCookieTtlSec": 42, # If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value is one day (86,400).

1880

"backends": [ # The list of backends that serve this BackendService.

1881

{ # Message containing information of one individual backend.

1882

"balancingMode": "A String", # Specifies the balancing mode for the backend.

1883

#

1884

# When choosing a balancing mode, you need to consider the loadBalancingScheme, and protocol for the backend service, as well as the type of backend (instance group or NEG).

1885

#

1886

#

1887

# - If the load balancing mode is CONNECTION, then the load is spread based on how many concurrent connections the backend can handle.

1888

# You can use the CONNECTION balancing mode if the protocol for the backend service is SSL, TCP, or UDP.

1889

#

1890

# If the loadBalancingScheme for the backend service is EXTERNAL (SSL Proxy and TCP Proxy load balancers), you must also specify exactly one of the following parameters: maxConnections (except for regional managed instance groups), maxConnectionsPerInstance, or maxConnectionsPerEndpoint.

1891

#

1892

# If the loadBalancingScheme for the backend service is INTERNAL (internal TCP/UDP load balancers), you cannot specify any additional parameters.

1893

#

1894

# - If the load balancing mode is RATE, the load is spread based on the rate of HTTP requests per second (RPS).

1895

# You can use the RATE balancing mode if the protocol for the backend service is HTTP or HTTPS. You must specify exactly one of the following parameters: maxRate (except for regional managed instance groups), maxRatePerInstance, or maxRatePerEndpoint.

1896

#

1897

# - If the load balancing mode is UTILIZATION, the load is spread based on the backend utilization of instances in an instance group.

1898

# You can use the UTILIZATION balancing mode if the loadBalancingScheme of the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED and the backends are instance groups. There are no restrictions on the backend service protocol.

1899

"capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].

1900

#

1901

# This cannot be used for internal load balancing.

1902

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

1903

"failover": True or False, # This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService.

1904

"group": "A String", # The fully-qualified URL of an instance group or network endpoint group (NEG) resource. The type of backend that a backend service supports depends on the backend service's loadBalancingScheme.

1905

#

1906

#

1907

# - When the loadBalancingScheme for the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, the backend can be either an instance group or a NEG. The backends on the backend service must be either all instance groups or all NEGs. You cannot mix instance group and NEG backends on the same backend service.

1908

#

1909

#

1910

# - When the loadBalancingScheme for the backend service is INTERNAL, the backend must be an instance group in the same region as the backend service. NEGs are not supported.

1911

#

1912

# You must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported.

1913

"maxConnections": 42, # Defines a target maximum number of simultaneous connections that the backend can handle. Valid for network endpoint group and instance group backends (except for regional managed instance groups). If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnectionsPerInstance, or maxConnectionsPerEndpoint.

1914

#

1915

# Not available if the backend's balancingMode is RATE. If the loadBalancingScheme is INTERNAL, then maxConnections is not supported, even though the backend requires a balancing mode of CONNECTION.

1916

"maxConnectionsPerEndpoint": 42, # Defines a target maximum number of simultaneous connections for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a maximum number of target maximum simultaneous connections for the NEG. If the backend's balancingMode is CONNECTION, and the backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerInstance.

1917

#

1918

# Not available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerEndpoint even though its backends require a balancing mode of CONNECTION.

1919

"maxConnectionsPerInstance": 42, # Defines a target maximum number of simultaneous connections for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum number of simultaneous connections for the whole instance group. If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerEndpoint.

1920

#

1921

# Not available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerInstance even though its backends require a balancing mode of CONNECTION.

1922

"maxRate": 42, # Defines a maximum number of HTTP requests per second (RPS) that the backend can handle. Valid for network endpoint group and instance group backends (except for regional managed instance groups). Must not be defined if the backend is a managed instance group that uses autoscaling based on load balancing.

1923

#

1924

# If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is RATE, you must specify maxRate, maxRatePerInstance, or maxRatePerEndpoint.

1925

#

1926

# Not available if the backend's balancingMode is CONNECTION.

1927

"maxRatePerEndpoint": 3.14, # Defines a maximum target for requests per second (RPS) for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a target maximum rate for the NEG.

1928

#

1929

# If the backend's balancingMode is RATE, you must specify either this parameter, maxRate (except for regional managed instance groups), or maxRatePerInstance.

1930

#

1931

# Not available if the backend's balancingMode is CONNECTION.

1932

"maxRatePerInstance": 3.14, # Defines a maximum target for requests per second (RPS) for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum rate for the whole instance group.

1933

#

1934

# If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is RATE, you must specify either this parameter, maxRate (except for regional managed instance groups), or maxRatePerEndpoint.

1935

#

1936

# Not available if the backend's balancingMode is CONNECTION.

1937

"maxUtilization": 3.14, # Defines the maximum average backend utilization of a backend VM in an instance group. The valid range is [0.0, 1.0]. This is an optional parameter if the backend's balancingMode is UTILIZATION.

1938

#

1939

# This parameter can be used in conjunction with maxRate, maxRatePerInstance, maxConnections (except for regional managed instance groups), or maxConnectionsPerInstance.

Bu Sun Kim

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

[diff] [blame]

1940

},

Bu Sun Kim

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

[diff] [blame^]

1941

],

1942

"cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService.

1943

"cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy.

1944

"includeHost": True or False, # If true, requests to different hosts will be cached separately.

1945

"includeProtocol": True or False, # If true, http and https requests will be cached separately.

1946

"includeQueryString": True or False, # If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.

1947

"queryStringBlacklist": [ # Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

1948

"A String",

Bu Sun Kim

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

[diff] [blame]

1949

],

Bu Sun Kim

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

[diff] [blame^]

1950

"queryStringWhitelist": [ # Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

1951

"A String",

1952

],

Bu Sun Kim

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

[diff] [blame]

1953

},

Bu Sun Kim

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

[diff] [blame^]

1954

"signedUrlCacheMaxAgeSec": "A String", # Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.

1955

"signedUrlKeyNames": [ # [Output Only] Names of the keys for signing request URLs.

1956

"A String",

Bu Sun Kim

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

[diff] [blame]

1957

],

Bu Sun Kim

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

[diff] [blame^]

1958

},

1959

"circuitBreakers": { # Settings controlling the volume of connections to a backend service. # Settings controlling the volume of connections to a backend service. If not set, this feature is considered disabled.

1960

#

1961

# This field is applicable to either:

1962

# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.

1963

# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

1964

"maxConnections": 42, # The maximum number of connections to the backend service. If not specified, there is no limit.

1965

"maxPendingRequests": 42, # The maximum number of pending requests allowed to the backend service. If not specified, there is no limit.

1966

"maxRequests": 42, # The maximum number of parallel requests that allowed to the backend service. If not specified, there is no limit.

1967

"maxRequestsPerConnection": 42, # Maximum requests for a single connection to the backend service. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive.

1968

"maxRetries": 42, # The maximum number of parallel retries allowed to the backend cluster. If not specified, the default is 1.

1969

},

1970

"connectionDraining": { # Message containing connection draining configuration.

1971

"drainingTimeoutSec": 42, # The amount of time in seconds to allow existing connections to persist while on unhealthy backend VMs. Only applicable if the protocol is not UDP. The valid range is [0, 3600].

1972

},

1973

"consistentHash": { # This message defines settings for a consistent hash style load balancer. # Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field is only applicable when localityLbPolicy is set to MAGLEV or RING_HASH.

1974

#

1975

# This field is applicable to either:

1976

# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.

1977

# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

1978

"httpCookie": { # The information about the HTTP Cookie on which the hash function is based for load balancing policies that use a consistent hash. # Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE.

1979

"name": "A String", # Name of the cookie.

1980

"path": "A String", # Path to set for the cookie.

1981

"ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie.

1982

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1983

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1984

},

Bu Sun Kim

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

[diff] [blame]

1985

},

Bu Sun Kim

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

[diff] [blame^]

1986

"httpHeaderName": "A String", # The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.

1987

"minimumRingSize": "A String", # The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node.

1988

},

1989

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

1990

"customRequestHeaders": [ # Headers that the HTTP/S load balancer should add to proxied requests.

1991

"A String",

1992

],

1993

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

1994

"enableCDN": True or False, # If true, enables Cloud CDN for the backend service. Only applicable if the loadBalancingScheme is EXTERNAL and the protocol is HTTP or HTTPS.

1995

"failoverPolicy": { # Applicable only to Failover for Internal TCP/UDP Load Balancing. On failover or failback, this field indicates whether connection draining will be honored. GCP has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes). # Applicable only to Failover for Internal TCP/UDP Load Balancing. Requires at least one backend instance group to be defined as a backup (failover) backend.

1996

"disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol is TCP.

1997

#

1998

# The default is false.

1999

"dropTrafficIfUnhealthy": True or False, # Applicable only to Failover for Internal TCP/UDP Load Balancing. If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy. If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy.

2000

#

2001

# The default is false.

2002

"failoverRatio": 3.14, # Applicable only to Failover for Internal TCP/UDP Load Balancing. The value of the field must be in the range [0, 1]. If the value is 0, the load balancer performs a failover when the number of healthy primary VMs equals zero. For all other values, the load balancer performs a failover when the total number of healthy primary VMs is less than this ratio.

2003

},

2004

"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet.

2005

#

2006

# To see the latest fingerprint, make a get() request to retrieve a BackendService.

2007

"healthChecks": [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently at most one health check can be specified. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet NEG backends must not have a health check. A health check must

2008

"A String",

2009

],

2010

"iap": { # Identity-Aware Proxy

2011

"enabled": True or False,

2012

"oauth2ClientId": "A String",

2013

"oauth2ClientSecret": "A String",

2014

"oauth2ClientSecretSha256": "A String", # [Output Only] SHA256 hash value for the field oauth2_client_secret above.

2015

},

2016

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

2017

"kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.

2018

"loadBalancingScheme": "A String", # Specifies the load balancer type. Choose EXTERNAL for load balancers that receive traffic from external clients. Choose INTERNAL for Internal TCP/UDP Load Balancing. Choose INTERNAL_MANAGED for Internal HTTP(S) Load Balancing. Choose INTERNAL_SELF_MANAGED for Traffic Director. A backend service created for one type of load balancing cannot be used with another. For more information, refer to Choosing a load balancer.

2019

"localityLbPolicy": "A String", # The load balancing algorithm used within the scope of the locality. The possible values are:

2020

# - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default.

2021

# - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.

2022

# - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.

2023

# - RANDOM: The load balancer selects a random healthy host.

2024

# - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer.

2025

# - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, refer to https://ai.google/research/pubs/pub44824

2026

#

2027

# This field is applicable to either:

2028

# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.

2029

# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

2030

#

2031

# If sessionAffinity is not NONE, and this field is not set to >MAGLEV or RING_HASH, session affinity settings will not take effect.

2032

"logConfig": { # The available logging options for the load balancer traffic served by this backend service. # This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver.

2033

"enable": True or False, # This field denotes whether to enable logging for the load balancer traffic served by this backend service.

2034

"sampleRate": 3.14, # This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.

2035

},

2036

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

2037

"network": "A String", # The URL of the network to which this backend service belongs. This field can only be spcified when the load balancing scheme is set to INTERNAL.

2038

"outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled.

2039

#

2040

# This field is applicable to either:

2041

# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.

2042

# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

2043

"baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s.

2044

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2045

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Dan O'Meara

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

[diff] [blame]

2046

},

Bu Sun Kim

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

[diff] [blame^]

2047

"consecutiveErrors": 42, # Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.

2048

"consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3.

2049

"enforcingConsecutiveErrors": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.

2050

"enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.

2051

"enforcingSuccessRate": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.

2052

"interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second.

2053

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2054

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Dan O'Meara

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

[diff] [blame]

2055

},

Bu Sun Kim

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

[diff] [blame^]

2056

"maxEjectionPercent": 42, # Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%.

2057

"successRateMinimumHosts": 42, # The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.

2058

"successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100.

2059

"successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.

2060

},

2061

"port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.

2062

#

2063

# This cannot be used if the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing).

2064

"portName": "A String", # A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the loadBalancingScheme is EXTERNAL, INTERNAL_MANAGED, or INTERNAL_SELF_MANAGED and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs.

#

#

#

# Must be omitted when the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing).

2069

"protocol": "A String", # The protocol this BackendService uses to communicate with backends.

2070

#

2071

# Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, or UDP. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancer or for Traffic Director for more information.

2072

"region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

2073

"securityPolicy": "A String", # [Output Only] The resource URL for the security policy associated with this backend service.

2074

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

2075

"sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Session affinity is not applicable if the --protocol is UDP.

2076

#

2077

# When the loadBalancingScheme is EXTERNAL, possible values are NONE, CLIENT_IP, or GENERATED_COOKIE. You can use GENERATED_COOKIE if the protocol is HTTP or HTTPS.

2078

#

2079

# When the loadBalancingScheme is INTERNAL, possible values are NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.

2080

#

2081

# When the loadBalancingScheme is INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, possible values are NONE, CLIENT_IP, GENERATED_COOKIE, HEADER_FIELD, or HTTP_COOKIE.

2082

"timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information read, Backend service settings The default is 30 seconds.

2083

}

Bu Sun Kim

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

[diff] [blame]

2084

2085

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.

2086

2087

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.

2088

2089

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

2090

2091

Returns:

2092

An object of the form:

2093

2094

{ # Represents an Operation resource.

2095

#

Dan O'Meara

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

[diff] [blame]

2096

# Google Compute Engine has three Operation resources:

2097

#

2098

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

2099

#

Bu Sun Kim

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

[diff] [blame]

2100

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

2101

#

2102

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

2103

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

2104

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

2105

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

Bu Sun Kim

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

[diff] [blame]

2106

#

Dan O'Meara

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

[diff] [blame]

2107

# 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^]

2108

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

2109

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

2110

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

2111

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

2112

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

2113

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

2114

{

Bu Sun Kim

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

[diff] [blame^]

2115

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

2116

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

2117

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

2118

},

2119

],

2120

},

Bu Sun Kim