Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4f877e562986034f25ea4246ad1256eabd339526 / . / docs / dyn / replicapool_v1beta2.instanceGroupManagers.html
blob: 54a9d8d1d90473579566f8bffe50e46afa0d2197 [file] [log] [blame]
Craig Citroe633be12015-03-02 13:40:36 -0800[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="replicapool_v1beta2.html">Google Compute Engine Instance Group Manager API</a> . <a href="replicapool_v1beta2.instanceGroupManagers.html">instanceGroupManagers</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#abandonInstances">abandonInstances(project, zone, instanceGroupManager, body)</a></code></p>
79<p class="firstline">Removes the specified instances from the managed instance group, and from any target pools of which they were members, without deleting the instances.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(project, zone, instanceGroupManager)</a></code></p>
82<p class="firstline">Deletes the instance group manager and all instances contained within. If you'd like to delete the manager without deleting the instances, you must first abandon the instances to remove them from the group.</p>
83<p class="toc_element">
84 <code><a href="#deleteInstances">deleteInstances(project, zone, instanceGroupManager, body)</a></code></p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]85<p class="firstline">Deletes the specified instances. The instances are deleted, then removed from the instance group and any target pools of which they were a member. The targetSize of the instance group manager is reduced by the number of instances deleted.</p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]86<p class="toc_element">
87 <code><a href="#get">get(project, zone, instanceGroupManager)</a></code></p>
88<p class="firstline">Returns the specified Instance Group Manager resource.</p>
89<p class="toc_element">
90 <code><a href="#insert">insert(project, zone, size, body)</a></code></p>
91<p class="firstline">Creates an instance group manager, as well as the instance group and the specified number of instances.</p>
92<p class="toc_element">
93 <code><a href="#list">list(project, zone, maxResults=None, pageToken=None, filter=None)</a></code></p>
94<p class="firstline">Retrieves the list of Instance Group Manager resources contained within the specified zone.</p>
95<p class="toc_element">
96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
97<p class="firstline">Retrieves the next page of results.</p>
98<p class="toc_element">
99 <code><a href="#recreateInstances">recreateInstances(project, zone, instanceGroupManager, body)</a></code></p>
100<p class="firstline">Recreates the specified instances. The instances are deleted, then recreated using the instance group manager's current instance template.</p>
101<p class="toc_element">
102 <code><a href="#resize">resize(project, zone, instanceGroupManager, size)</a></code></p>
103<p class="firstline">Resizes the managed instance group up or down. If resized up, new instances are created using the current instance template. If resized down, instances are removed in the order outlined in Resizing a managed instance group.</p>
104<p class="toc_element">
105 <code><a href="#setInstanceTemplate">setInstanceTemplate(project, zone, instanceGroupManager, body)</a></code></p>
106<p class="firstline">Sets the instance template to use when creating new instances in this group. Existing instances are not affected.</p>
107<p class="toc_element">
108 <code><a href="#setTargetPools">setTargetPools(project, zone, instanceGroupManager, body)</a></code></p>
109<p class="firstline">Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.</p>
110<h3>Method Details</h3>
111<div class="method">
112 <code class="details" id="abandonInstances">abandonInstances(project, zone, instanceGroupManager, body)</code>
113 <pre>Removes the specified instances from the managed instance group, and from any target pools of which they were members, without deleting the instances.
114
115Args:
116 project: string, The Google Developers Console project name. (required)
117 zone: string, The name of the zone in which the instance group manager resides. (required)
118 instanceGroupManager: string, The name of the instance group manager. (required)
119 body: object, The request body. (required)
120 The object takes the form of:
121
122{
123 "instances": [ # The names of one or more instances to abandon. For example:
124 # { 'instances': [ 'instance-c3po', 'instance-r2d2' ] }
125 "A String",
126 ],
127 }
128
129
130Returns:
131 An object of the form:
132
133 { # An operation resource, used to manage asynchronous API requests.
134 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
135 "clientOperationId": "A String", # [Output only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
136 "creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
137 "id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
138 "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
139 "operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
140 "httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
141 "progress": 42, # [Output only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
142 "httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
143 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
144 "status": "A String", # [Output Only] Status of the operation.
145 "insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
146 "warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
147 {
148 "message": "A String", # [Output only] Optional human-readable details for this warning.
149 "code": "A String", # [Output only] The warning type identifier for this warning.
150 "data": [ # [Output only] Metadata for this warning in key:value format.
151 {
152 "value": "A String", # [Output Only] Metadata value for this warning.
153 "key": "A String", # [Output Only] Metadata key for this warning.
154 },
155 ],
156 },
157 ],
158 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
159 "startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
160 "kind": "replicapool#operation", # [Output only] Type of the resource.
161 "name": "A String", # [Output Only] Name of the resource.
162 "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
163 "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
164 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
165 {
166 "message": "A String", # [Output Only] An optional, human-readable error message.
167 "code": "A String", # [Output Only] The error type identifier for this error.
168 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
169 },
170 ],
171 },
172 "endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
173 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
174 "targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
175 }</pre>
176</div>
177
178<div class="method">
179 <code class="details" id="delete">delete(project, zone, instanceGroupManager)</code>
180 <pre>Deletes the instance group manager and all instances contained within. If you'd like to delete the manager without deleting the instances, you must first abandon the instances to remove them from the group.
181
182Args:
183 project: string, The Google Developers Console project name. (required)
184 zone: string, The name of the zone in which the instance group manager resides. (required)
185 instanceGroupManager: string, Name of the Instance Group Manager resource to delete. (required)
186
187Returns:
188 An object of the form:
189
190 { # An operation resource, used to manage asynchronous API requests.
191 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
192 "clientOperationId": "A String", # [Output only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
193 "creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
194 "id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
195 "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
196 "operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
197 "httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
198 "progress": 42, # [Output only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
199 "httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
200 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
201 "status": "A String", # [Output Only] Status of the operation.
202 "insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
203 "warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
204 {
205 "message": "A String", # [Output only] Optional human-readable details for this warning.
206 "code": "A String", # [Output only] The warning type identifier for this warning.
207 "data": [ # [Output only] Metadata for this warning in key:value format.
208 {
209 "value": "A String", # [Output Only] Metadata value for this warning.
210 "key": "A String", # [Output Only] Metadata key for this warning.
211 },
212 ],
213 },
214 ],
215 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
216 "startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
217 "kind": "replicapool#operation", # [Output only] Type of the resource.
218 "name": "A String", # [Output Only] Name of the resource.
219 "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
220 "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
221 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
222 {
223 "message": "A String", # [Output Only] An optional, human-readable error message.
224 "code": "A String", # [Output Only] The error type identifier for this error.
225 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
226 },
227 ],
228 },
229 "endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
230 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
231 "targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
232 }</pre>
233</div>
234
235<div class="method">
236 <code class="details" id="deleteInstances">deleteInstances(project, zone, instanceGroupManager, body)</code>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]237 <pre>Deletes the specified instances. The instances are deleted, then removed from the instance group and any target pools of which they were a member. The targetSize of the instance group manager is reduced by the number of instances deleted.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]238
239Args:
240 project: string, The Google Developers Console project name. (required)
241 zone: string, The name of the zone in which the instance group manager resides. (required)
242 instanceGroupManager: string, The name of the instance group manager. (required)
243 body: object, The request body. (required)
244 The object takes the form of:
245
246{
247 "instances": [ # Names of instances to delete.
248 #
249 # Example: 'instance-foo', 'instance-bar'
250 "A String",
251 ],
252 }
253
254
255Returns:
256 An object of the form:
257
258 { # An operation resource, used to manage asynchronous API requests.
259 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
260 "clientOperationId": "A String", # [Output only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
261 "creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
262 "id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
263 "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
264 "operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
265 "httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
266 "progress": 42, # [Output only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
267 "httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
268 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
269 "status": "A String", # [Output Only] Status of the operation.
270 "insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
271 "warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
272 {
273 "message": "A String", # [Output only] Optional human-readable details for this warning.
274 "code": "A String", # [Output only] The warning type identifier for this warning.
275 "data": [ # [Output only] Metadata for this warning in key:value format.
276 {
277 "value": "A String", # [Output Only] Metadata value for this warning.
278 "key": "A String", # [Output Only] Metadata key for this warning.
279 },
280 ],
281 },
282 ],
283 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
284 "startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
285 "kind": "replicapool#operation", # [Output only] Type of the resource.
286 "name": "A String", # [Output Only] Name of the resource.
287 "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
288 "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
289 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
290 {
291 "message": "A String", # [Output Only] An optional, human-readable error message.
292 "code": "A String", # [Output Only] The error type identifier for this error.
293 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
294 },
295 ],
296 },
297 "endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
298 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
299 "targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
300 }</pre>
301</div>
302
303<div class="method">
304 <code class="details" id="get">get(project, zone, instanceGroupManager)</code>
305 <pre>Returns the specified Instance Group Manager resource.
306
307Args:
308 project: string, The Google Developers Console project name. (required)
309 zone: string, The name of the zone in which the instance group manager resides. (required)
310 instanceGroupManager: string, Name of the instance resource to return. (required)
311
312Returns:
313 An object of the form:
314
315 { # An Instance Group Manager resource.
316 "kind": "replicapool#instanceGroupManager", # [Output only] The resource type. Always replicapool#instanceGroupManager.
317 "group": "A String", # [Output only] The full URL of the instance group created by the manager. This group contains all of the instances being managed, and cannot contain non-managed instances.
318 "description": "A String", # An optional textual description of the instance group manager.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]319 "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
320 {
321 "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
322 },
323 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]324 "targetPools": [ # The full URL of all target pools to which new instances in the group are added. Updating the target pool values does not affect existing instances.
325 "A String",
326 ],
327 "targetSize": 42, # [Output only] The number of instances that the manager is attempting to maintain. Deleting or abandoning instances affects this number, as does resizing the group.
328 "name": "A String", # The name of the instance group manager. Must be 1-63 characters long and comply with RFC1035. Supported characters include lowercase letters, numbers, and hyphens.
329 "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be a valid RFC1035 name. Supported characters are lowercase letters, numbers, and hyphens (-). Instances are named by appending a hyphen and a random four-character string to the base instance name.
330 "fingerprint": "A String", # [Output only] Fingerprint of the instance group manager. This field is used for optimistic locking. An up-to-date fingerprint must be provided in order to modify the Instance Group Manager resource.
331 "instanceTemplate": "A String", # The full URL to an instance template from which all new instances will be created.
332 "creationTimestamp": "A String", # [Output only] The time the instance group manager was created, in RFC3339 text format.
333 "id": "A String", # [Output only] A server-assigned unique identifier for the resource.
334 "selfLink": "A String", # [Output only] The fully qualified URL for this resource.
335 "currentSize": 42, # [Output only] The number of instances that currently exist and are a part of this group. This includes instances that are starting but are not yet RUNNING, and instances that are in the process of being deleted or abandoned.
336 }</pre>
337</div>
338
339<div class="method">
340 <code class="details" id="insert">insert(project, zone, size, body)</code>
341 <pre>Creates an instance group manager, as well as the instance group and the specified number of instances.
342
343Args:
344 project: string, The Google Developers Console project name. (required)
345 zone: string, The name of the zone in which the instance group manager resides. (required)
346 size: integer, Number of instances that should exist. (required)
347 body: object, The request body. (required)
348 The object takes the form of:
349
350{ # An Instance Group Manager resource.
351 "kind": "replicapool#instanceGroupManager", # [Output only] The resource type. Always replicapool#instanceGroupManager.
352 "group": "A String", # [Output only] The full URL of the instance group created by the manager. This group contains all of the instances being managed, and cannot contain non-managed instances.
353 "description": "A String", # An optional textual description of the instance group manager.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]354 "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
355 {
356 "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
357 },
358 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]359 "targetPools": [ # The full URL of all target pools to which new instances in the group are added. Updating the target pool values does not affect existing instances.
360 "A String",
361 ],
362 "targetSize": 42, # [Output only] The number of instances that the manager is attempting to maintain. Deleting or abandoning instances affects this number, as does resizing the group.
363 "name": "A String", # The name of the instance group manager. Must be 1-63 characters long and comply with RFC1035. Supported characters include lowercase letters, numbers, and hyphens.
364 "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be a valid RFC1035 name. Supported characters are lowercase letters, numbers, and hyphens (-). Instances are named by appending a hyphen and a random four-character string to the base instance name.
365 "fingerprint": "A String", # [Output only] Fingerprint of the instance group manager. This field is used for optimistic locking. An up-to-date fingerprint must be provided in order to modify the Instance Group Manager resource.
366 "instanceTemplate": "A String", # The full URL to an instance template from which all new instances will be created.
367 "creationTimestamp": "A String", # [Output only] The time the instance group manager was created, in RFC3339 text format.
368 "id": "A String", # [Output only] A server-assigned unique identifier for the resource.
369 "selfLink": "A String", # [Output only] The fully qualified URL for this resource.
370 "currentSize": 42, # [Output only] The number of instances that currently exist and are a part of this group. This includes instances that are starting but are not yet RUNNING, and instances that are in the process of being deleted or abandoned.
371 }
372
373
374Returns:
375 An object of the form:
376
377 { # An operation resource, used to manage asynchronous API requests.
378 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
379 "clientOperationId": "A String", # [Output only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
380 "creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
381 "id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
382 "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
383 "operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
384 "httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
385 "progress": 42, # [Output only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
386 "httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
387 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
388 "status": "A String", # [Output Only] Status of the operation.
389 "insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
390 "warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
391 {
392 "message": "A String", # [Output only] Optional human-readable details for this warning.
393 "code": "A String", # [Output only] The warning type identifier for this warning.
394 "data": [ # [Output only] Metadata for this warning in key:value format.
395 {
396 "value": "A String", # [Output Only] Metadata value for this warning.
397 "key": "A String", # [Output Only] Metadata key for this warning.
398 },
399 ],
400 },
401 ],
402 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
403 "startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
404 "kind": "replicapool#operation", # [Output only] Type of the resource.
405 "name": "A String", # [Output Only] Name of the resource.
406 "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
407 "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
408 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
409 {
410 "message": "A String", # [Output Only] An optional, human-readable error message.
411 "code": "A String", # [Output Only] The error type identifier for this error.
412 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
413 },
414 ],
415 },
416 "endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
417 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
418 "targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
419 }</pre>
420</div>
421
422<div class="method">
423 <code class="details" id="list">list(project, zone, maxResults=None, pageToken=None, filter=None)</code>
424 <pre>Retrieves the list of Instance Group Manager resources contained within the specified zone.
425
426Args:
427 project: string, The Google Developers Console project name. (required)
428 zone: string, The name of the zone in which the instance group manager resides. (required)
429 maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
430 pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
431 filter: string, Optional. Filter expression for filtering listed resources.
432
433Returns:
434 An object of the form:
435
436 {
437 "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
438 "items": [ # A list of instance resources.
439 { # An Instance Group Manager resource.
440 "kind": "replicapool#instanceGroupManager", # [Output only] The resource type. Always replicapool#instanceGroupManager.
441 "group": "A String", # [Output only] The full URL of the instance group created by the manager. This group contains all of the instances being managed, and cannot contain non-managed instances.
442 "description": "A String", # An optional textual description of the instance group manager.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]443 "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
444 {
445 "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
446 },
447 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]448 "targetPools": [ # The full URL of all target pools to which new instances in the group are added. Updating the target pool values does not affect existing instances.
449 "A String",
450 ],
451 "targetSize": 42, # [Output only] The number of instances that the manager is attempting to maintain. Deleting or abandoning instances affects this number, as does resizing the group.
452 "name": "A String", # The name of the instance group manager. Must be 1-63 characters long and comply with RFC1035. Supported characters include lowercase letters, numbers, and hyphens.
453 "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be a valid RFC1035 name. Supported characters are lowercase letters, numbers, and hyphens (-). Instances are named by appending a hyphen and a random four-character string to the base instance name.
454 "fingerprint": "A String", # [Output only] Fingerprint of the instance group manager. This field is used for optimistic locking. An up-to-date fingerprint must be provided in order to modify the Instance Group Manager resource.
455 "instanceTemplate": "A String", # The full URL to an instance template from which all new instances will be created.
456 "creationTimestamp": "A String", # [Output only] The time the instance group manager was created, in RFC3339 text format.
457 "id": "A String", # [Output only] A server-assigned unique identifier for the resource.
458 "selfLink": "A String", # [Output only] The fully qualified URL for this resource.
459 "currentSize": 42, # [Output only] The number of instances that currently exist and are a part of this group. This includes instances that are starting but are not yet RUNNING, and instances that are in the process of being deleted or abandoned.
460 },
461 ],
462 "kind": "replicapool#instanceGroupManagerList", # Type of resource.
463 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
464 "selfLink": "A String", # Server defined URL for this resource (output only).
465 }</pre>
466</div>
467
468<div class="method">
469 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
470 <pre>Retrieves the next page of results.
471
472Args:
473 previous_request: The request for the previous page. (required)
474 previous_response: The response from the request for the previous page. (required)
475
476Returns:
477 A request object that you can call 'execute()' on to request the next
478 page. Returns None if there are no more items in the collection.
479 </pre>
480</div>
481
482<div class="method">
483 <code class="details" id="recreateInstances">recreateInstances(project, zone, instanceGroupManager, body)</code>
484 <pre>Recreates the specified instances. The instances are deleted, then recreated using the instance group manager's current instance template.
485
486Args:
487 project: string, The Google Developers Console project name. (required)
488 zone: string, The name of the zone in which the instance group manager resides. (required)
489 instanceGroupManager: string, The name of the instance group manager. (required)
490 body: object, The request body. (required)
491 The object takes the form of:
492
493{
494 "instances": [ # The names of one or more instances to recreate. For example:
495 # { 'instances': [ 'instance-c3po', 'instance-r2d2' ] }
496 "A String",
497 ],
498 }
499
500
501Returns:
502 An object of the form:
503
504 { # An operation resource, used to manage asynchronous API requests.
505 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
506 "clientOperationId": "A String", # [Output only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
507 "creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
508 "id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
509 "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
510 "operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
511 "httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
512 "progress": 42, # [Output only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
513 "httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
514 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
515 "status": "A String", # [Output Only] Status of the operation.
516 "insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
517 "warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
518 {
519 "message": "A String", # [Output only] Optional human-readable details for this warning.
520 "code": "A String", # [Output only] The warning type identifier for this warning.
521 "data": [ # [Output only] Metadata for this warning in key:value format.
522 {
523 "value": "A String", # [Output Only] Metadata value for this warning.
524 "key": "A String", # [Output Only] Metadata key for this warning.
525 },
526 ],
527 },
528 ],
529 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
530 "startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
531 "kind": "replicapool#operation", # [Output only] Type of the resource.
532 "name": "A String", # [Output Only] Name of the resource.
533 "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
534 "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
535 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
536 {
537 "message": "A String", # [Output Only] An optional, human-readable error message.
538 "code": "A String", # [Output Only] The error type identifier for this error.
539 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
540 },
541 ],
542 },
543 "endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
544 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
545 "targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
546 }</pre>
547</div>
548
549<div class="method">
550 <code class="details" id="resize">resize(project, zone, instanceGroupManager, size)</code>
551 <pre>Resizes the managed instance group up or down. If resized up, new instances are created using the current instance template. If resized down, instances are removed in the order outlined in Resizing a managed instance group.
552
553Args:
554 project: string, The Google Developers Console project name. (required)
555 zone: string, The name of the zone in which the instance group manager resides. (required)
556 instanceGroupManager: string, The name of the instance group manager. (required)
557 size: integer, Number of instances that should exist in this Instance Group Manager. (required)
558
559Returns:
560 An object of the form:
561
562 { # An operation resource, used to manage asynchronous API requests.
563 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
564 "clientOperationId": "A String", # [Output only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
565 "creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
566 "id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
567 "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
568 "operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
569 "httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
570 "progress": 42, # [Output only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
571 "httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
572 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
573 "status": "A String", # [Output Only] Status of the operation.
574 "insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
575 "warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
576 {
577 "message": "A String", # [Output only] Optional human-readable details for this warning.
578 "code": "A String", # [Output only] The warning type identifier for this warning.
579 "data": [ # [Output only] Metadata for this warning in key:value format.
580 {
581 "value": "A String", # [Output Only] Metadata value for this warning.
582 "key": "A String", # [Output Only] Metadata key for this warning.
583 },
584 ],
585 },
586 ],
587 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
588 "startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
589 "kind": "replicapool#operation", # [Output only] Type of the resource.
590 "name": "A String", # [Output Only] Name of the resource.
591 "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
592 "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
593 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
594 {
595 "message": "A String", # [Output Only] An optional, human-readable error message.
596 "code": "A String", # [Output Only] The error type identifier for this error.
597 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
598 },
599 ],
600 },
601 "endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
602 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
603 "targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
604 }</pre>
605</div>
606
607<div class="method">
608 <code class="details" id="setInstanceTemplate">setInstanceTemplate(project, zone, instanceGroupManager, body)</code>
609 <pre>Sets the instance template to use when creating new instances in this group. Existing instances are not affected.
610
611Args:
612 project: string, The Google Developers Console project name. (required)
613 zone: string, The name of the zone in which the instance group manager resides. (required)
614 instanceGroupManager: string, The name of the instance group manager. (required)
615 body: object, The request body. (required)
616 The object takes the form of:
617
618{
619 "instanceTemplate": "A String", # The full URL to an Instance Template from which all new instances will be created.
620 }
621
622
623Returns:
624 An object of the form:
625
626 { # An operation resource, used to manage asynchronous API requests.
627 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
628 "clientOperationId": "A String", # [Output only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
629 "creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
630 "id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
631 "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
632 "operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
633 "httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
634 "progress": 42, # [Output only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
635 "httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
636 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
637 "status": "A String", # [Output Only] Status of the operation.
638 "insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
639 "warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
640 {
641 "message": "A String", # [Output only] Optional human-readable details for this warning.
642 "code": "A String", # [Output only] The warning type identifier for this warning.
643 "data": [ # [Output only] Metadata for this warning in key:value format.
644 {
645 "value": "A String", # [Output Only] Metadata value for this warning.
646 "key": "A String", # [Output Only] Metadata key for this warning.
647 },
648 ],
649 },
650 ],
651 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
652 "startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
653 "kind": "replicapool#operation", # [Output only] Type of the resource.
654 "name": "A String", # [Output Only] Name of the resource.
655 "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
656 "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
657 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
658 {
659 "message": "A String", # [Output Only] An optional, human-readable error message.
660 "code": "A String", # [Output Only] The error type identifier for this error.
661 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
662 },
663 ],
664 },
665 "endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
666 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
667 "targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
668 }</pre>
669</div>
670
671<div class="method">
672 <code class="details" id="setTargetPools">setTargetPools(project, zone, instanceGroupManager, body)</code>
673 <pre>Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.
674
675Args:
676 project: string, The Google Developers Console project name. (required)
677 zone: string, The name of the zone in which the instance group manager resides. (required)
678 instanceGroupManager: string, The name of the instance group manager. (required)
679 body: object, The request body. (required)
680 The object takes the form of:
681
682{
683 "targetPools": [ # A list of fully-qualified URLs to existing Target Pool resources. New instances in the Instance Group Manager will be added to the specified target pools; existing instances are not affected.
684 "A String",
685 ],
686 "fingerprint": "A String", # The current fingerprint of the Instance Group Manager resource. If this does not match the server-side fingerprint of the resource, then the request will be rejected.
687 }
688
689
690Returns:
691 An object of the form:
692
693 { # An operation resource, used to manage asynchronous API requests.
694 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
695 "clientOperationId": "A String", # [Output only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
696 "creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
697 "id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
698 "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
699 "operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
700 "httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
701 "progress": 42, # [Output only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
702 "httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
703 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
704 "status": "A String", # [Output Only] Status of the operation.
705 "insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
706 "warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
707 {
708 "message": "A String", # [Output only] Optional human-readable details for this warning.
709 "code": "A String", # [Output only] The warning type identifier for this warning.
710 "data": [ # [Output only] Metadata for this warning in key:value format.
711 {
712 "value": "A String", # [Output Only] Metadata value for this warning.
713 "key": "A String", # [Output Only] Metadata key for this warning.
714 },
715 ],
716 },
717 ],
718 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
719 "startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
720 "kind": "replicapool#operation", # [Output only] Type of the resource.
721 "name": "A String", # [Output Only] Name of the resource.
722 "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
723 "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
724 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
725 {
726 "message": "A String", # [Output Only] An optional, human-readable error message.
727 "code": "A String", # [Output Only] The error type identifier for this error.
728 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
729 },
730 ],
731 },
732 "endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
733 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
734 "targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
735 }</pre>
736</div>
737
738</body></html>