Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / e633be11dbb412e5030b5afca31111fa4074dff1 / . / docs / dyn / compute_v1.targetPools.html
blob: 2d5616110b739f0d3dedca30312dc79063da7367 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.targetPools.html">targetPools</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#addHealthCheck">addHealthCheck(project, region, targetPool, body)</a></code></p>
79<p class="firstline">Adds health check URL to targetPool.</p>
80<p class="toc_element">
81 <code><a href="#addInstance">addInstance(project, region, targetPool, body)</a></code></p>
82<p class="firstline">Adds instance url to targetPool.</p>
83<p class="toc_element">
84 <code><a href="#aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
85<p class="firstline">Retrieves the list of target pools grouped by scope.</p>
86<p class="toc_element">
87 <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<p class="toc_element">
90 <code><a href="#delete">delete(project, region, targetPool)</a></code></p>
91<p class="firstline">Deletes the specified TargetPool resource.</p>
92<p class="toc_element">
93 <code><a href="#get">get(project, region, targetPool)</a></code></p>
94<p class="firstline">Returns the specified TargetPool resource.</p>
95<p class="toc_element">
96 <code><a href="#getHealth">getHealth(project, region, targetPool, body)</a></code></p>
97<p class="firstline">Gets the most recent health check results for each IP for the given instance that is referenced by given TargetPool.</p>
98<p class="toc_element">
99 <code><a href="#insert">insert(project, region, body)</a></code></p>
100<p class="firstline">Creates a TargetPool resource in the specified project and region using the data included in the request.</p>
101<p class="toc_element">
102 <code><a href="#list">list(project, region, maxResults=None, pageToken=None, filter=None)</a></code></p>
103<p class="firstline">Retrieves the list of TargetPool resources available to the specified project and region.</p>
104<p class="toc_element">
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<p class="toc_element">
108 <code><a href="#removeHealthCheck">removeHealthCheck(project, region, targetPool, body)</a></code></p>
109<p class="firstline">Removes health check URL from targetPool.</p>
110<p class="toc_element">
111 <code><a href="#removeInstance">removeInstance(project, region, targetPool, body)</a></code></p>
112<p class="firstline">Removes instance URL from targetPool.</p>
113<p class="toc_element">
114 <code><a href="#setBackup">setBackup(project, region, targetPool, body, failoverRatio=None)</a></code></p>
115<p class="firstline">Changes backup pool configurations.</p>
116<h3>Method Details</h3>
117<div class="method">
118 <code class="details" id="addHealthCheck">addHealthCheck(project, region, targetPool, body)</code>
119 <pre>Adds health check URL to targetPool.
120
121Args:
122 project: string, A parameter (required)
123 region: string, Name of the region scoping this request. (required)
124 targetPool: string, Name of the TargetPool resource to which health_check_url is to be added. (required)
125 body: object, The request body. (required)
126 The object takes the form of:
127
128{
129 "healthChecks": [ # Health check URLs to be added to targetPool.
130 {
131 "healthCheck": "A String",
132 },
133 ],
134 }
135
136
137Returns:
138 An object of the form:
139
140 { # An operation resource, used to manage asynchronous API requests.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]141 "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
142 "clientOperationId": "A String",
143 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
144 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
145 "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
146 "operationType": "A String",
147 "httpErrorMessage": "A String",
148 "progress": 42,
149 "httpErrorStatusCode": 42,
150 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
151 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
152 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
153 "warnings": [
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]154 {
155 "message": "A String", # Optional human-readable details for this warning.
156 "code": "A String", # The warning type identifier for this warning.
157 "data": [ # Metadata for this warning in 'key: value' format.
158 {
159 "value": "A String", # A warning data value corresponding to the key.
160 "key": "A String", # A key for the warning data.
161 },
162 ],
163 },
164 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]165 "user": "A String",
166 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
167 "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
168 "name": "A String", # [Output Only] Name of the resource (output only).
169 "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
170 "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
171 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]172 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]173 "message": "A String", # [Output Only] An optional, human-readable error message.
174 "code": "A String", # [Output Only] The error type identifier for this error.
175 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]176 },
177 ],
178 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]179 "endTime": "A String",
180 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
181 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]182 }</pre>
183</div>
184
185<div class="method">
186 <code class="details" id="addInstance">addInstance(project, region, targetPool, body)</code>
187 <pre>Adds instance url to targetPool.
188
189Args:
190 project: string, A parameter (required)
191 region: string, Name of the region scoping this request. (required)
192 targetPool: string, Name of the TargetPool resource to which instance_url is to be added. (required)
193 body: object, The request body. (required)
194 The object takes the form of:
195
196{
197 "instances": [ # URLs of the instances to be added to targetPool.
198 {
199 "instance": "A String",
200 },
201 ],
202 }
203
204
205Returns:
206 An object of the form:
207
208 { # An operation resource, used to manage asynchronous API requests.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]209 "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
210 "clientOperationId": "A String",
211 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
212 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
213 "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
214 "operationType": "A String",
215 "httpErrorMessage": "A String",
216 "progress": 42,
217 "httpErrorStatusCode": 42,
218 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
219 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
220 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
221 "warnings": [
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]222 {
223 "message": "A String", # Optional human-readable details for this warning.
224 "code": "A String", # The warning type identifier for this warning.
225 "data": [ # Metadata for this warning in 'key: value' format.
226 {
227 "value": "A String", # A warning data value corresponding to the key.
228 "key": "A String", # A key for the warning data.
229 },
230 ],
231 },
232 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]233 "user": "A String",
234 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
235 "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
236 "name": "A String", # [Output Only] Name of the resource (output only).
237 "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
238 "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
239 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]240 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]241 "message": "A String", # [Output Only] An optional, human-readable error message.
242 "code": "A String", # [Output Only] The error type identifier for this error.
243 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]244 },
245 ],
246 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]247 "endTime": "A String",
248 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
249 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]250 }</pre>
251</div>
252
253<div class="method">
254 <code class="details" id="aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</code>
255 <pre>Retrieves the list of target pools grouped by scope.
256
257Args:
258 project: string, Name of the project scoping this request. (required)
259 maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
260 pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
261 filter: string, Optional. Filter expression for filtering listed resources.
262
263Returns:
264 An object of the form:
265
266 {
267 "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
268 "items": { # A map of scoped target pool lists.
269 "a_key": { # Name of the scope containing this set of target pools.
270 "warning": { # Informational warning which replaces the list of addresses when the list is empty.
271 "message": "A String", # Optional human-readable details for this warning.
272 "code": "A String", # The warning type identifier for this warning.
273 "data": [ # Metadata for this warning in 'key: value' format.
274 {
275 "value": "A String", # A warning data value corresponding to the key.
276 "key": "A String", # A key for the warning data.
277 },
278 ],
279 },
280 "targetPools": [ # List of target pools contained in this scope.
281 { # A TargetPool resource. This resource defines a pool of VMs, associated HttpHealthCheck resources, and the fallback TargetPool.
282 "failoverRatio": 3.14, # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].
283 #
284 # If set, 'backupPool' must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy VMs in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.
285 #
286 # In case where 'failoverRatio' is not set or all the VMs in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy VMs with the best effort, or to all VMs when no VM is healthy.
287 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
288 "region": "A String", # URL of the region where the target pool resides (output only).
289 "kind": "compute#targetPool", # Type of the resource.
290 "sessionAffinity": "A String", # Sesssion affinity option, must be one of the following values: 'NONE': Connections from the same client IP may go to any VM in the pool; 'CLIENT_IP': Connections from the same client IP will go to the same VM in the pool while that VM remains healthy. 'CLIENT_IP_PROTO': Connections from the same client IP with the same IP protocol will go to the same VM in the pool while that VM remains healthy.
291 "instances": [ # A list of resource URLs to the member VMs serving this pool. They must live in zones contained in the same region as this pool.
292 "A String",
293 ],
294 "backupPool": "A String", # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its 'failoverRatio' field is properly set to a value between [0, 1].
295 #
296 # 'backupPool' and 'failoverRatio' together define the fallback behavior of the primary target pool: if the ratio of the healthy VMs in the primary pool is at or below 'failoverRatio', traffic arriving at the load-balanced IP will be directed to the backup pool.
297 #
298 # In case where 'failoverRatio' and 'backupPool' are not set, or all the VMs in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy VMs with the best effort, or to all VMs when no VM is healthy.
299 "healthChecks": [ # A list of URLs to the HttpHealthCheck resource. A member VM in this pool is considered healthy if and only if all specified health checks pass. An empty list means all member VMs will be considered healthy at all times.
300 "A String",
301 ],
302 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
303 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
304 "selfLink": "A String", # Server defined URL for the resource (output only).
305 "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.
306 },
307 ],
308 },
309 },
310 "kind": "compute#targetPoolAggregatedList", # Type of resource.
311 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
312 "selfLink": "A String", # Server defined URL for this resource (output only).
313 }</pre>
314</div>
315
316<div class="method">
317 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
318 <pre>Retrieves the next page of results.
319
320Args:
321 previous_request: The request for the previous page. (required)
322 previous_response: The response from the request for the previous page. (required)
323
324Returns:
325 A request object that you can call 'execute()' on to request the next
326 page. Returns None if there are no more items in the collection.
327 </pre>
328</div>
329
330<div class="method">
331 <code class="details" id="delete">delete(project, region, targetPool)</code>
332 <pre>Deletes the specified TargetPool resource.
333
334Args:
335 project: string, Name of the project scoping this request. (required)
336 region: string, Name of the region scoping this request. (required)
337 targetPool: string, Name of the TargetPool resource to delete. (required)
338
339Returns:
340 An object of the form:
341
342 { # An operation resource, used to manage asynchronous API requests.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]343 "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
344 "clientOperationId": "A String",
345 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
346 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
347 "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
348 "operationType": "A String",
349 "httpErrorMessage": "A String",
350 "progress": 42,
351 "httpErrorStatusCode": 42,
352 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
353 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
354 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
355 "warnings": [
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]356 {
357 "message": "A String", # Optional human-readable details for this warning.
358 "code": "A String", # The warning type identifier for this warning.
359 "data": [ # Metadata for this warning in 'key: value' format.
360 {
361 "value": "A String", # A warning data value corresponding to the key.
362 "key": "A String", # A key for the warning data.
363 },
364 ],
365 },
366 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]367 "user": "A String",
368 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
369 "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
370 "name": "A String", # [Output Only] Name of the resource (output only).
371 "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
372 "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
373 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]374 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]375 "message": "A String", # [Output Only] An optional, human-readable error message.
376 "code": "A String", # [Output Only] The error type identifier for this error.
377 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]378 },
379 ],
380 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]381 "endTime": "A String",
382 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
383 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]384 }</pre>
385</div>
386
387<div class="method">
388 <code class="details" id="get">get(project, region, targetPool)</code>
389 <pre>Returns the specified TargetPool resource.
390
391Args:
392 project: string, Name of the project scoping this request. (required)
393 region: string, Name of the region scoping this request. (required)
394 targetPool: string, Name of the TargetPool resource to return. (required)
395
396Returns:
397 An object of the form:
398
399 { # A TargetPool resource. This resource defines a pool of VMs, associated HttpHealthCheck resources, and the fallback TargetPool.
400 "failoverRatio": 3.14, # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].
401 #
402 # If set, 'backupPool' must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy VMs in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.
403 #
404 # In case where 'failoverRatio' is not set or all the VMs in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy VMs with the best effort, or to all VMs when no VM is healthy.
405 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
406 "region": "A String", # URL of the region where the target pool resides (output only).
407 "kind": "compute#targetPool", # Type of the resource.
408 "sessionAffinity": "A String", # Sesssion affinity option, must be one of the following values: 'NONE': Connections from the same client IP may go to any VM in the pool; 'CLIENT_IP': Connections from the same client IP will go to the same VM in the pool while that VM remains healthy. 'CLIENT_IP_PROTO': Connections from the same client IP with the same IP protocol will go to the same VM in the pool while that VM remains healthy.
409 "instances": [ # A list of resource URLs to the member VMs serving this pool. They must live in zones contained in the same region as this pool.
410 "A String",
411 ],
412 "backupPool": "A String", # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its 'failoverRatio' field is properly set to a value between [0, 1].
413 #
414 # 'backupPool' and 'failoverRatio' together define the fallback behavior of the primary target pool: if the ratio of the healthy VMs in the primary pool is at or below 'failoverRatio', traffic arriving at the load-balanced IP will be directed to the backup pool.
415 #
416 # In case where 'failoverRatio' and 'backupPool' are not set, or all the VMs in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy VMs with the best effort, or to all VMs when no VM is healthy.
417 "healthChecks": [ # A list of URLs to the HttpHealthCheck resource. A member VM in this pool is considered healthy if and only if all specified health checks pass. An empty list means all member VMs will be considered healthy at all times.
418 "A String",
419 ],
420 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
421 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
422 "selfLink": "A String", # Server defined URL for the resource (output only).
423 "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.
424 }</pre>
425</div>
426
427<div class="method">
428 <code class="details" id="getHealth">getHealth(project, region, targetPool, body)</code>
429 <pre>Gets the most recent health check results for each IP for the given instance that is referenced by given TargetPool.
430
431Args:
432 project: string, A parameter (required)
433 region: string, Name of the region scoping this request. (required)
434 targetPool: string, Name of the TargetPool resource to which the queried instance belongs. (required)
435 body: object, The request body. (required)
436 The object takes the form of:
437
438{
439 "instance": "A String",
440}
441
442
443Returns:
444 An object of the form:
445
446 {
447 "kind": "compute#targetPoolInstanceHealth", # Type of resource.
448 "healthStatus": [
449 {
450 "instance": "A String", # URL of the instance resource.
451 "healthState": "A String", # Health state of the instance.
452 "ipAddress": "A String", # The IP address represented by this resource.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]453 "port": 42, # The port on the instance.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]454 },
455 ],
456 }</pre>
457</div>
458
459<div class="method">
460 <code class="details" id="insert">insert(project, region, body)</code>
461 <pre>Creates a TargetPool resource in the specified project and region using the data included in the request.
462
463Args:
464 project: string, Name of the project scoping this request. (required)
465 region: string, Name of the region scoping this request. (required)
466 body: object, The request body. (required)
467 The object takes the form of:
468
469{ # A TargetPool resource. This resource defines a pool of VMs, associated HttpHealthCheck resources, and the fallback TargetPool.
470 "failoverRatio": 3.14, # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].
471 #
472 # If set, 'backupPool' must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy VMs in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.
473 #
474 # In case where 'failoverRatio' is not set or all the VMs in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy VMs with the best effort, or to all VMs when no VM is healthy.
475 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
476 "region": "A String", # URL of the region where the target pool resides (output only).
477 "kind": "compute#targetPool", # Type of the resource.
478 "sessionAffinity": "A String", # Sesssion affinity option, must be one of the following values: 'NONE': Connections from the same client IP may go to any VM in the pool; 'CLIENT_IP': Connections from the same client IP will go to the same VM in the pool while that VM remains healthy. 'CLIENT_IP_PROTO': Connections from the same client IP with the same IP protocol will go to the same VM in the pool while that VM remains healthy.
479 "instances": [ # A list of resource URLs to the member VMs serving this pool. They must live in zones contained in the same region as this pool.
480 "A String",
481 ],
482 "backupPool": "A String", # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its 'failoverRatio' field is properly set to a value between [0, 1].
483 #
484 # 'backupPool' and 'failoverRatio' together define the fallback behavior of the primary target pool: if the ratio of the healthy VMs in the primary pool is at or below 'failoverRatio', traffic arriving at the load-balanced IP will be directed to the backup pool.
485 #
486 # In case where 'failoverRatio' and 'backupPool' are not set, or all the VMs in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy VMs with the best effort, or to all VMs when no VM is healthy.
487 "healthChecks": [ # A list of URLs to the HttpHealthCheck resource. A member VM in this pool is considered healthy if and only if all specified health checks pass. An empty list means all member VMs will be considered healthy at all times.
488 "A String",
489 ],
490 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
491 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
492 "selfLink": "A String", # Server defined URL for the resource (output only).
493 "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.
494 }
495
496
497Returns:
498 An object of the form:
499
500 { # An operation resource, used to manage asynchronous API requests.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]501 "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
502 "clientOperationId": "A String",
503 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
504 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
505 "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
506 "operationType": "A String",
507 "httpErrorMessage": "A String",
508 "progress": 42,
509 "httpErrorStatusCode": 42,
510 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
511 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
512 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
513 "warnings": [
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]514 {
515 "message": "A String", # Optional human-readable details for this warning.
516 "code": "A String", # The warning type identifier for this warning.
517 "data": [ # Metadata for this warning in 'key: value' format.
518 {
519 "value": "A String", # A warning data value corresponding to the key.
520 "key": "A String", # A key for the warning data.
521 },
522 ],
523 },
524 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]525 "user": "A String",
526 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
527 "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
528 "name": "A String", # [Output Only] Name of the resource (output only).
529 "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
530 "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
531 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]532 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]533 "message": "A String", # [Output Only] An optional, human-readable error message.
534 "code": "A String", # [Output Only] The error type identifier for this error.
535 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]536 },
537 ],
538 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]539 "endTime": "A String",
540 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
541 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]542 }</pre>
543</div>
544
545<div class="method">
546 <code class="details" id="list">list(project, region, maxResults=None, pageToken=None, filter=None)</code>
547 <pre>Retrieves the list of TargetPool resources available to the specified project and region.
548
549Args:
550 project: string, Name of the project scoping this request. (required)
551 region: string, Name of the region scoping this request. (required)
552 maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
553 pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
554 filter: string, Optional. Filter expression for filtering listed resources.
555
556Returns:
557 An object of the form:
558
559 { # Contains a list of TargetPool resources.
560 "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]561 "items": [ # A list of TargetPool resources.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]562 { # A TargetPool resource. This resource defines a pool of VMs, associated HttpHealthCheck resources, and the fallback TargetPool.
563 "failoverRatio": 3.14, # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].
564 #
565 # If set, 'backupPool' must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy VMs in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.
566 #
567 # In case where 'failoverRatio' is not set or all the VMs in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy VMs with the best effort, or to all VMs when no VM is healthy.
568 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
569 "region": "A String", # URL of the region where the target pool resides (output only).
570 "kind": "compute#targetPool", # Type of the resource.
571 "sessionAffinity": "A String", # Sesssion affinity option, must be one of the following values: 'NONE': Connections from the same client IP may go to any VM in the pool; 'CLIENT_IP': Connections from the same client IP will go to the same VM in the pool while that VM remains healthy. 'CLIENT_IP_PROTO': Connections from the same client IP with the same IP protocol will go to the same VM in the pool while that VM remains healthy.
572 "instances": [ # A list of resource URLs to the member VMs serving this pool. They must live in zones contained in the same region as this pool.
573 "A String",
574 ],
575 "backupPool": "A String", # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its 'failoverRatio' field is properly set to a value between [0, 1].
576 #
577 # 'backupPool' and 'failoverRatio' together define the fallback behavior of the primary target pool: if the ratio of the healthy VMs in the primary pool is at or below 'failoverRatio', traffic arriving at the load-balanced IP will be directed to the backup pool.
578 #
579 # In case where 'failoverRatio' and 'backupPool' are not set, or all the VMs in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy VMs with the best effort, or to all VMs when no VM is healthy.
580 "healthChecks": [ # A list of URLs to the HttpHealthCheck resource. A member VM in this pool is considered healthy if and only if all specified health checks pass. An empty list means all member VMs will be considered healthy at all times.
581 "A String",
582 ],
583 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
584 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
585 "selfLink": "A String", # Server defined URL for the resource (output only).
586 "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.
587 },
588 ],
589 "kind": "compute#targetPoolList", # Type of resource.
590 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
591 "selfLink": "A String", # Server defined URL for this resource (output only).
592 }</pre>
593</div>
594
595<div class="method">
596 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
597 <pre>Retrieves the next page of results.
598
599Args:
600 previous_request: The request for the previous page. (required)
601 previous_response: The response from the request for the previous page. (required)
602
603Returns:
604 A request object that you can call 'execute()' on to request the next
605 page. Returns None if there are no more items in the collection.
606 </pre>
607</div>
608
609<div class="method">
610 <code class="details" id="removeHealthCheck">removeHealthCheck(project, region, targetPool, body)</code>
611 <pre>Removes health check URL from targetPool.
612
613Args:
614 project: string, A parameter (required)
615 region: string, Name of the region scoping this request. (required)
616 targetPool: string, Name of the TargetPool resource to which health_check_url is to be removed. (required)
617 body: object, The request body. (required)
618 The object takes the form of:
619
620{
621 "healthChecks": [ # Health check URLs to be removed from targetPool.
622 {
623 "healthCheck": "A String",
624 },
625 ],
626 }
627
628
629Returns:
630 An object of the form:
631
632 { # An operation resource, used to manage asynchronous API requests.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]633 "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
634 "clientOperationId": "A String",
635 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
636 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
637 "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
638 "operationType": "A String",
639 "httpErrorMessage": "A String",
640 "progress": 42,
641 "httpErrorStatusCode": 42,
642 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
643 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
644 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
645 "warnings": [
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]646 {
647 "message": "A String", # Optional human-readable details for this warning.
648 "code": "A String", # The warning type identifier for this warning.
649 "data": [ # Metadata for this warning in 'key: value' format.
650 {
651 "value": "A String", # A warning data value corresponding to the key.
652 "key": "A String", # A key for the warning data.
653 },
654 ],
655 },
656 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]657 "user": "A String",
658 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
659 "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
660 "name": "A String", # [Output Only] Name of the resource (output only).
661 "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
662 "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
663 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]664 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]665 "message": "A String", # [Output Only] An optional, human-readable error message.
666 "code": "A String", # [Output Only] The error type identifier for this error.
667 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]668 },
669 ],
670 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]671 "endTime": "A String",
672 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
673 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]674 }</pre>
675</div>
676
677<div class="method">
678 <code class="details" id="removeInstance">removeInstance(project, region, targetPool, body)</code>
679 <pre>Removes instance URL from targetPool.
680
681Args:
682 project: string, A parameter (required)
683 region: string, Name of the region scoping this request. (required)
684 targetPool: string, Name of the TargetPool resource to which instance_url is to be removed. (required)
685 body: object, The request body. (required)
686 The object takes the form of:
687
688{
689 "instances": [ # URLs of the instances to be removed from targetPool.
690 {
691 "instance": "A String",
692 },
693 ],
694 }
695
696
697Returns:
698 An object of the form:
699
700 { # An operation resource, used to manage asynchronous API requests.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]701 "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
702 "clientOperationId": "A String",
703 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
704 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
705 "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
706 "operationType": "A String",
707 "httpErrorMessage": "A String",
708 "progress": 42,
709 "httpErrorStatusCode": 42,
710 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
711 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
712 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
713 "warnings": [
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]714 {
715 "message": "A String", # Optional human-readable details for this warning.
716 "code": "A String", # The warning type identifier for this warning.
717 "data": [ # Metadata for this warning in 'key: value' format.
718 {
719 "value": "A String", # A warning data value corresponding to the key.
720 "key": "A String", # A key for the warning data.
721 },
722 ],
723 },
724 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]725 "user": "A String",
726 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
727 "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
728 "name": "A String", # [Output Only] Name of the resource (output only).
729 "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
730 "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
731 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]732 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]733 "message": "A String", # [Output Only] An optional, human-readable error message.
734 "code": "A String", # [Output Only] The error type identifier for this error.
735 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]736 },
737 ],
738 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]739 "endTime": "A String",
740 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
741 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]742 }</pre>
743</div>
744
745<div class="method">
746 <code class="details" id="setBackup">setBackup(project, region, targetPool, body, failoverRatio=None)</code>
747 <pre>Changes backup pool configurations.
748
749Args:
750 project: string, Name of the project scoping this request. (required)
751 region: string, Name of the region scoping this request. (required)
752 targetPool: string, Name of the TargetPool resource for which the backup is to be set. (required)
753 body: object, The request body. (required)
754 The object takes the form of:
755
756{
757 "target": "A String",
758 }
759
760 failoverRatio: number, New failoverRatio value for the containing target pool.
761
762Returns:
763 An object of the form:
764
765 { # An operation resource, used to manage asynchronous API requests.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]766 "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
767 "clientOperationId": "A String",
768 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
769 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
770 "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
771 "operationType": "A String",
772 "httpErrorMessage": "A String",
773 "progress": 42,
774 "httpErrorStatusCode": 42,
775 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
776 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
777 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
778 "warnings": [
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]779 {
780 "message": "A String", # Optional human-readable details for this warning.
781 "code": "A String", # The warning type identifier for this warning.
782 "data": [ # Metadata for this warning in 'key: value' format.
783 {
784 "value": "A String", # A warning data value corresponding to the key.
785 "key": "A String", # A key for the warning data.
786 },
787 ],
788 },
789 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]790 "user": "A String",
791 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
792 "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
793 "name": "A String", # [Output Only] Name of the resource (output only).
794 "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
795 "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
796 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]797 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]798 "message": "A String", # [Output Only] An optional, human-readable error message.
799 "code": "A String", # [Output Only] The error type identifier for this error.
800 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]801 },
802 ],
803 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]804 "endTime": "A String",
805 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
806 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]807 }</pre>
808</div>
809
810</body></html>