Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / df61397973d36909a46fc4c3bf0e006dbb69f79a / . / docs / dyn / compute_alpha.regionInstanceGroupManagers.html
blob: bcd6d5ce118bb49a55350850c9a5627d15fdb978 [file] [log] [blame]
Sai Cheemalapatidf613972016-10-21 13:59:49 -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="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.regionInstanceGroupManagers.html">regionInstanceGroupManagers</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#abandonInstances">abandonInstances(project, region, instanceGroupManager, body)</a></code></p>
79<p class="firstline">Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(project, region, instanceGroupManager)</a></code></p>
82<p class="firstline">Deletes the specified managed instance group and all of the instances in that group.</p>
83<p class="toc_element">
84 <code><a href="#deleteInstances">deleteInstances(project, region, instanceGroupManager, body)</a></code></p>
85<p class="firstline">Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.</p>
86<p class="toc_element">
87 <code><a href="#get">get(project, region, instanceGroupManager)</a></code></p>
88<p class="firstline">Returns all of the details about the specified managed instance group.</p>
89<p class="toc_element">
90 <code><a href="#insert">insert(project, region, body)</a></code></p>
91<p class="firstline">Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.</p>
92<p class="toc_element">
93 <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
94<p class="firstline">Retrieves the list of managed instance groups that are contained within the specified region.</p>
95<p class="toc_element">
96 <code><a href="#listManagedInstances">listManagedInstances(project, region, instanceGroupManager)</a></code></p>
97<p class="firstline">Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances.</p>
98<p class="toc_element">
99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
100<p class="firstline">Retrieves the next page of results.</p>
101<p class="toc_element">
102 <code><a href="#patch">patch(project, region, instanceGroupManager, body)</a></code></p>
103<p class="firstline">Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports patch semantics.</p>
104<p class="toc_element">
105 <code><a href="#recreateInstances">recreateInstances(project, region, instanceGroupManager, body)</a></code></p>
106<p class="firstline">Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.</p>
107<p class="toc_element">
108 <code><a href="#resize">resize(project, region, instanceGroupManager, size)</a></code></p>
109<p class="firstline">Changes the intended size for the managed instance group. If you increase the size, the group schedules actions to create new instances using the current instance template. If you decrease the size, the group schedules delete actions on one or more instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.</p>
110<p class="toc_element">
111 <code><a href="#setAutoHealingPolicies">setAutoHealingPolicies(project, region, instanceGroupManager, body)</a></code></p>
112<p class="firstline">Modifies the autohealing policy for the instances in this managed instance group.</p>
113<p class="toc_element">
114 <code><a href="#setInstanceTemplate">setInstanceTemplate(project, region, instanceGroupManager, body)</a></code></p>
115<p class="firstline">Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected.</p>
116<p class="toc_element">
117 <code><a href="#setTargetPools">setTargetPools(project, region, instanceGroupManager, body)</a></code></p>
118<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>
119<p class="toc_element">
120 <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body)</a></code></p>
121<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
122<p class="toc_element">
123 <code><a href="#update">update(project, region, instanceGroupManager, body)</a></code></p>
124<p class="firstline">Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method.</p>
125<h3>Method Details</h3>
126<div class="method">
127 <code class="details" id="abandonInstances">abandonInstances(project, region, instanceGroupManager, body)</code>
128 <pre>Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.
129
130Args:
131 project: string, Project ID for this request. (required)
132 region: string, Name of the region scoping this request. (required)
133 instanceGroupManager: string, Name of the managed instance group. (required)
134 body: object, The request body. (required)
135 The object takes the form of:
136
137{
138 "instances": [ # The names of one or more instances to abandon.
139 "A String",
140 ],
141 }
142
143
144Returns:
145 An object of the form:
146
147 { # An Operation resource, used to manage asynchronous API requests.
148 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
149 "clientOperationId": "A String", # [Output Only] Reserved for future use.
150 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
151 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
152 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
153 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
154 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
155 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
156 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
157 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
158 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
159 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
160 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
161 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
162 {
163 "message": "A String", # [Output Only] A human-readable description of the warning code.
164 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
165 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
166 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
167 {
168 "value": "A String", # [Output Only] A warning data value corresponding to the key.
169 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
170 },
171 ],
172 },
173 ],
174 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
175 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
176 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
177 "name": "A String", # [Output Only] Name of the resource.
178 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
179 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
180 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
181 {
182 "message": "A String", # [Output Only] An optional, human-readable error message.
183 "code": "A String", # [Output Only] The error type identifier for this error.
184 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
185 },
186 ],
187 },
188 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
189 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
190 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
191 }</pre>
192</div>
193
194<div class="method">
195 <code class="details" id="delete">delete(project, region, instanceGroupManager)</code>
196 <pre>Deletes the specified managed instance group and all of the instances in that group.
197
198Args:
199 project: string, Project ID for this request. (required)
200 region: string, Name of the region scoping this request. (required)
201 instanceGroupManager: string, Name of the managed instance group to delete. (required)
202
203Returns:
204 An object of the form:
205
206 { # An Operation resource, used to manage asynchronous API requests.
207 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
208 "clientOperationId": "A String", # [Output Only] Reserved for future use.
209 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
210 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
211 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
212 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
213 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
214 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
215 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
216 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
217 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
218 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
219 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
220 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
221 {
222 "message": "A String", # [Output Only] A human-readable description of the warning code.
223 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
224 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
225 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
226 {
227 "value": "A String", # [Output Only] A warning data value corresponding to the key.
228 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
229 },
230 ],
231 },
232 ],
233 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
234 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
235 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
236 "name": "A String", # [Output Only] Name of the resource.
237 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
238 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
239 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
240 {
241 "message": "A String", # [Output Only] An optional, human-readable error message.
242 "code": "A String", # [Output Only] The error type identifier for this error.
243 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
244 },
245 ],
246 },
247 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
248 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
249 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
250 }</pre>
251</div>
252
253<div class="method">
254 <code class="details" id="deleteInstances">deleteInstances(project, region, instanceGroupManager, body)</code>
255 <pre>Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.
256
257Args:
258 project: string, Project ID for this request. (required)
259 region: string, Name of the region scoping this request. (required)
260 instanceGroupManager: string, Name of the managed instance group. (required)
261 body: object, The request body. (required)
262 The object takes the form of:
263
264{
265 "instances": [ # The names of one or more instances to delete.
266 "A String",
267 ],
268 }
269
270
271Returns:
272 An object of the form:
273
274 { # An Operation resource, used to manage asynchronous API requests.
275 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
276 "clientOperationId": "A String", # [Output Only] Reserved for future use.
277 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
278 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
279 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
280 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
281 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
282 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
283 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
284 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
285 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
286 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
287 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
288 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
289 {
290 "message": "A String", # [Output Only] A human-readable description of the warning code.
291 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
292 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
293 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
294 {
295 "value": "A String", # [Output Only] A warning data value corresponding to the key.
296 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
297 },
298 ],
299 },
300 ],
301 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
302 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
303 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
304 "name": "A String", # [Output Only] Name of the resource.
305 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
306 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
307 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
308 {
309 "message": "A String", # [Output Only] An optional, human-readable error message.
310 "code": "A String", # [Output Only] The error type identifier for this error.
311 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
312 },
313 ],
314 },
315 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
316 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
317 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
318 }</pre>
319</div>
320
321<div class="method">
322 <code class="details" id="get">get(project, region, instanceGroupManager)</code>
323 <pre>Returns all of the details about the specified managed instance group.
324
325Args:
326 project: string, Project ID for this request. (required)
327 region: string, Name of the region scoping this request. (required)
328 instanceGroupManager: string, Name of the managed instance group to return. (required)
329
330Returns:
331 An object of the form:
332
333 { # An Instance Group Manager resource.
334 "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
335 "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
336 "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
337 "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
338 #
339 # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
340 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
341 "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
342 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
343 "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
344 "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
345 },
346 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
347 "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
348 "versions": [ # Versions supported by this IGM. User should set this field if they need fine-grained control over how many instances in each version are run by this IGM. Versions are keyed by instanceTemplate. Every instanceTemplate can appear at most once. This field overrides instanceTemplate field. If both instanceTemplate and versions are set, the user receives a warning. "instanceTemplate: X" is semantically equivalent to "versions [ { instanceTemplate: X } ]". Exactly one version must have targetSize field left unset. Size of such a version will be calculated automatically.
349 {
350 "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Intended number of instances that are created from instanceTemplate. The final number of instances created from instanceTemplate will be equal to: * if expressed as fixed number: min(targetSize.fixed, instanceGroupManager.targetSize), * if expressed as percent: ceiling(targetSize.percent * InstanceGroupManager.targetSize). If unset, this version will handle all the remaining instances.
351 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
352 "fixed": 42, # fixed must be non-negative.
353 "percent": 42, # percent must belong to [0, 100].
354 },
355 "instanceTemplate": "A String",
356 "tag": "A String", # Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged.
357 },
358 ],
359 "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
360 {
361 "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
362 "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
363 "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when auto-healing. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a percent value of 100% is used.
364 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
365 "fixed": 42, # fixed must be non-negative.
366 "percent": 42, # percent must belong to [0, 100].
367 },
368 },
369 ],
370 "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
371 "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
372 "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
373 "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
374 "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
375 "A String",
376 ],
377 "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
378 "pendingActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions.
379 "recreating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be recreated.
380 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be deleted.
381 "creating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be created.
382 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be restarted.
383 },
384 "updatePolicy": { # The update policy for this managed instance group.
385 "type": "A String",
386 "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be created above the InstanceGroupManager.targetSize during the update process. By default, a fixed value of 1 is used. Using maxSurge > 0 will cause instance names to change during the update process. At least one of { maxSurge, maxUnavailable } must be greater than 0.
387 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
388 "fixed": 42, # fixed must be non-negative.
389 "percent": 42, # percent must belong to [0, 100].
390 },
391 "minimalAction": "A String", # Minimal action to be taken on an instance. The order of action types is: RESTART < REPLACE.
392 "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable during the update process. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a fixed value of 1 is used. At least one of { maxSurge, maxUnavailable } must be greater than 0.
393 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
394 "fixed": 42, # fixed must be non-negative.
395 "percent": 42, # percent must belong to [0, 100].
396 },
397 "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].
398 },
399 "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
400 "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
401 "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
402 "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
403 { # The named port. For example: .
404 "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
405 "port": 42, # The port number, which can be a value between 1 and 65535.
406 },
407 ],
408 "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
409 "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
410 "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
411 "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
412 }</pre>
413</div>
414
415<div class="method">
416 <code class="details" id="insert">insert(project, region, body)</code>
417 <pre>Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.
418
419Args:
420 project: string, Project ID for this request. (required)
421 region: string, Name of the region scoping this request. (required)
422 body: object, The request body. (required)
423 The object takes the form of:
424
425{ # An Instance Group Manager resource.
426 "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
427 "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
428 "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
429 "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
430 #
431 # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
432 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
433 "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
434 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
435 "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
436 "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
437 },
438 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
439 "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
440 "versions": [ # Versions supported by this IGM. User should set this field if they need fine-grained control over how many instances in each version are run by this IGM. Versions are keyed by instanceTemplate. Every instanceTemplate can appear at most once. This field overrides instanceTemplate field. If both instanceTemplate and versions are set, the user receives a warning. "instanceTemplate: X" is semantically equivalent to "versions [ { instanceTemplate: X } ]". Exactly one version must have targetSize field left unset. Size of such a version will be calculated automatically.
441 {
442 "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Intended number of instances that are created from instanceTemplate. The final number of instances created from instanceTemplate will be equal to: * if expressed as fixed number: min(targetSize.fixed, instanceGroupManager.targetSize), * if expressed as percent: ceiling(targetSize.percent * InstanceGroupManager.targetSize). If unset, this version will handle all the remaining instances.
443 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
444 "fixed": 42, # fixed must be non-negative.
445 "percent": 42, # percent must belong to [0, 100].
446 },
447 "instanceTemplate": "A String",
448 "tag": "A String", # Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged.
449 },
450 ],
451 "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
452 {
453 "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
454 "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
455 "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when auto-healing. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a percent value of 100% is used.
456 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
457 "fixed": 42, # fixed must be non-negative.
458 "percent": 42, # percent must belong to [0, 100].
459 },
460 },
461 ],
462 "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
463 "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
464 "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
465 "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
466 "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
467 "A String",
468 ],
469 "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
470 "pendingActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions.
471 "recreating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be recreated.
472 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be deleted.
473 "creating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be created.
474 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be restarted.
475 },
476 "updatePolicy": { # The update policy for this managed instance group.
477 "type": "A String",
478 "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be created above the InstanceGroupManager.targetSize during the update process. By default, a fixed value of 1 is used. Using maxSurge > 0 will cause instance names to change during the update process. At least one of { maxSurge, maxUnavailable } must be greater than 0.
479 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
480 "fixed": 42, # fixed must be non-negative.
481 "percent": 42, # percent must belong to [0, 100].
482 },
483 "minimalAction": "A String", # Minimal action to be taken on an instance. The order of action types is: RESTART < REPLACE.
484 "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable during the update process. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a fixed value of 1 is used. At least one of { maxSurge, maxUnavailable } must be greater than 0.
485 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
486 "fixed": 42, # fixed must be non-negative.
487 "percent": 42, # percent must belong to [0, 100].
488 },
489 "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].
490 },
491 "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
492 "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
493 "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
494 "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
495 { # The named port. For example: .
496 "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
497 "port": 42, # The port number, which can be a value between 1 and 65535.
498 },
499 ],
500 "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
501 "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
502 "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
503 "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
504 }
505
506
507Returns:
508 An object of the form:
509
510 { # An Operation resource, used to manage asynchronous API requests.
511 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
512 "clientOperationId": "A String", # [Output Only] Reserved for future use.
513 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
514 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
515 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
516 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
517 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
518 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
519 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
520 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
521 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
522 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
523 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
524 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
525 {
526 "message": "A String", # [Output Only] A human-readable description of the warning code.
527 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
528 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
529 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
530 {
531 "value": "A String", # [Output Only] A warning data value corresponding to the key.
532 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
533 },
534 ],
535 },
536 ],
537 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
538 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
539 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
540 "name": "A String", # [Output Only] Name of the resource.
541 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
542 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
543 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
544 {
545 "message": "A String", # [Output Only] An optional, human-readable error message.
546 "code": "A String", # [Output Only] The error type identifier for this error.
547 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
548 },
549 ],
550 },
551 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
552 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
553 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
554 }</pre>
555</div>
556
557<div class="method">
558 <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
559 <pre>Retrieves the list of managed instance groups that are contained within the specified region.
560
561Args:
562 project: string, Project ID for this request. (required)
563 region: string, Name of the region scoping this request. (required)
564 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
565
566You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
567
568Currently, only sorting by name or creationTimestamp desc is supported.
569 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
570 pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
571 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
572
573The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
574
575For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
576
577You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
578
579To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
580
581Returns:
582 An object of the form:
583
584 { # Contains a list of managed instance groups.
585 "nextPageToken": "A String", # [Output only] A token used to continue a truncated list request.
586 "items": [ # A list of managed instance groups.
587 { # An Instance Group Manager resource.
588 "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
589 "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
590 "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
591 "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
592 #
593 # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
594 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
595 "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
596 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
597 "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
598 "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
599 },
600 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
601 "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
602 "versions": [ # Versions supported by this IGM. User should set this field if they need fine-grained control over how many instances in each version are run by this IGM. Versions are keyed by instanceTemplate. Every instanceTemplate can appear at most once. This field overrides instanceTemplate field. If both instanceTemplate and versions are set, the user receives a warning. "instanceTemplate: X" is semantically equivalent to "versions [ { instanceTemplate: X } ]". Exactly one version must have targetSize field left unset. Size of such a version will be calculated automatically.
603 {
604 "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Intended number of instances that are created from instanceTemplate. The final number of instances created from instanceTemplate will be equal to: * if expressed as fixed number: min(targetSize.fixed, instanceGroupManager.targetSize), * if expressed as percent: ceiling(targetSize.percent * InstanceGroupManager.targetSize). If unset, this version will handle all the remaining instances.
605 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
606 "fixed": 42, # fixed must be non-negative.
607 "percent": 42, # percent must belong to [0, 100].
608 },
609 "instanceTemplate": "A String",
610 "tag": "A String", # Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged.
611 },
612 ],
613 "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
614 {
615 "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
616 "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
617 "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when auto-healing. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a percent value of 100% is used.
618 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
619 "fixed": 42, # fixed must be non-negative.
620 "percent": 42, # percent must belong to [0, 100].
621 },
622 },
623 ],
624 "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
625 "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
626 "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
627 "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
628 "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
629 "A String",
630 ],
631 "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
632 "pendingActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions.
633 "recreating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be recreated.
634 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be deleted.
635 "creating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be created.
636 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be restarted.
637 },
638 "updatePolicy": { # The update policy for this managed instance group.
639 "type": "A String",
640 "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be created above the InstanceGroupManager.targetSize during the update process. By default, a fixed value of 1 is used. Using maxSurge > 0 will cause instance names to change during the update process. At least one of { maxSurge, maxUnavailable } must be greater than 0.
641 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
642 "fixed": 42, # fixed must be non-negative.
643 "percent": 42, # percent must belong to [0, 100].
644 },
645 "minimalAction": "A String", # Minimal action to be taken on an instance. The order of action types is: RESTART < REPLACE.
646 "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable during the update process. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a fixed value of 1 is used. At least one of { maxSurge, maxUnavailable } must be greater than 0.
647 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
648 "fixed": 42, # fixed must be non-negative.
649 "percent": 42, # percent must belong to [0, 100].
650 },
651 "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].
652 },
653 "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
654 "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
655 "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
656 "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
657 { # The named port. For example: .
658 "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
659 "port": 42, # The port number, which can be a value between 1 and 65535.
660 },
661 ],
662 "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
663 "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
664 "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
665 "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
666 },
667 ],
668 "kind": "compute#regionInstanceGroupManagerList", # [Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups that exist in th regional scope.
669 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
670 "selfLink": "A String", # [Output only] The URL for this resource type. The server generates this URL.
671 }</pre>
672</div>
673
674<div class="method">
675 <code class="details" id="listManagedInstances">listManagedInstances(project, region, instanceGroupManager)</code>
676 <pre>Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances.
677
678Args:
679 project: string, Project ID for this request. (required)
680 region: string, Name of the region scoping this request. (required)
681 instanceGroupManager: string, The name of the managed instance group. (required)
682
683Returns:
684 An object of the form:
685
686 {
687 "managedInstances": [ # List of managed instances.
688 {
689 "instanceStatus": "A String", # [Output Only] The status of the instance. This field is empty when the instance does not exist.
690 "lastAttempt": { # [Output Only] Information about the last attempt to create or delete the instance.
691 "errors": { # [Output Only] Encountered errors during the last attempt to create or delete the instance.
692 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
693 {
694 "message": "A String", # [Output Only] An optional, human-readable error message.
695 "code": "A String", # [Output Only] The error type identifier for this error.
696 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
697 },
698 ],
699 },
700 },
701 "tag": "A String", # [Output Only] Tag describing the version.
702 "instance": "A String", # [Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created.
703 "instanceTemplate": "A String", # [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }.
704 "standbyMode": "A String", # [Output Only] Standby mode of the instance. This field is non-empty iff the instance is a standby.
705 "currentAction": "A String", # [Output Only] The current action that the managed instance group has scheduled for the instance. Possible values:
706 # - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance.
707 # - CREATING The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful.
708 # - CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased instead.
709 # - RECREATING The managed instance group is recreating this instance.
710 # - DELETING The managed instance group is permanently deleting this instance.
711 # - ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group.
712 # - RESTARTING The managed instance group is restarting the instance.
713 # - REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance.
714 "id": "A String", # [Output only] The unique identifier for this resource. This field is empty when instance does not exist.
715 },
716 ],
717 }</pre>
718</div>
719
720<div class="method">
721 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
722 <pre>Retrieves the next page of results.
723
724Args:
725 previous_request: The request for the previous page. (required)
726 previous_response: The response from the request for the previous page. (required)
727
728Returns:
729 A request object that you can call 'execute()' on to request the next
730 page. Returns None if there are no more items in the collection.
731 </pre>
732</div>
733
734<div class="method">
735 <code class="details" id="patch">patch(project, region, instanceGroupManager, body)</code>
736 <pre>Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports patch semantics.
737
738Args:
739 project: string, Project ID for this request. (required)
740 region: string, Name of the region scoping this request. (required)
741 instanceGroupManager: string, The name of the instance group manager. (required)
742 body: object, The request body. (required)
743 The object takes the form of:
744
745{ # An Instance Group Manager resource.
746 "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
747 "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
748 "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
749 "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
750 #
751 # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
752 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
753 "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
754 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
755 "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
756 "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
757 },
758 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
759 "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
760 "versions": [ # Versions supported by this IGM. User should set this field if they need fine-grained control over how many instances in each version are run by this IGM. Versions are keyed by instanceTemplate. Every instanceTemplate can appear at most once. This field overrides instanceTemplate field. If both instanceTemplate and versions are set, the user receives a warning. "instanceTemplate: X" is semantically equivalent to "versions [ { instanceTemplate: X } ]". Exactly one version must have targetSize field left unset. Size of such a version will be calculated automatically.
761 {
762 "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Intended number of instances that are created from instanceTemplate. The final number of instances created from instanceTemplate will be equal to: * if expressed as fixed number: min(targetSize.fixed, instanceGroupManager.targetSize), * if expressed as percent: ceiling(targetSize.percent * InstanceGroupManager.targetSize). If unset, this version will handle all the remaining instances.
763 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
764 "fixed": 42, # fixed must be non-negative.
765 "percent": 42, # percent must belong to [0, 100].
766 },
767 "instanceTemplate": "A String",
768 "tag": "A String", # Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged.
769 },
770 ],
771 "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
772 {
773 "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
774 "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
775 "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when auto-healing. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a percent value of 100% is used.
776 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
777 "fixed": 42, # fixed must be non-negative.
778 "percent": 42, # percent must belong to [0, 100].
779 },
780 },
781 ],
782 "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
783 "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
784 "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
785 "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
786 "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
787 "A String",
788 ],
789 "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
790 "pendingActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions.
791 "recreating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be recreated.
792 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be deleted.
793 "creating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be created.
794 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be restarted.
795 },
796 "updatePolicy": { # The update policy for this managed instance group.
797 "type": "A String",
798 "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be created above the InstanceGroupManager.targetSize during the update process. By default, a fixed value of 1 is used. Using maxSurge > 0 will cause instance names to change during the update process. At least one of { maxSurge, maxUnavailable } must be greater than 0.
799 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
800 "fixed": 42, # fixed must be non-negative.
801 "percent": 42, # percent must belong to [0, 100].
802 },
803 "minimalAction": "A String", # Minimal action to be taken on an instance. The order of action types is: RESTART < REPLACE.
804 "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable during the update process. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a fixed value of 1 is used. At least one of { maxSurge, maxUnavailable } must be greater than 0.
805 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
806 "fixed": 42, # fixed must be non-negative.
807 "percent": 42, # percent must belong to [0, 100].
808 },
809 "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].
810 },
811 "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
812 "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
813 "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
814 "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
815 { # The named port. For example: .
816 "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
817 "port": 42, # The port number, which can be a value between 1 and 65535.
818 },
819 ],
820 "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
821 "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
822 "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
823 "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
824 }
825
826
827Returns:
828 An object of the form:
829
830 { # An Operation resource, used to manage asynchronous API requests.
831 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
832 "clientOperationId": "A String", # [Output Only] Reserved for future use.
833 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
834 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
835 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
836 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
837 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
838 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
839 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
840 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
841 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
842 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
843 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
844 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
845 {
846 "message": "A String", # [Output Only] A human-readable description of the warning code.
847 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
848 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
849 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
850 {
851 "value": "A String", # [Output Only] A warning data value corresponding to the key.
852 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
853 },
854 ],
855 },
856 ],
857 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
858 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
859 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
860 "name": "A String", # [Output Only] Name of the resource.
861 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
862 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
863 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
864 {
865 "message": "A String", # [Output Only] An optional, human-readable error message.
866 "code": "A String", # [Output Only] The error type identifier for this error.
867 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
868 },
869 ],
870 },
871 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
872 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
873 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
874 }</pre>
875</div>
876
877<div class="method">
878 <code class="details" id="recreateInstances">recreateInstances(project, region, instanceGroupManager, body)</code>
879 <pre>Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.
880
881Args:
882 project: string, Project ID for this request. (required)
883 region: string, Name of the region scoping this request. (required)
884 instanceGroupManager: string, Name of the managed instance group. (required)
885 body: object, The request body. (required)
886 The object takes the form of:
887
888{
889 "instances": [ # The URL for one or more instances to recreate.
890 "A String",
891 ],
892 }
893
894
895Returns:
896 An object of the form:
897
898 { # An Operation resource, used to manage asynchronous API requests.
899 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
900 "clientOperationId": "A String", # [Output Only] Reserved for future use.
901 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
902 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
903 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
904 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
905 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
906 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
907 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
908 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
909 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
910 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
911 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
912 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
913 {
914 "message": "A String", # [Output Only] A human-readable description of the warning code.
915 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
916 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
917 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
918 {
919 "value": "A String", # [Output Only] A warning data value corresponding to the key.
920 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
921 },
922 ],
923 },
924 ],
925 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
926 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
927 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
928 "name": "A String", # [Output Only] Name of the resource.
929 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
930 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
931 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
932 {
933 "message": "A String", # [Output Only] An optional, human-readable error message.
934 "code": "A String", # [Output Only] The error type identifier for this error.
935 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
936 },
937 ],
938 },
939 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
940 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
941 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
942 }</pre>
943</div>
944
945<div class="method">
946 <code class="details" id="resize">resize(project, region, instanceGroupManager, size)</code>
947 <pre>Changes the intended size for the managed instance group. If you increase the size, the group schedules actions to create new instances using the current instance template. If you decrease the size, the group schedules delete actions on one or more instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.
948
949Args:
950 project: string, Project ID for this request. (required)
951 region: string, Name of the region scoping this request. (required)
952 instanceGroupManager: string, Name of the managed instance group. (required)
953 size: integer, Number of instances that should exist in this instance group manager. (required)
954
955Returns:
956 An object of the form:
957
958 { # An Operation resource, used to manage asynchronous API requests.
959 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
960 "clientOperationId": "A String", # [Output Only] Reserved for future use.
961 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
962 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
963 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
964 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
965 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
966 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
967 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
968 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
969 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
970 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
971 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
972 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
973 {
974 "message": "A String", # [Output Only] A human-readable description of the warning code.
975 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
976 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
977 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
978 {
979 "value": "A String", # [Output Only] A warning data value corresponding to the key.
980 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
981 },
982 ],
983 },
984 ],
985 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
986 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
987 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
988 "name": "A String", # [Output Only] Name of the resource.
989 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
990 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
991 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
992 {
993 "message": "A String", # [Output Only] An optional, human-readable error message.
994 "code": "A String", # [Output Only] The error type identifier for this error.
995 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
996 },
997 ],
998 },
999 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
1000 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
1001 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
1002 }</pre>
1003</div>
1004
1005<div class="method">
1006 <code class="details" id="setAutoHealingPolicies">setAutoHealingPolicies(project, region, instanceGroupManager, body)</code>
1007 <pre>Modifies the autohealing policy for the instances in this managed instance group.
1008
1009Args:
1010 project: string, Project ID for this request. (required)
1011 region: string, Name of the region scoping this request. (required)
1012 instanceGroupManager: string, Name of the managed instance group. (required)
1013 body: object, The request body. (required)
1014 The object takes the form of:
1015
1016{
1017 "autoHealingPolicies": [
1018 {
1019 "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
1020 "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
1021 "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when auto-healing. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a percent value of 100% is used.
1022 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
1023 "fixed": 42, # fixed must be non-negative.
1024 "percent": 42, # percent must belong to [0, 100].
1025 },
1026 },
1027 ],
1028 }
1029
1030
1031Returns:
1032 An object of the form:
1033
1034 { # An Operation resource, used to manage asynchronous API requests.
1035 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
1036 "clientOperationId": "A String", # [Output Only] Reserved for future use.
1037 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
1038 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
1039 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
1040 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
1041 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
1042 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
1043 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
1044 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
1045 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
1046 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
1047 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
1048 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
1049 {
1050 "message": "A String", # [Output Only] A human-readable description of the warning code.
1051 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
1052 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
1053 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
1054 {
1055 "value": "A String", # [Output Only] A warning data value corresponding to the key.
1056 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
1057 },
1058 ],
1059 },
1060 ],
1061 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
1062 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
1063 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
1064 "name": "A String", # [Output Only] Name of the resource.
1065 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
1066 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
1067 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
1068 {
1069 "message": "A String", # [Output Only] An optional, human-readable error message.
1070 "code": "A String", # [Output Only] The error type identifier for this error.
1071 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
1072 },
1073 ],
1074 },
1075 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
1076 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
1077 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
1078 }</pre>
1079</div>
1080
1081<div class="method">
1082 <code class="details" id="setInstanceTemplate">setInstanceTemplate(project, region, instanceGroupManager, body)</code>
1083 <pre>Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected.
1084
1085Args:
1086 project: string, Project ID for this request. (required)
1087 region: string, Name of the region scoping this request. (required)
1088 instanceGroupManager: string, The name of the managed instance group. (required)
1089 body: object, The request body. (required)
1090 The object takes the form of:
1091
1092{
1093 "instanceTemplate": "A String", # URL of the InstanceTemplate resource from which all new instances will be created.
1094 }
1095
1096
1097Returns:
1098 An object of the form:
1099
1100 { # An Operation resource, used to manage asynchronous API requests.
1101 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
1102 "clientOperationId": "A String", # [Output Only] Reserved for future use.
1103 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
1104 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
1105 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
1106 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
1107 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
1108 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
1109 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
1110 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
1111 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
1112 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
1113 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
1114 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
1115 {
1116 "message": "A String", # [Output Only] A human-readable description of the warning code.
1117 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
1118 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
1119 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
1120 {
1121 "value": "A String", # [Output Only] A warning data value corresponding to the key.
1122 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
1123 },
1124 ],
1125 },
1126 ],
1127 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
1128 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
1129 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
1130 "name": "A String", # [Output Only] Name of the resource.
1131 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
1132 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
1133 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
1134 {
1135 "message": "A String", # [Output Only] An optional, human-readable error message.
1136 "code": "A String", # [Output Only] The error type identifier for this error.
1137 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
1138 },
1139 ],
1140 },
1141 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
1142 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
1143 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
1144 }</pre>
1145</div>
1146
1147<div class="method">
1148 <code class="details" id="setTargetPools">setTargetPools(project, region, instanceGroupManager, body)</code>
1149 <pre>Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.
1150
1151Args:
1152 project: string, Project ID for this request. (required)
1153 region: string, Name of the region scoping this request. (required)
1154 instanceGroupManager: string, Name of the managed instance group. (required)
1155 body: object, The request body. (required)
1156 The object takes the form of:
1157
1158{
1159 "targetPools": [ # The URL of all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
1160 "A String",
1161 ],
1162 "fingerprint": "A String", # Fingerprint of the target pools information, which is a hash of the contents. This field is used for optimistic locking when you update the target pool entries. This field is optional.
1163 }
1164
1165
1166Returns:
1167 An object of the form:
1168
1169 { # An Operation resource, used to manage asynchronous API requests.
1170 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
1171 "clientOperationId": "A String", # [Output Only] Reserved for future use.
1172 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
1173 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
1174 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
1175 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
1176 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
1177 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
1178 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
1179 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
1180 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
1181 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
1182 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
1183 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
1184 {
1185 "message": "A String", # [Output Only] A human-readable description of the warning code.
1186 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
1187 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
1188 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
1189 {
1190 "value": "A String", # [Output Only] A warning data value corresponding to the key.
1191 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
1192 },
1193 ],
1194 },
1195 ],
1196 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
1197 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
1198 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
1199 "name": "A String", # [Output Only] Name of the resource.
1200 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
1201 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
1202 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
1203 {
1204 "message": "A String", # [Output Only] An optional, human-readable error message.
1205 "code": "A String", # [Output Only] The error type identifier for this error.
1206 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
1207 },
1208 ],
1209 },
1210 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
1211 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
1212 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
1213 }</pre>
1214</div>
1215
1216<div class="method">
1217 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body)</code>
1218 <pre>Returns permissions that a caller has on the specified resource.
1219
1220Args:
1221 project: string, Project ID for this request. (required)
1222 region: string, The name of the region for this request. (required)
1223 resource: string, Name of the resource for this request. (required)
1224 body: object, The request body. (required)
1225 The object takes the form of:
1226
1227{
1228 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
1229 "A String",
1230 ],
1231 }
1232
1233
1234Returns:
1235 An object of the form:
1236
1237 {
1238 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
1239 "A String",
1240 ],
1241 }</pre>
1242</div>
1243
1244<div class="method">
1245 <code class="details" id="update">update(project, region, instanceGroupManager, body)</code>
1246 <pre>Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method.
1247
1248Args:
1249 project: string, Project ID for this request. (required)
1250 region: string, Name of the region scoping this request. (required)
1251 instanceGroupManager: string, The name of the instance group manager. (required)
1252 body: object, The request body. (required)
1253 The object takes the form of:
1254
1255{ # An Instance Group Manager resource.
1256 "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
1257 "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
1258 "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
1259 "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
1260 #
1261 # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
1262 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
1263 "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
1264 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
1265 "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
1266 "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
1267 },
1268 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
1269 "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
1270 "versions": [ # Versions supported by this IGM. User should set this field if they need fine-grained control over how many instances in each version are run by this IGM. Versions are keyed by instanceTemplate. Every instanceTemplate can appear at most once. This field overrides instanceTemplate field. If both instanceTemplate and versions are set, the user receives a warning. "instanceTemplate: X" is semantically equivalent to "versions [ { instanceTemplate: X } ]". Exactly one version must have targetSize field left unset. Size of such a version will be calculated automatically.
1271 {
1272 "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Intended number of instances that are created from instanceTemplate. The final number of instances created from instanceTemplate will be equal to: * if expressed as fixed number: min(targetSize.fixed, instanceGroupManager.targetSize), * if expressed as percent: ceiling(targetSize.percent * InstanceGroupManager.targetSize). If unset, this version will handle all the remaining instances.
1273 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
1274 "fixed": 42, # fixed must be non-negative.
1275 "percent": 42, # percent must belong to [0, 100].
1276 },
1277 "instanceTemplate": "A String",
1278 "tag": "A String", # Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged.
1279 },
1280 ],
1281 "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
1282 {
1283 "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
1284 "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
1285 "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when auto-healing. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a percent value of 100% is used.
1286 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
1287 "fixed": 42, # fixed must be non-negative.
1288 "percent": 42, # percent must belong to [0, 100].
1289 },
1290 },
1291 ],
1292 "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
1293 "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
1294 "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
1295 "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
1296 "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
1297 "A String",
1298 ],
1299 "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
1300 "pendingActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions.
1301 "recreating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be recreated.
1302 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be deleted.
1303 "creating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be created.
1304 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be restarted.
1305 },
1306 "updatePolicy": { # The update policy for this managed instance group.
1307 "type": "A String",
1308 "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be created above the InstanceGroupManager.targetSize during the update process. By default, a fixed value of 1 is used. Using maxSurge > 0 will cause instance names to change during the update process. At least one of { maxSurge, maxUnavailable } must be greater than 0.
1309 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
1310 "fixed": 42, # fixed must be non-negative.
1311 "percent": 42, # percent must belong to [0, 100].
1312 },
1313 "minimalAction": "A String", # Minimal action to be taken on an instance. The order of action types is: RESTART < REPLACE.
1314 "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable during the update process. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a fixed value of 1 is used. At least one of { maxSurge, maxUnavailable } must be greater than 0.
1315 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
1316 "fixed": 42, # fixed must be non-negative.
1317 "percent": 42, # percent must belong to [0, 100].
1318 },
1319 "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].
1320 },
1321 "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
1322 "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
1323 "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
1324 "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
1325 { # The named port. For example: .
1326 "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
1327 "port": 42, # The port number, which can be a value between 1 and 65535.
1328 },
1329 ],
1330 "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
1331 "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
1332 "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
1333 "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
1334 }
1335
1336
1337Returns:
1338 An object of the form:
1339
1340 { # An Operation resource, used to manage asynchronous API requests.
1341 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
1342 "clientOperationId": "A String", # [Output Only] Reserved for future use.
1343 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
1344 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
1345 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
1346 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
1347 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
1348 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
1349 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
1350 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
1351 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
1352 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
1353 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
1354 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
1355 {
1356 "message": "A String", # [Output Only] A human-readable description of the warning code.
1357 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
1358 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
1359 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
1360 {
1361 "value": "A String", # [Output Only] A warning data value corresponding to the key.
1362 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
1363 },
1364 ],
1365 },
1366 ],
1367 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
1368 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
1369 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
1370 "name": "A String", # [Output Only] Name of the resource.
1371 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
1372 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
1373 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
1374 {
1375 "message": "A String", # [Output Only] An optional, human-readable error message.
1376 "code": "A String", # [Output Only] The error type identifier for this error.
1377 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
1378 },
1379 ],
1380 },
1381 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
1382 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
1383 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
1384 }</pre>
1385</div>
1386
1387</body></html>