Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / db5a0ed106aff656a031a99ad64780ffd88c8425 / . / docs / dyn / autoscaler_v1beta2.autoscalers.html
blob: f568a1290c45864aaadc8ffd789707f2318b2480 [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",
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]117 "insertTime": "A String",
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]118 "operationType": "A String",
119 "httpErrorMessage": "A String",
120 "progress": 42,
121 "httpErrorStatusCode": 42,
122 "statusMessage": "A String",
123 "status": "A String",
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]124 "description": "A String",
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]125 "warnings": [
126 {
127 "message": "A String",
128 "code": "A String",
129 "data": [
130 {
131 "value": "A String",
132 "key": "A String",
133 },
134 ],
135 },
136 ],
137 "user": "A String",
138 "startTime": "A String",
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]139 "kind": "autoscaler#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]140 "name": "A String",
141 "region": "A String",
142 "error": {
143 "errors": [
144 {
145 "message": "A String",
146 "code": "A String",
147 "location": "A String",
148 },
149 ],
150 },
151 "endTime": "A String",
152 "selfLink": "A String",
153 "targetLink": "A String",
154 }</pre>
155</div>
156
157<div class="method">
158 <code class="details" id="get">get(project, zone, autoscaler)</code>
159 <pre>Gets the specified Autoscaler resource.
160
161Args:
162 project: string, Project ID of Autoscaler resource. (required)
163 zone: string, Zone name of Autoscaler resource. (required)
164 autoscaler: string, Name of the Autoscaler resource. (required)
165
166Returns:
167 An object of the form:
168
169 { # Cloud Autoscaler resource.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]170 "kind": "compute#autoscaler", # Type of resource.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]171 "description": "A String", # An optional textual description of the resource provided by the client.
172 "autoscalingPolicy": { # Cloud Autoscaler policy. # Configuration parameters for autoscaling algorithm.
173 "maxNumReplicas": 42, # The maximum number of replicas that the Autoscaler can scale up to.
174 "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.
175 "loadBalancingUtilization": { # Load balancing utilization policy. # Configuration parameters of autoscaling based on load balancer.
176 "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.
177 },
178 "customMetricUtilizations": [ # Configuration parameters of autoscaling based on custom metric.
179 { # Custom utilization metric policy.
180 "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.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]181 "utilizationTargetType": "A String", # Defines type in which utilization_target is expressed.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]182 "utilizationTarget": 3.14, # Target value of the metric which Autoscaler should maintain. Must be a positive value.
183 },
184 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]185 "cpuUtilization": { # CPU utilization policy. # Configuration parameters of CPU based autoscaling policy.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]186 "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.
187 },
188 "minNumReplicas": 42, # The minimum number of replicas that the Autoscaler can scale down to.
189 },
190 "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.
191 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
192 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
193 "selfLink": "A String", # [Output Only] A self-link to the Autoscaler configuration resource.
194 "name": "A String", # Name of the Autoscaler resource. Must be unique per project and zone.
195 }</pre>
196</div>
197
198<div class="method">
199 <code class="details" id="insert">insert(project, zone, body)</code>
200 <pre>Adds new Autoscaler resource.
201
202Args:
203 project: string, Project ID of Autoscaler resource. (required)
204 zone: string, Zone name of Autoscaler resource. (required)
205 body: object, The request body. (required)
206 The object takes the form of:
207
208{ # Cloud Autoscaler resource.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]209 "kind": "compute#autoscaler", # Type of resource.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]210 "description": "A String", # An optional textual description of the resource provided by the client.
211 "autoscalingPolicy": { # Cloud Autoscaler policy. # Configuration parameters for autoscaling algorithm.
212 "maxNumReplicas": 42, # The maximum number of replicas that the Autoscaler can scale up to.
213 "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.
214 "loadBalancingUtilization": { # Load balancing utilization policy. # Configuration parameters of autoscaling based on load balancer.
215 "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.
216 },
217 "customMetricUtilizations": [ # Configuration parameters of autoscaling based on custom metric.
218 { # Custom utilization metric policy.
219 "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.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]220 "utilizationTargetType": "A String", # Defines type in which utilization_target is expressed.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]221 "utilizationTarget": 3.14, # Target value of the metric which Autoscaler should maintain. Must be a positive value.
222 },
223 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]224 "cpuUtilization": { # CPU utilization policy. # Configuration parameters of CPU based autoscaling policy.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]225 "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.
226 },
227 "minNumReplicas": 42, # The minimum number of replicas that the Autoscaler can scale down to.
228 },
229 "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.
230 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
231 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
232 "selfLink": "A String", # [Output Only] A self-link to the Autoscaler configuration resource.
233 "name": "A String", # Name of the Autoscaler resource. Must be unique per project and zone.
234 }
235
236
237Returns:
238 An object of the form:
239
240 {
241 "targetId": "A String",
242 "clientOperationId": "A String",
243 "creationTimestamp": "A String",
244 "id": "A String",
245 "zone": "A String",
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]246 "insertTime": "A String",
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]247 "operationType": "A String",
248 "httpErrorMessage": "A String",
249 "progress": 42,
250 "httpErrorStatusCode": 42,
251 "statusMessage": "A String",
252 "status": "A String",
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]253 "description": "A String",
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]254 "warnings": [
255 {
256 "message": "A String",
257 "code": "A String",
258 "data": [
259 {
260 "value": "A String",
261 "key": "A String",
262 },
263 ],
264 },
265 ],
266 "user": "A String",
267 "startTime": "A String",
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]268 "kind": "autoscaler#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]269 "name": "A String",
270 "region": "A String",
271 "error": {
272 "errors": [
273 {
274 "message": "A String",
275 "code": "A String",
276 "location": "A String",
277 },
278 ],
279 },
280 "endTime": "A String",
281 "selfLink": "A String",
282 "targetLink": "A String",
283 }</pre>
284</div>
285
286<div class="method">
287 <code class="details" id="list">list(project, zone, maxResults=None, pageToken=None, filter=None)</code>
288 <pre>Lists all Autoscaler resources in this zone.
289
290Args:
291 project: string, Project ID of Autoscaler resource. (required)
292 zone: string, Zone name of Autoscaler resource. (required)
293 maxResults: integer, A parameter
294 pageToken: string, A parameter
295 filter: string, A parameter
296
297Returns:
298 An object of the form:
299
300 {
301 "nextPageToken": "A String", # [Output only] A token used to continue a truncated list request.
302 "items": [ # Autoscaler resources.
303 { # Cloud Autoscaler resource.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]304 "kind": "compute#autoscaler", # Type of resource.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]305 "description": "A String", # An optional textual description of the resource provided by the client.
306 "autoscalingPolicy": { # Cloud Autoscaler policy. # Configuration parameters for autoscaling algorithm.
307 "maxNumReplicas": 42, # The maximum number of replicas that the Autoscaler can scale up to.
308 "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.
309 "loadBalancingUtilization": { # Load balancing utilization policy. # Configuration parameters of autoscaling based on load balancer.
310 "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.
311 },
312 "customMetricUtilizations": [ # Configuration parameters of autoscaling based on custom metric.
313 { # Custom utilization metric policy.
314 "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.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]315 "utilizationTargetType": "A String", # Defines type in which utilization_target is expressed.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]316 "utilizationTarget": 3.14, # Target value of the metric which Autoscaler should maintain. Must be a positive value.
317 },
318 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]319 "cpuUtilization": { # CPU utilization policy. # Configuration parameters of CPU based autoscaling policy.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]320 "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.
321 },
322 "minNumReplicas": 42, # The minimum number of replicas that the Autoscaler can scale down to.
323 },
324 "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.
325 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
326 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
327 "selfLink": "A String", # [Output Only] A self-link to the Autoscaler configuration resource.
328 "name": "A String", # Name of the Autoscaler resource. Must be unique per project and zone.
329 },
330 ],
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]331 "kind": "compute#autoscalerList", # Type of resource.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]332 }</pre>
333</div>
334
335<div class="method">
336 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
337 <pre>Retrieves the next page of results.
338
339Args:
340 previous_request: The request for the previous page. (required)
341 previous_response: The response from the request for the previous page. (required)
342
343Returns:
344 A request object that you can call 'execute()' on to request the next
345 page. Returns None if there are no more items in the collection.
346 </pre>
347</div>
348
349<div class="method">
350 <code class="details" id="patch">patch(project, zone, autoscaler, body)</code>
351 <pre>Update the entire content of the Autoscaler resource. This method supports patch semantics.
352
353Args:
354 project: string, Project ID of Autoscaler resource. (required)
355 zone: string, Zone name of Autoscaler resource. (required)
356 autoscaler: string, Name of the Autoscaler resource. (required)
357 body: object, The request body. (required)
358 The object takes the form of:
359
360{ # Cloud Autoscaler resource.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]361 "kind": "compute#autoscaler", # Type of resource.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]362 "description": "A String", # An optional textual description of the resource provided by the client.
363 "autoscalingPolicy": { # Cloud Autoscaler policy. # Configuration parameters for autoscaling algorithm.
364 "maxNumReplicas": 42, # The maximum number of replicas that the Autoscaler can scale up to.
365 "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.
366 "loadBalancingUtilization": { # Load balancing utilization policy. # Configuration parameters of autoscaling based on load balancer.
367 "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.
368 },
369 "customMetricUtilizations": [ # Configuration parameters of autoscaling based on custom metric.
370 { # Custom utilization metric policy.
371 "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.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]372 "utilizationTargetType": "A String", # Defines type in which utilization_target is expressed.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]373 "utilizationTarget": 3.14, # Target value of the metric which Autoscaler should maintain. Must be a positive value.
374 },
375 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]376 "cpuUtilization": { # CPU utilization policy. # Configuration parameters of CPU based autoscaling policy.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]377 "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.
378 },
379 "minNumReplicas": 42, # The minimum number of replicas that the Autoscaler can scale down to.
380 },
381 "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.
382 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
383 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
384 "selfLink": "A String", # [Output Only] A self-link to the Autoscaler configuration resource.
385 "name": "A String", # Name of the Autoscaler resource. Must be unique per project and zone.
386 }
387
388
389Returns:
390 An object of the form:
391
392 {
393 "targetId": "A String",
394 "clientOperationId": "A String",
395 "creationTimestamp": "A String",
396 "id": "A String",
397 "zone": "A String",
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]398 "insertTime": "A String",
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]399 "operationType": "A String",
400 "httpErrorMessage": "A String",
401 "progress": 42,
402 "httpErrorStatusCode": 42,
403 "statusMessage": "A String",
404 "status": "A String",
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]405 "description": "A String",
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]406 "warnings": [
407 {
408 "message": "A String",
409 "code": "A String",
410 "data": [
411 {
412 "value": "A String",
413 "key": "A String",
414 },
415 ],
416 },
417 ],
418 "user": "A String",
419 "startTime": "A String",
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]420 "kind": "autoscaler#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]421 "name": "A String",
422 "region": "A String",
423 "error": {
424 "errors": [
425 {
426 "message": "A String",
427 "code": "A String",
428 "location": "A String",
429 },
430 ],
431 },
432 "endTime": "A String",
433 "selfLink": "A String",
434 "targetLink": "A String",
435 }</pre>
436</div>
437
438<div class="method">
439 <code class="details" id="update">update(project, zone, autoscaler, body)</code>
440 <pre>Update the entire content of the Autoscaler resource.
441
442Args:
443 project: string, Project ID of Autoscaler resource. (required)
444 zone: string, Zone name of Autoscaler resource. (required)
445 autoscaler: string, Name of the Autoscaler resource. (required)
446 body: object, The request body. (required)
447 The object takes the form of:
448
449{ # Cloud Autoscaler resource.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]450 "kind": "compute#autoscaler", # Type of resource.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]451 "description": "A String", # An optional textual description of the resource provided by the client.
452 "autoscalingPolicy": { # Cloud Autoscaler policy. # Configuration parameters for autoscaling algorithm.
453 "maxNumReplicas": 42, # The maximum number of replicas that the Autoscaler can scale up to.
454 "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.
455 "loadBalancingUtilization": { # Load balancing utilization policy. # Configuration parameters of autoscaling based on load balancer.
456 "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.
457 },
458 "customMetricUtilizations": [ # Configuration parameters of autoscaling based on custom metric.
459 { # Custom utilization metric policy.
460 "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.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]461 "utilizationTargetType": "A String", # Defines type in which utilization_target is expressed.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]462 "utilizationTarget": 3.14, # Target value of the metric which Autoscaler should maintain. Must be a positive value.
463 },
464 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]465 "cpuUtilization": { # CPU utilization policy. # Configuration parameters of CPU based autoscaling policy.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]466 "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.
467 },
468 "minNumReplicas": 42, # The minimum number of replicas that the Autoscaler can scale down to.
469 },
470 "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.
471 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
472 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
473 "selfLink": "A String", # [Output Only] A self-link to the Autoscaler configuration resource.
474 "name": "A String", # Name of the Autoscaler resource. Must be unique per project and zone.
475 }
476
477
478Returns:
479 An object of the form:
480
481 {
482 "targetId": "A String",
483 "clientOperationId": "A String",
484 "creationTimestamp": "A String",
485 "id": "A String",
486 "zone": "A String",
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]487 "insertTime": "A String",
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]488 "operationType": "A String",
489 "httpErrorMessage": "A String",
490 "progress": 42,
491 "httpErrorStatusCode": 42,
492 "statusMessage": "A String",
493 "status": "A String",
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]494 "description": "A String",
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]495 "warnings": [
496 {
497 "message": "A String",
498 "code": "A String",
499 "data": [
500 {
501 "value": "A String",
502 "key": "A String",
503 },
504 ],
505 },
506 ],
507 "user": "A String",
508 "startTime": "A String",
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]509 "kind": "autoscaler#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]510 "name": "A String",
511 "region": "A String",
512 "error": {
513 "errors": [
514 {
515 "message": "A String",
516 "code": "A String",
517 "location": "A String",
518 },
519 ],
520 },
521 "endTime": "A String",
522 "selfLink": "A String",
523 "targetLink": "A String",
524 }</pre>
525</div>
526
527</body></html>