Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 63caac01ea7b9fbd8ae70bcbb4c6ecbec833ad3d / . / docs / dyn / autoscaler_v1beta2.autoscalers.html
blob: 216880d9632046cb1855f4bf67996efea51d21f0 [file] [log] [blame]
Craig Citro065b5302014-08-14 00:47:23 -0700[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="autoscaler_v1beta2.html">Google Compute Engine Autoscaler API</a> . <a href="autoscaler_v1beta2.autoscalers.html">autoscalers</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(project, zone, autoscaler)</a></code></p>
79<p class="firstline">Deletes the specified Autoscaler resource.</p>
80<p class="toc_element">
81 <code><a href="#get">get(project, zone, autoscaler)</a></code></p>
82<p class="firstline">Gets the specified Autoscaler resource.</p>
83<p class="toc_element">
84 <code><a href="#insert">insert(project, zone, body)</a></code></p>
85<p class="firstline">Adds new Autoscaler resource.</p>
86<p class="toc_element">
87 <code><a href="#list">list(project, zone, maxResults=None, pageToken=None, filter=None)</a></code></p>
88<p class="firstline">Lists all Autoscaler resources in this zone.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
93 <code><a href="#patch">patch(project, zone, autoscaler, body)</a></code></p>
94<p class="firstline">Update the entire content of the Autoscaler resource. This method supports patch semantics.</p>
95<p class="toc_element">
96 <code><a href="#update">update(project, zone, autoscaler, body)</a></code></p>
97<p class="firstline">Update the entire content of the Autoscaler resource.</p>
98<h3>Method Details</h3>
99<div class="method">
100 <code class="details" id="delete">delete(project, zone, autoscaler)</code>
101 <pre>Deletes the specified Autoscaler resource.
102
103Args:
104 project: string, Project ID of Autoscaler resource. (required)
105 zone: string, Zone name of Autoscaler resource. (required)
106 autoscaler: string, Name of the Autoscaler resource. (required)
107
108Returns:
109 An object of the form:
110
111 {
112 "targetId": "A String",
113 "clientOperationId": "A String",
114 "creationTimestamp": "A String",
115 "id": "A String",
116 "zone": "A String",
117 "operationType": "A String",
118 "httpErrorMessage": "A String",
119 "progress": 42,
120 "httpErrorStatusCode": 42,
121 "statusMessage": "A String",
122 "status": "A String",
123 "insertTime": "A String",
124 "warnings": [
125 {
126 "message": "A String",
127 "code": "A String",
128 "data": [
129 {
130 "value": "A String",
131 "key": "A String",
132 },
133 ],
134 },
135 ],
136 "user": "A String",
137 "startTime": "A String",
138 "kind": "autoscaler#operation", # Type of the resource.
139 "name": "A String",
140 "region": "A String",
141 "error": {
142 "errors": [
143 {
144 "message": "A String",
145 "code": "A String",
146 "location": "A String",
147 },
148 ],
149 },
150 "endTime": "A String",
151 "selfLink": "A String",
152 "targetLink": "A String",
153 }</pre>
154</div>
155
156<div class="method">
157 <code class="details" id="get">get(project, zone, autoscaler)</code>
158 <pre>Gets the specified Autoscaler resource.
159
160Args:
161 project: string, Project ID of Autoscaler resource. (required)
162 zone: string, Zone name of Autoscaler resource. (required)
163 autoscaler: string, Name of the Autoscaler resource. (required)
164
165Returns:
166 An object of the form:
167
168 { # Cloud Autoscaler resource.
169 "description": "A String", # An optional textual description of the resource provided by the client.
170 "autoscalingPolicy": { # Cloud Autoscaler policy. # Configuration parameters for autoscaling algorithm.
171 "maxNumReplicas": 42, # The maximum number of replicas that the Autoscaler can scale up to.
172 "coolDownPeriodSec": 42, # The number of seconds that the Autoscaler should wait between two succeeding changes to the number of virtual machines. You should define an interval that is at least as long as the initialization time of a virtual machine and the time it may take for replica pool to create the virtual machine. The default is 60 seconds.
173 "loadBalancingUtilization": { # Load balancing utilization policy. # Configuration parameters of autoscaling based on load balancer.
174 "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP load balancing configuration) that Autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8. For example if your maxRatePerInstance capacity (in HTTP Load Balancing configuration) is set at 10 and you would like to keep number of instances such that each instance receives 7 QPS on average, set this to 0.7.
175 },
176 "customMetricUtilizations": [ # Configuration parameters of autoscaling based on custom metric.
177 { # Custom utilization metric policy.
178 "metric": "A String", # Identifier of the metric. It should be a Cloud Monitoring metric. The metric can not have negative values. The metric should be an utilization metric (increasing number of VMs handling requests x times should reduce average value of the metric roughly x times). For example you could use: compute.googleapis.com/instance/network/received_bytes_count.
179 "utilizationTarget": 3.14, # Target value of the metric which Autoscaler should maintain. Must be a positive value.
180 },
181 ],
182 "cpuUtilization": { # CPU utilization policy. # Exactly one utilization policy should be provided. Configuration parameters of CPU based autoscaling policy.
183 "utilizationTarget": 3.14, # The target utilization that the Autoscaler should maintain. It is represented as a fraction of used cores. For example: 6 cores used in 8-core VM are represented here as 0.75. Must be a float value between (0, 1]. If not defined, the default is 0.8.
184 },
185 "minNumReplicas": 42, # The minimum number of replicas that the Autoscaler can scale down to.
186 },
187 "target": "A String", # URL to the entity which will be autoscaled. Currently the only supported value is ReplicaPool?s URL. Note: it is illegal to specify multiple Autoscalers for the same target.
188 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
189 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
190 "selfLink": "A String", # [Output Only] A self-link to the Autoscaler configuration resource.
191 "name": "A String", # Name of the Autoscaler resource. Must be unique per project and zone.
192 }</pre>
193</div>
194
195<div class="method">
196 <code class="details" id="insert">insert(project, zone, body)</code>
197 <pre>Adds new Autoscaler resource.
198
199Args:
200 project: string, Project ID of Autoscaler resource. (required)
201 zone: string, Zone name of Autoscaler resource. (required)
202 body: object, The request body. (required)
203 The object takes the form of:
204
205{ # Cloud Autoscaler resource.
206 "description": "A String", # An optional textual description of the resource provided by the client.
207 "autoscalingPolicy": { # Cloud Autoscaler policy. # Configuration parameters for autoscaling algorithm.
208 "maxNumReplicas": 42, # The maximum number of replicas that the Autoscaler can scale up to.
209 "coolDownPeriodSec": 42, # The number of seconds that the Autoscaler should wait between two succeeding changes to the number of virtual machines. You should define an interval that is at least as long as the initialization time of a virtual machine and the time it may take for replica pool to create the virtual machine. The default is 60 seconds.
210 "loadBalancingUtilization": { # Load balancing utilization policy. # Configuration parameters of autoscaling based on load balancer.
211 "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP load balancing configuration) that Autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8. For example if your maxRatePerInstance capacity (in HTTP Load Balancing configuration) is set at 10 and you would like to keep number of instances such that each instance receives 7 QPS on average, set this to 0.7.
212 },
213 "customMetricUtilizations": [ # Configuration parameters of autoscaling based on custom metric.
214 { # Custom utilization metric policy.
215 "metric": "A String", # Identifier of the metric. It should be a Cloud Monitoring metric. The metric can not have negative values. The metric should be an utilization metric (increasing number of VMs handling requests x times should reduce average value of the metric roughly x times). For example you could use: compute.googleapis.com/instance/network/received_bytes_count.
216 "utilizationTarget": 3.14, # Target value of the metric which Autoscaler should maintain. Must be a positive value.
217 },
218 ],
219 "cpuUtilization": { # CPU utilization policy. # Exactly one utilization policy should be provided. Configuration parameters of CPU based autoscaling policy.
220 "utilizationTarget": 3.14, # The target utilization that the Autoscaler should maintain. It is represented as a fraction of used cores. For example: 6 cores used in 8-core VM are represented here as 0.75. Must be a float value between (0, 1]. If not defined, the default is 0.8.
221 },
222 "minNumReplicas": 42, # The minimum number of replicas that the Autoscaler can scale down to.
223 },
224 "target": "A String", # URL to the entity which will be autoscaled. Currently the only supported value is ReplicaPool?s URL. Note: it is illegal to specify multiple Autoscalers for the same target.
225 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
226 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
227 "selfLink": "A String", # [Output Only] A self-link to the Autoscaler configuration resource.
228 "name": "A String", # Name of the Autoscaler resource. Must be unique per project and zone.
229 }
230
231
232Returns:
233 An object of the form:
234
235 {
236 "targetId": "A String",
237 "clientOperationId": "A String",
238 "creationTimestamp": "A String",
239 "id": "A String",
240 "zone": "A String",
241 "operationType": "A String",
242 "httpErrorMessage": "A String",
243 "progress": 42,
244 "httpErrorStatusCode": 42,
245 "statusMessage": "A String",
246 "status": "A String",
247 "insertTime": "A String",
248 "warnings": [
249 {
250 "message": "A String",
251 "code": "A String",
252 "data": [
253 {
254 "value": "A String",
255 "key": "A String",
256 },
257 ],
258 },
259 ],
260 "user": "A String",
261 "startTime": "A String",
262 "kind": "autoscaler#operation", # Type of the resource.
263 "name": "A String",
264 "region": "A String",
265 "error": {
266 "errors": [
267 {
268 "message": "A String",
269 "code": "A String",
270 "location": "A String",
271 },
272 ],
273 },
274 "endTime": "A String",
275 "selfLink": "A String",
276 "targetLink": "A String",
277 }</pre>
278</div>
279
280<div class="method">
281 <code class="details" id="list">list(project, zone, maxResults=None, pageToken=None, filter=None)</code>
282 <pre>Lists all Autoscaler resources in this zone.
283
284Args:
285 project: string, Project ID of Autoscaler resource. (required)
286 zone: string, Zone name of Autoscaler resource. (required)
287 maxResults: integer, A parameter
288 pageToken: string, A parameter
289 filter: string, A parameter
290
291Returns:
292 An object of the form:
293
294 {
295 "nextPageToken": "A String", # [Output only] A token used to continue a truncated list request.
296 "items": [ # Autoscaler resources.
297 { # Cloud Autoscaler resource.
298 "description": "A String", # An optional textual description of the resource provided by the client.
299 "autoscalingPolicy": { # Cloud Autoscaler policy. # Configuration parameters for autoscaling algorithm.
300 "maxNumReplicas": 42, # The maximum number of replicas that the Autoscaler can scale up to.
301 "coolDownPeriodSec": 42, # The number of seconds that the Autoscaler should wait between two succeeding changes to the number of virtual machines. You should define an interval that is at least as long as the initialization time of a virtual machine and the time it may take for replica pool to create the virtual machine. The default is 60 seconds.
302 "loadBalancingUtilization": { # Load balancing utilization policy. # Configuration parameters of autoscaling based on load balancer.
303 "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP load balancing configuration) that Autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8. For example if your maxRatePerInstance capacity (in HTTP Load Balancing configuration) is set at 10 and you would like to keep number of instances such that each instance receives 7 QPS on average, set this to 0.7.
304 },
305 "customMetricUtilizations": [ # Configuration parameters of autoscaling based on custom metric.
306 { # Custom utilization metric policy.
307 "metric": "A String", # Identifier of the metric. It should be a Cloud Monitoring metric. The metric can not have negative values. The metric should be an utilization metric (increasing number of VMs handling requests x times should reduce average value of the metric roughly x times). For example you could use: compute.googleapis.com/instance/network/received_bytes_count.
308 "utilizationTarget": 3.14, # Target value of the metric which Autoscaler should maintain. Must be a positive value.
309 },
310 ],
311 "cpuUtilization": { # CPU utilization policy. # Exactly one utilization policy should be provided. Configuration parameters of CPU based autoscaling policy.
312 "utilizationTarget": 3.14, # The target utilization that the Autoscaler should maintain. It is represented as a fraction of used cores. For example: 6 cores used in 8-core VM are represented here as 0.75. Must be a float value between (0, 1]. If not defined, the default is 0.8.
313 },
314 "minNumReplicas": 42, # The minimum number of replicas that the Autoscaler can scale down to.
315 },
316 "target": "A String", # URL to the entity which will be autoscaled. Currently the only supported value is ReplicaPool?s URL. Note: it is illegal to specify multiple Autoscalers for the same target.
317 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
318 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
319 "selfLink": "A String", # [Output Only] A self-link to the Autoscaler configuration resource.
320 "name": "A String", # Name of the Autoscaler resource. Must be unique per project and zone.
321 },
322 ],
323 }</pre>
324</div>
325
326<div class="method">
327 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
328 <pre>Retrieves the next page of results.
329
330Args:
331 previous_request: The request for the previous page. (required)
332 previous_response: The response from the request for the previous page. (required)
333
334Returns:
335 A request object that you can call 'execute()' on to request the next
336 page. Returns None if there are no more items in the collection.
337 </pre>
338</div>
339
340<div class="method">
341 <code class="details" id="patch">patch(project, zone, autoscaler, body)</code>
342 <pre>Update the entire content of the Autoscaler resource. This method supports patch semantics.
343
344Args:
345 project: string, Project ID of Autoscaler resource. (required)
346 zone: string, Zone name of Autoscaler resource. (required)
347 autoscaler: string, Name of the Autoscaler resource. (required)
348 body: object, The request body. (required)
349 The object takes the form of:
350
351{ # Cloud Autoscaler resource.
352 "description": "A String", # An optional textual description of the resource provided by the client.
353 "autoscalingPolicy": { # Cloud Autoscaler policy. # Configuration parameters for autoscaling algorithm.
354 "maxNumReplicas": 42, # The maximum number of replicas that the Autoscaler can scale up to.
355 "coolDownPeriodSec": 42, # The number of seconds that the Autoscaler should wait between two succeeding changes to the number of virtual machines. You should define an interval that is at least as long as the initialization time of a virtual machine and the time it may take for replica pool to create the virtual machine. The default is 60 seconds.
356 "loadBalancingUtilization": { # Load balancing utilization policy. # Configuration parameters of autoscaling based on load balancer.
357 "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP load balancing configuration) that Autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8. For example if your maxRatePerInstance capacity (in HTTP Load Balancing configuration) is set at 10 and you would like to keep number of instances such that each instance receives 7 QPS on average, set this to 0.7.
358 },
359 "customMetricUtilizations": [ # Configuration parameters of autoscaling based on custom metric.
360 { # Custom utilization metric policy.
361 "metric": "A String", # Identifier of the metric. It should be a Cloud Monitoring metric. The metric can not have negative values. The metric should be an utilization metric (increasing number of VMs handling requests x times should reduce average value of the metric roughly x times). For example you could use: compute.googleapis.com/instance/network/received_bytes_count.
362 "utilizationTarget": 3.14, # Target value of the metric which Autoscaler should maintain. Must be a positive value.
363 },
364 ],
365 "cpuUtilization": { # CPU utilization policy. # Exactly one utilization policy should be provided. Configuration parameters of CPU based autoscaling policy.
366 "utilizationTarget": 3.14, # The target utilization that the Autoscaler should maintain. It is represented as a fraction of used cores. For example: 6 cores used in 8-core VM are represented here as 0.75. Must be a float value between (0, 1]. If not defined, the default is 0.8.
367 },
368 "minNumReplicas": 42, # The minimum number of replicas that the Autoscaler can scale down to.
369 },
370 "target": "A String", # URL to the entity which will be autoscaled. Currently the only supported value is ReplicaPool?s URL. Note: it is illegal to specify multiple Autoscalers for the same target.
371 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
372 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
373 "selfLink": "A String", # [Output Only] A self-link to the Autoscaler configuration resource.
374 "name": "A String", # Name of the Autoscaler resource. Must be unique per project and zone.
375 }
376
377
378Returns:
379 An object of the form:
380
381 {
382 "targetId": "A String",
383 "clientOperationId": "A String",
384 "creationTimestamp": "A String",
385 "id": "A String",
386 "zone": "A String",
387 "operationType": "A String",
388 "httpErrorMessage": "A String",
389 "progress": 42,
390 "httpErrorStatusCode": 42,
391 "statusMessage": "A String",
392 "status": "A String",
393 "insertTime": "A String",
394 "warnings": [
395 {
396 "message": "A String",
397 "code": "A String",
398 "data": [
399 {
400 "value": "A String",
401 "key": "A String",
402 },
403 ],
404 },
405 ],
406 "user": "A String",
407 "startTime": "A String",
408 "kind": "autoscaler#operation", # Type of the resource.
409 "name": "A String",
410 "region": "A String",
411 "error": {
412 "errors": [
413 {
414 "message": "A String",
415 "code": "A String",
416 "location": "A String",
417 },
418 ],
419 },
420 "endTime": "A String",
421 "selfLink": "A String",
422 "targetLink": "A String",
423 }</pre>
424</div>
425
426<div class="method">
427 <code class="details" id="update">update(project, zone, autoscaler, body)</code>
428 <pre>Update the entire content of the Autoscaler resource.
429
430Args:
431 project: string, Project ID of Autoscaler resource. (required)
432 zone: string, Zone name of Autoscaler resource. (required)
433 autoscaler: string, Name of the Autoscaler resource. (required)
434 body: object, The request body. (required)
435 The object takes the form of:
436
437{ # Cloud Autoscaler resource.
438 "description": "A String", # An optional textual description of the resource provided by the client.
439 "autoscalingPolicy": { # Cloud Autoscaler policy. # Configuration parameters for autoscaling algorithm.
440 "maxNumReplicas": 42, # The maximum number of replicas that the Autoscaler can scale up to.
441 "coolDownPeriodSec": 42, # The number of seconds that the Autoscaler should wait between two succeeding changes to the number of virtual machines. You should define an interval that is at least as long as the initialization time of a virtual machine and the time it may take for replica pool to create the virtual machine. The default is 60 seconds.
442 "loadBalancingUtilization": { # Load balancing utilization policy. # Configuration parameters of autoscaling based on load balancer.
443 "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP load balancing configuration) that Autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8. For example if your maxRatePerInstance capacity (in HTTP Load Balancing configuration) is set at 10 and you would like to keep number of instances such that each instance receives 7 QPS on average, set this to 0.7.
444 },
445 "customMetricUtilizations": [ # Configuration parameters of autoscaling based on custom metric.
446 { # Custom utilization metric policy.
447 "metric": "A String", # Identifier of the metric. It should be a Cloud Monitoring metric. The metric can not have negative values. The metric should be an utilization metric (increasing number of VMs handling requests x times should reduce average value of the metric roughly x times). For example you could use: compute.googleapis.com/instance/network/received_bytes_count.
448 "utilizationTarget": 3.14, # Target value of the metric which Autoscaler should maintain. Must be a positive value.
449 },
450 ],
451 "cpuUtilization": { # CPU utilization policy. # Exactly one utilization policy should be provided. Configuration parameters of CPU based autoscaling policy.
452 "utilizationTarget": 3.14, # The target utilization that the Autoscaler should maintain. It is represented as a fraction of used cores. For example: 6 cores used in 8-core VM are represented here as 0.75. Must be a float value between (0, 1]. If not defined, the default is 0.8.
453 },
454 "minNumReplicas": 42, # The minimum number of replicas that the Autoscaler can scale down to.
455 },
456 "target": "A String", # URL to the entity which will be autoscaled. Currently the only supported value is ReplicaPool?s URL. Note: it is illegal to specify multiple Autoscalers for the same target.
457 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
458 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
459 "selfLink": "A String", # [Output Only] A self-link to the Autoscaler configuration resource.
460 "name": "A String", # Name of the Autoscaler resource. Must be unique per project and zone.
461 }
462
463
464Returns:
465 An object of the form:
466
467 {
468 "targetId": "A String",
469 "clientOperationId": "A String",
470 "creationTimestamp": "A String",
471 "id": "A String",
472 "zone": "A String",
473 "operationType": "A String",
474 "httpErrorMessage": "A String",
475 "progress": 42,
476 "httpErrorStatusCode": 42,
477 "statusMessage": "A String",
478 "status": "A String",
479 "insertTime": "A String",
480 "warnings": [
481 {
482 "message": "A String",
483 "code": "A String",
484 "data": [
485 {
486 "value": "A String",
487 "key": "A String",
488 },
489 ],
490 },
491 ],
492 "user": "A String",
493 "startTime": "A String",
494 "kind": "autoscaler#operation", # Type of the resource.
495 "name": "A String",
496 "region": "A String",
497 "error": {
498 "errors": [
499 {
500 "message": "A String",
501 "code": "A String",
502 "location": "A String",
503 },
504 ],
505 },
506 "endTime": "A String",
507 "selfLink": "A String",
508 "targetLink": "A String",
509 }</pre>
510</div>
511
512</body></html>