Google Git
Sign in
android / platform / external / python / google-api-python-client / e676ed8e61f18de4b7eef4845d60153cfe7fad5f / . / docs / dyn / replicapool_v1beta2.instanceGroupManagers.html
blob: 8c8bcb19e53d1fe148f49d6b5779c3d88d97a85e [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="replicapool_v1beta2.html">Google Compute Engine Instance Group Manager API</a> . <a href="replicapool_v1beta2.instanceGroupManagers.html">instanceGroupManagers</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#abandonInstances">abandonInstances(project, zone, instanceGroupManager, body)</a></code></p>
<p class="firstline">Removes the specified instances from the managed instance group, and from any target pools of which they were members, without deleting the instances.</p>
<p class="toc_element">
<code><a href="#delete">delete(project, zone, instanceGroupManager)</a></code></p>
<p class="firstline">Deletes the instance group manager and all instances contained within. If you'd like to delete the manager without deleting the instances, you must first abandon the instances to remove them from the group.</p>
<p class="toc_element">
<code><a href="#deleteInstances">deleteInstances(project, zone, instanceGroupManager, body)</a></code></p>
<p class="firstline">Deletes the specified instances. The instances are deleted, then removed from the instance group and any target pools of which they were a member. The targetSize of the instance group manager is reduced by the number of instances deleted.</p>
<p class="toc_element">
<code><a href="#get">get(project, zone, instanceGroupManager)</a></code></p>
<p class="firstline">Returns the specified Instance Group Manager resource.</p>
<p class="toc_element">
<code><a href="#insert">insert(project, zone, size, body)</a></code></p>
<p class="firstline">Creates an instance group manager, as well as the instance group and the specified number of instances.</p>
<p class="toc_element">
<code><a href="#list">list(project, zone, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves the list of Instance Group Manager resources contained within the specified zone.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#recreateInstances">recreateInstances(project, zone, instanceGroupManager, body)</a></code></p>
<p class="firstline">Recreates the specified instances. The instances are deleted, then recreated using the instance group manager's current instance template.</p>
<p class="toc_element">
<code><a href="#resize">resize(project, zone, instanceGroupManager, size)</a></code></p>
<p class="firstline">Resizes the managed instance group up or down. If resized up, new instances are created using the current instance template. If resized down, instances are removed in the order outlined in Resizing a managed instance group.</p>
<p class="toc_element">
<code><a href="#setInstanceTemplate">setInstanceTemplate(project, zone, instanceGroupManager, body)</a></code></p>
<p class="firstline">Sets the instance template to use when creating new instances in this group. Existing instances are not affected.</p>
<p class="toc_element">
<code><a href="#setTargetPools">setTargetPools(project, zone, instanceGroupManager, body)</a></code></p>
<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>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="abandonInstances">abandonInstances(project, zone, instanceGroupManager, body)</code>
<pre>Removes the specified instances from the managed instance group, and from any target pools of which they were members, without deleting the instances.
Args:
project: string, The Google Developers Console project name. (required)
zone: string, The name of the zone in which the instance group manager resides. (required)
instanceGroupManager: string, The name of the instance group manager. (required)
body: object, The request body. (required)
The object takes the form of:
{
"instances": [ # The names of one or more instances to abandon. For example:
# { 'instances': [ 'instance-c3po', 'instance-r2d2' ] }
"A String",
],
}
Returns:
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
"targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
"clientOperationId": "A String", # [Output only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
"creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
"zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
"operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
"httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
"progress": 42, # [Output only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
"httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
"status": "A String", # [Output Only] Status of the operation.
"insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
"warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
{
"message": "A String", # [Output only] Optional human-readable details for this warning.
"code": "A String", # [Output only] The warning type identifier for this warning.
"data": [ # [Output only] Metadata for this warning in key:value format.
{
"value": "A String", # [Output Only] Metadata value for this warning.
"key": "A String", # [Output Only] Metadata key for this warning.
},
],
},
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
"kind": "replicapool#operation", # [Output only] Type of the resource.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
"code": "A String", # [Output Only] The error type identifier for this error.
"location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
},
],
},
"endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
"targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(project, zone, instanceGroupManager)</code>
<pre>Deletes the instance group manager and all instances contained within. If you'd like to delete the manager without deleting the instances, you must first abandon the instances to remove them from the group.
Args:
project: string, The Google Developers Console project name. (required)
zone: string, The name of the zone in which the instance group manager resides. (required)
instanceGroupManager: string, Name of the Instance Group Manager resource to delete. (required)
Returns:
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
"targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
"clientOperationId": "A String", # [Output only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
"creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
"zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
"operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
"httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
"progress": 42, # [Output only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
"httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
"status": "A String", # [Output Only] Status of the operation.
"insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
"warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
{
"message": "A String", # [Output only] Optional human-readable details for this warning.
"code": "A String", # [Output only] The warning type identifier for this warning.
"data": [ # [Output only] Metadata for this warning in key:value format.
{
"value": "A String", # [Output Only] Metadata value for this warning.
"key": "A String", # [Output Only] Metadata key for this warning.
},
],
},
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
"kind": "replicapool#operation", # [Output only] Type of the resource.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
"code": "A String", # [Output Only] The error type identifier for this error.
"location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
},
],
},
"endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
"targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
}</pre>
</div>
<div class="method">
<code class="details" id="deleteInstances">deleteInstances(project, zone, instanceGroupManager, body)</code>
<pre>Deletes the specified instances. The instances are deleted, then removed from the instance group and any target pools of which they were a member. The targetSize of the instance group manager is reduced by the number of instances deleted.
Args:
project: string, The Google Developers Console project name. (required)
zone: string, The name of the zone in which the instance group manager resides. (required)
instanceGroupManager: string, The name of the instance group manager. (required)
body: object, The request body. (required)
The object takes the form of:
{
"instances": [ # Names of instances to delete.
#
# Example: 'instance-foo', 'instance-bar'
"A String",
],
}
Returns:
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
"targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
"clientOperationId": "A String", # [Output only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
"creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
"zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
"operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
"httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
"progress": 42, # [Output only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
"httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
"status": "A String", # [Output Only] Status of the operation.
"insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
"warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
{
"message": "A String", # [Output only] Optional human-readable details for this warning.
"code": "A String", # [Output only] The warning type identifier for this warning.
"data": [ # [Output only] Metadata for this warning in key:value format.
{
"value": "A String", # [Output Only] Metadata value for this warning.
"key": "A String", # [Output Only] Metadata key for this warning.
},
],
},
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
"kind": "replicapool#operation", # [Output only] Type of the resource.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
"code": "A String", # [Output Only] The error type identifier for this error.
"location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
},
],
},
"endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
"targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(project, zone, instanceGroupManager)</code>
<pre>Returns the specified Instance Group Manager resource.
Args:
project: string, The Google Developers Console project name. (required)
zone: string, The name of the zone in which the instance group manager resides. (required)
instanceGroupManager: string, Name of the instance resource to return. (required)
Returns:
An object of the form:
{ # An Instance Group Manager resource.
"kind": "replicapool#instanceGroupManager", # [Output only] The resource type. Always replicapool#instanceGroupManager.
"group": "A String", # [Output only] The full URL of the instance group created by the manager. This group contains all of the instances being managed, and cannot contain non-managed instances.
"description": "A String", # An optional textual description of the instance group manager.
"autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
{
"healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
"actionType": "A String", # The action to perform when an instance becomes unhealthy. Possible values are RECREATE or REBOOT. RECREATE replaces an unhealthy instance with a new instance that is based on the instance template for this managed instance group. REBOOT performs a soft reboot on an instance. If the instance cannot reboot, the instance performs a hard restart.
},
],
"targetPools": [ # The full URL of all target pools to which new instances in the group are added. Updating the target pool values does not affect existing instances.
"A String",
],
"targetSize": 42, # [Output only] The number of instances that the manager is attempting to maintain. Deleting or abandoning instances affects this number, as does resizing the group.
"name": "A String", # The name of the instance group manager. Must be 1-63 characters long and comply with RFC1035. Supported characters include lowercase letters, numbers, and hyphens.
"baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be a valid RFC1035 name. Supported characters are lowercase letters, numbers, and hyphens (-). Instances are named by appending a hyphen and a random four-character string to the base instance name.
"fingerprint": "A String", # [Output only] Fingerprint of the instance group manager. This field is used for optimistic locking. An up-to-date fingerprint must be provided in order to modify the Instance Group Manager resource.
"instanceTemplate": "A String", # The full URL to an instance template from which all new instances will be created.
"creationTimestamp": "A String", # [Output only] The time the instance group manager was created, in RFC3339 text format.
"id": "A String", # [Output only] A server-assigned unique identifier for the resource.
"selfLink": "A String", # [Output only] The fully qualified URL for this resource.
"currentSize": 42, # [Output only] The number of instances that currently exist and are a part of this group. This includes instances that are starting but are not yet RUNNING, and instances that are in the process of being deleted or abandoned.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(project, zone, size, body)</code>
<pre>Creates an instance group manager, as well as the instance group and the specified number of instances.
Args:
project: string, The Google Developers Console project name. (required)
zone: string, The name of the zone in which the instance group manager resides. (required)
size: integer, Number of instances that should exist. (required)
body: object, The request body. (required)
The object takes the form of:
{ # An Instance Group Manager resource.
"kind": "replicapool#instanceGroupManager", # [Output only] The resource type. Always replicapool#instanceGroupManager.
"group": "A String", # [Output only] The full URL of the instance group created by the manager. This group contains all of the instances being managed, and cannot contain non-managed instances.
"description": "A String", # An optional textual description of the instance group manager.
"autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
{
"healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
"actionType": "A String", # The action to perform when an instance becomes unhealthy. Possible values are RECREATE or REBOOT. RECREATE replaces an unhealthy instance with a new instance that is based on the instance template for this managed instance group. REBOOT performs a soft reboot on an instance. If the instance cannot reboot, the instance performs a hard restart.
},
],
"targetPools": [ # The full URL of all target pools to which new instances in the group are added. Updating the target pool values does not affect existing instances.
"A String",
],
"targetSize": 42, # [Output only] The number of instances that the manager is attempting to maintain. Deleting or abandoning instances affects this number, as does resizing the group.
"name": "A String", # The name of the instance group manager. Must be 1-63 characters long and comply with RFC1035. Supported characters include lowercase letters, numbers, and hyphens.
"baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be a valid RFC1035 name. Supported characters are lowercase letters, numbers, and hyphens (-). Instances are named by appending a hyphen and a random four-character string to the base instance name.
"fingerprint": "A String", # [Output only] Fingerprint of the instance group manager. This field is used for optimistic locking. An up-to-date fingerprint must be provided in order to modify the Instance Group Manager resource.
"instanceTemplate": "A String", # The full URL to an instance template from which all new instances will be created.
"creationTimestamp": "A String", # [Output only] The time the instance group manager was created, in RFC3339 text format.
"id": "A String", # [Output only] A server-assigned unique identifier for the resource.
"selfLink": "A String", # [Output only] The fully qualified URL for this resource.
"currentSize": 42, # [Output only] The number of instances that currently exist and are a part of this group. This includes instances that are starting but are not yet RUNNING, and instances that are in the process of being deleted or abandoned.
}
Returns:
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
"targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
"clientOperationId": "A String", # [Output only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
"creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
"zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
"operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
"httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
"progress": 42, # [Output only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
"httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
"status": "A String", # [Output Only] Status of the operation.
"insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
"warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
{
"message": "A String", # [Output only] Optional human-readable details for this warning.
"code": "A String", # [Output only] The warning type identifier for this warning.
"data": [ # [Output only] Metadata for this warning in key:value format.
{
"value": "A String", # [Output Only] Metadata value for this warning.
"key": "A String", # [Output Only] Metadata key for this warning.
},
],
},
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
"kind": "replicapool#operation", # [Output only] Type of the resource.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
"code": "A String", # [Output Only] The error type identifier for this error.
"location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
},
],
},
"endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
"targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(project, zone, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves the list of Instance Group Manager resources contained within the specified zone.
Args:
project: string, The Google Developers Console project name. (required)
zone: string, The name of the zone in which the instance group manager resides. (required)
maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
filter: string, Optional. Filter expression for filtering listed resources.
Returns:
An object of the form:
{
"nextPageToken": "A String", # A token used to continue a truncated list request (output only).
"items": [ # A list of instance resources.
{ # An Instance Group Manager resource.
"kind": "replicapool#instanceGroupManager", # [Output only] The resource type. Always replicapool#instanceGroupManager.
"group": "A String", # [Output only] The full URL of the instance group created by the manager. This group contains all of the instances being managed, and cannot contain non-managed instances.
"description": "A String", # An optional textual description of the instance group manager.
"autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
{
"healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
"actionType": "A String", # The action to perform when an instance becomes unhealthy. Possible values are RECREATE or REBOOT. RECREATE replaces an unhealthy instance with a new instance that is based on the instance template for this managed instance group. REBOOT performs a soft reboot on an instance. If the instance cannot reboot, the instance performs a hard restart.
},
],
"targetPools": [ # The full URL of all target pools to which new instances in the group are added. Updating the target pool values does not affect existing instances.
"A String",
],
"targetSize": 42, # [Output only] The number of instances that the manager is attempting to maintain. Deleting or abandoning instances affects this number, as does resizing the group.
"name": "A String", # The name of the instance group manager. Must be 1-63 characters long and comply with RFC1035. Supported characters include lowercase letters, numbers, and hyphens.
"baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be a valid RFC1035 name. Supported characters are lowercase letters, numbers, and hyphens (-). Instances are named by appending a hyphen and a random four-character string to the base instance name.
"fingerprint": "A String", # [Output only] Fingerprint of the instance group manager. This field is used for optimistic locking. An up-to-date fingerprint must be provided in order to modify the Instance Group Manager resource.
"instanceTemplate": "A String", # The full URL to an instance template from which all new instances will be created.
"creationTimestamp": "A String", # [Output only] The time the instance group manager was created, in RFC3339 text format.
"id": "A String", # [Output only] A server-assigned unique identifier for the resource.
"selfLink": "A String", # [Output only] The fully qualified URL for this resource.
"currentSize": 42, # [Output only] The number of instances that currently exist and are a part of this group. This includes instances that are starting but are not yet RUNNING, and instances that are in the process of being deleted or abandoned.
},
],
"kind": "replicapool#instanceGroupManagerList", # Type of resource.
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for this resource (output only).
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="recreateInstances">recreateInstances(project, zone, instanceGroupManager, body)</code>
<pre>Recreates the specified instances. The instances are deleted, then recreated using the instance group manager's current instance template.
Args:
project: string, The Google Developers Console project name. (required)
zone: string, The name of the zone in which the instance group manager resides. (required)
instanceGroupManager: string, The name of the instance group manager. (required)
body: object, The request body. (required)
The object takes the form of:
{
"instances": [ # The names of one or more instances to recreate. For example:
# { 'instances': [ 'instance-c3po', 'instance-r2d2' ] }
"A String",
],
}
Returns:
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
"targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
"clientOperationId": "A String", # [Output only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
"creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
"zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
"operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
"httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
"progress": 42, # [Output only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
"httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
"status": "A String", # [Output Only] Status of the operation.
"insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
"warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
{
"message": "A String", # [Output only] Optional human-readable details for this warning.
"code": "A String", # [Output only] The warning type identifier for this warning.
"data": [ # [Output only] Metadata for this warning in key:value format.
{
"value": "A String", # [Output Only] Metadata value for this warning.
"key": "A String", # [Output Only] Metadata key for this warning.
},
],
},
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
"kind": "replicapool#operation", # [Output only] Type of the resource.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
"code": "A String", # [Output Only] The error type identifier for this error.
"location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
},
],
},
"endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
"targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
}</pre>
</div>
<div class="method">
<code class="details" id="resize">resize(project, zone, instanceGroupManager, size)</code>
<pre>Resizes the managed instance group up or down. If resized up, new instances are created using the current instance template. If resized down, instances are removed in the order outlined in Resizing a managed instance group.
Args:
project: string, The Google Developers Console project name. (required)
zone: string, The name of the zone in which the instance group manager resides. (required)
instanceGroupManager: string, The name of the instance group manager. (required)
size: integer, Number of instances that should exist in this Instance Group Manager. (required)
Returns:
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
"targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
"clientOperationId": "A String", # [Output only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
"creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
"zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
"operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
"httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
"progress": 42, # [Output only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
"httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
"status": "A String", # [Output Only] Status of the operation.
"insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
"warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
{
"message": "A String", # [Output only] Optional human-readable details for this warning.
"code": "A String", # [Output only] The warning type identifier for this warning.
"data": [ # [Output only] Metadata for this warning in key:value format.
{
"value": "A String", # [Output Only] Metadata value for this warning.
"key": "A String", # [Output Only] Metadata key for this warning.
},
],
},
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
"kind": "replicapool#operation", # [Output only] Type of the resource.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
"code": "A String", # [Output Only] The error type identifier for this error.
"location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
},
],
},
"endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
"targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
}</pre>
</div>
<div class="method">
<code class="details" id="setInstanceTemplate">setInstanceTemplate(project, zone, instanceGroupManager, body)</code>
<pre>Sets the instance template to use when creating new instances in this group. Existing instances are not affected.
Args:
project: string, The Google Developers Console project name. (required)
zone: string, The name of the zone in which the instance group manager resides. (required)
instanceGroupManager: string, The name of the instance group manager. (required)
body: object, The request body. (required)
The object takes the form of:
{
"instanceTemplate": "A String", # The full URL to an Instance Template from which all new instances will be created.
}
Returns:
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
"targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
"clientOperationId": "A String", # [Output only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
"creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
"zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
"operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
"httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
"progress": 42, # [Output only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
"httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
"status": "A String", # [Output Only] Status of the operation.
"insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
"warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
{
"message": "A String", # [Output only] Optional human-readable details for this warning.
"code": "A String", # [Output only] The warning type identifier for this warning.
"data": [ # [Output only] Metadata for this warning in key:value format.
{
"value": "A String", # [Output Only] Metadata value for this warning.
"key": "A String", # [Output Only] Metadata key for this warning.
},
],
},
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
"kind": "replicapool#operation", # [Output only] Type of the resource.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
"code": "A String", # [Output Only] The error type identifier for this error.
"location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
},
],
},
"endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
"targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
}</pre>
</div>
<div class="method">
<code class="details" id="setTargetPools">setTargetPools(project, zone, instanceGroupManager, body)</code>
<pre>Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.
Args:
project: string, The Google Developers Console project name. (required)
zone: string, The name of the zone in which the instance group manager resides. (required)
instanceGroupManager: string, The name of the instance group manager. (required)
body: object, The request body. (required)
The object takes the form of:
{
"targetPools": [ # A list of fully-qualified URLs to existing Target Pool resources. New instances in the Instance Group Manager will be added to the specified target pools; existing instances are not affected.
"A String",
],
"fingerprint": "A String", # The current fingerprint of the Instance Group Manager resource. If this does not match the server-side fingerprint of the resource, then the request will be rejected.
}
Returns:
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
"targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
"clientOperationId": "A String", # [Output only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
"creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
"zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
"operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
"httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
"progress": 42, # [Output only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
"httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
"status": "A String", # [Output Only] Status of the operation.
"insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
"warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
{
"message": "A String", # [Output only] Optional human-readable details for this warning.
"code": "A String", # [Output only] The warning type identifier for this warning.
"data": [ # [Output only] Metadata for this warning in key:value format.
{
"value": "A String", # [Output Only] Metadata value for this warning.
"key": "A String", # [Output Only] Metadata key for this warning.
},
],
},
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
"kind": "replicapool#operation", # [Output only] Type of the resource.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
"code": "A String", # [Output Only] The error type identifier for this error.
"location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
},
],
},
"endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
"targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
}</pre>
</div>
</body></html>