| <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="compute_beta.html">Compute Engine API</a> . <a href="compute_beta.regionInstanceGroupManagers.html">regionInstanceGroupManagers</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#abandonInstances">abandonInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Flags the specified instances to be immediately removed from the managed</p> |
| <p class="toc_element"> |
| <code><a href="#applyUpdatesToInstances">applyUpdatesToInstances(project, region, instanceGroupManager, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Apply updates to selected instances the managed instance group.</p> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#createInstances">createInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates instances with per-instance configurations in this regional managed</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(project, region, instanceGroupManager, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes the specified managed instance group and all of the instances</p> |
| <p class="toc_element"> |
| <code><a href="#deleteInstances">deleteInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Flags the specified instances in the managed instance group to be</p> |
| <p class="toc_element"> |
| <code><a href="#deletePerInstanceConfigs">deletePerInstanceConfigs(project, region, instanceGroupManager, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes selected per-instance configurations for the managed instance</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(project, region, instanceGroupManager, x__xgafv=None)</a></code></p> |
| <p class="firstline">Returns all of the details about the specified managed instance group.</p> |
| <p class="toc_element"> |
| <code><a href="#insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a managed instance group using the information that you specify</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Retrieves the list of managed instance groups that are contained</p> |
| <p class="toc_element"> |
| <code><a href="#listErrors">listErrors(project, region, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists all errors thrown by actions on instances for a given regional</p> |
| <p class="toc_element"> |
| <code><a href="#listErrors_next">listErrors_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#listManagedInstances">listManagedInstances(project, region, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists the instances in the managed instance group and instances that are</p> |
| <p class="toc_element"> |
| <code><a href="#listManagedInstances_next">listManagedInstances_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#listPerInstanceConfigs">listPerInstanceConfigs(project, region, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists all of the per-instance configurations defined for the managed</p> |
| <p class="toc_element"> |
| <code><a href="#listPerInstanceConfigs_next">listPerInstanceConfigs_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates a managed instance group using the information that you specify</p> |
| <p class="toc_element"> |
| <code><a href="#patchPerInstanceConfigs">patchPerInstanceConfigs(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Inserts or patches per-instance configurations for the managed instance</p> |
| <p class="toc_element"> |
| <code><a href="#recreateInstances">recreateInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Flags the specified VM instances in the managed instance group to be</p> |
| <p class="toc_element"> |
| <code><a href="#resize">resize(project, region, instanceGroupManager, size, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Changes the intended size of the managed instance group. If you increase</p> |
| <p class="toc_element"> |
| <code><a href="#resizeAdvanced">resizeAdvanced(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Resizes the regional managed instance group with advanced configuration</p> |
| <p class="toc_element"> |
| <code><a href="#resumeInstances">resumeInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Flags the specified instances in the managed instance group to be</p> |
| <p class="toc_element"> |
| <code><a href="#setAutoHealingPolicies">setAutoHealingPolicies(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Modifies the autohealing policy for the instances in this managed</p> |
| <p class="toc_element"> |
| <code><a href="#setInstanceTemplate">setInstanceTemplate(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Sets the instance template to use when creating new instances or recreating</p> |
| <p class="toc_element"> |
| <code><a href="#setTargetPools">setTargetPools(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Modifies the target pools to which all new instances in this group are</p> |
| <p class="toc_element"> |
| <code><a href="#startInstances">startInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Flags the specified instances in the managed instance group to be</p> |
| <p class="toc_element"> |
| <code><a href="#stopInstances">stopInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Flags the specified instances in the managed instance group to be</p> |
| <p class="toc_element"> |
| <code><a href="#suspendInstances">suspendInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Flags the specified instances in the managed instance group to be</p> |
| <p class="toc_element"> |
| <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Returns permissions that a caller has on the specified resource.</p> |
| <p class="toc_element"> |
| <code><a href="#update">update(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates a managed instance group using the information that you specify</p> |
| <p class="toc_element"> |
| <code><a href="#updatePerInstanceConfigs">updatePerInstanceConfigs(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Inserts or updates per-instance configurations for the managed instance</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="abandonInstances">abandonInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> |
| <pre>Flags the specified instances to be immediately removed 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 thetargetSize of the managed instance group by the |
| number of instances that you abandon. This operation is marked asDONE 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 thelistmanagedinstances |
| method. |
| |
| If the group is part of a backend |
| service that has enabled |
| connection draining, it can take up to 60 seconds after the connection |
| draining duration has elapsed before the VM instance is removed or deleted. |
| |
| You can specify a maximum of 1000 instances with this method per request. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, Name of the region scoping this request. (required) |
| instanceGroupManager: string, Name of the managed instance group. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "instances": [ # The URLs of one or more instances to abandon. This can be a full URL or |
| # a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. |
| "A String", |
| ], |
| } |
| |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so |
| that if you must retry your request, the server will know to ignore the |
| request if it has already been completed. |
| |
| For example, consider a situation where you make an initial request and |
| the request times out. If you make the request again with the same |
| request ID, the server can check if original operation with the same |
| request ID was received, and if so, will ignore the second request. This |
| prevents clients from accidentally creating duplicate commitments. |
| |
| The request ID must be |
| a valid UUID with the exception that zero UUID is not supported |
| (00000000-0000-0000-0000-000000000000). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/beta/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/beta/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # |
| # - For global operations, use the `globalOperations` |
| # resource. |
| # - For regional operations, use the |
| # `regionOperations` resource. |
| # - For zonal operations, use |
| # the `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. |
| # Not present otherwise. |
| "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| "description": "A String", # [Output Only] A textual description of the operation, which is |
| # set when the operation is created. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 |
| # text format. |
| "error": { # [Output Only] If errors are generated during processing of the operation, |
| # this field will be populated. |
| "errors": [ # [Output Only] The array of errors encountered while processing this |
| # operation. |
| { |
| "code": "A String", # [Output Only] The error type identifier for this error. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| }, |
| ], |
| }, |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error |
| # message that was returned, such as `NOT FOUND`. |
| "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. |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is |
| # defined by the server. |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. |
| # This value is inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, |
| # `update`, or `delete`, and so on. |
| "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. |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only |
| # applicable when performing regional operations. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # text format. |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the |
| # following: |
| # `PENDING`, `RUNNING`, or `DONE`. |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the |
| # operation. |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation |
| # of the target resource. |
| "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For |
| # operations related to creating a snapshot, this points to the disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `[email protected]` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the |
| # operation, this field will be populated. |
| { |
| "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. |
| "data": [ # [Output Only] Metadata about this warning in key: |
| # value format. For example: |
| # |
| # "data": [ |
| # { |
| # "key": "scope", |
| # "value": "zones/us-east1-d" |
| # } |
| { |
| "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). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| ], |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only |
| # applicable when performing per-zone operations. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="applyUpdatesToInstances">applyUpdatesToInstances(project, region, instanceGroupManager, body=None, x__xgafv=None)</code> |
| <pre>Apply updates to selected instances the managed instance group. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, Name of the region scoping this request, should conform to RFC1035. (required) |
| instanceGroupManager: string, The name of the managed instance group, should conform to RFC1035. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # RegionInstanceGroupManagers.applyUpdatesToInstances |
| "allInstances": True or False, # Flag to update all instances instead of specified list of “instances”. |
| # If the flag is set to true then the instances may not be specified |
| # in the request. |
| "instances": [ # The list of URLs of one or more instances for which you want to apply |
| # updates. Each URL can be a full URL or a partial URL, such aszones/[ZONE]/instances/[INSTANCE_NAME]. |
| "A String", |
| ], |
| "minimalAction": "A String", # The minimal action that you want to perform on each instance during the |
| # update: |
| # |
| # |
| # - REPLACE: At minimum, delete the instance and create it |
| # again. |
| # - RESTART: Stop the instance and start it |
| # again. |
| # - REFRESH: Do not stop the instance and limit |
| # disruption as much as possible. |
| # - NONE: Do not |
| # disrupt the instance at all. |
| # |
| # |
| # By default, the minimum action is NONE. If your update |
| # requires a more disruptive action than you set with this flag, the |
| # necessary action is performed to execute the update. |
| "mostDisruptiveAllowedAction": "A String", # The most disruptive action that you want to perform on each instance during |
| # the update: |
| # |
| # |
| # - REPLACE: Delete the instance and create it again. |
| # - RESTART: Stop the instance and start it again. |
| # - REFRESH: Do not stop the instance and limit disruption |
| # as much as possible. |
| # - NONE: Do not disrupt the |
| # instance at all. |
| # |
| # |
| # By default, the most disruptive allowed action is REPLACE. If |
| # your update requires a more disruptive action than you set with this flag, |
| # the update request will fail. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/beta/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/beta/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # |
| # - For global operations, use the `globalOperations` |
| # resource. |
| # - For regional operations, use the |
| # `regionOperations` resource. |
| # - For zonal operations, use |
| # the `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. |
| # Not present otherwise. |
| "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| "description": "A String", # [Output Only] A textual description of the operation, which is |
| # set when the operation is created. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 |
| # text format. |
| "error": { # [Output Only] If errors are generated during processing of the operation, |
| # this field will be populated. |
| "errors": [ # [Output Only] The array of errors encountered while processing this |
| # operation. |
| { |
| "code": "A String", # [Output Only] The error type identifier for this error. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| }, |
| ], |
| }, |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error |
| # message that was returned, such as `NOT FOUND`. |
| "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. |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is |
| # defined by the server. |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. |
| # This value is inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, |
| # `update`, or `delete`, and so on. |
| "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. |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only |
| # applicable when performing regional operations. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # text format. |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the |
| # following: |
| # `PENDING`, `RUNNING`, or `DONE`. |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the |
| # operation. |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation |
| # of the target resource. |
| "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For |
| # operations related to creating a snapshot, this points to the disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `[email protected]` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the |
| # operation, this field will be populated. |
| { |
| "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. |
| "data": [ # [Output Only] Metadata about this warning in key: |
| # value format. For example: |
| # |
| # "data": [ |
| # { |
| # "key": "scope", |
| # "value": "zones/us-east1-d" |
| # } |
| { |
| "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). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| ], |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only |
| # applicable when performing per-zone operations. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="createInstances">createInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> |
| <pre>Creates instances with per-instance configurations in this regional managed |
| instance group. Instances are created using the current instance template. |
| The create instances operation is marked DONE if |
| the createInstances request is successful. The underlying |
| actions take additional time. You must separately verify the status of thecreating or actions with the listmanagedinstances |
| method. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, The name of theregion |
| where the managed instance group is located. |
| It should conform to RFC1035. (required) |
| instanceGroupManager: string, The name of the managed instance group. |
| It should conform to RFC1035. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # RegionInstanceGroupManagers.createInstances |
| "instances": [ # [Required] List of specifications of per-instance configs. |
| { |
| "fingerprint": "A String", # Fingerprint of this per-instance config. This field can be used in |
| # optimistic locking. It is ignored when inserting a per-instance |
| # config. An up-to-date fingerprint must be provided in order to update an |
| # existing per-instance configuration or the field needs to be unset. |
| "name": "A String", # The name of a per-instance configuration and its corresponding instance. |
| # Serves as a merge key during UpdatePerInstanceConfigs |
| # operations, that is, if a per-instance configuration with the same name |
| # exists then it will be updated, otherwise a new one will be created for the |
| # VM instance with the same name. An attempt to create a per-instance |
| # configuration for a VM instance that either doesn't exist or is not part |
| # of the group will result in an error. |
| "preservedState": { # Preserved state for a given instance. # The intended preserved state for the given instance. Does not contain |
| # preserved state generated from a stateful policy. |
| "disks": { # Preserved disks defined for this instance. |
| # This map is keyed with the device names of the disks. |
| "a_key": { |
| "autoDelete": "A String", # These stateful disks will never be deleted during autohealing, |
| # update, instance recreate operations. This flag is used to configure |
| # if the disk should be deleted after it is no longer used by the group, |
| # e.g. when the given instance or the whole MIG is deleted. |
| # Note: disks attached in READ_ONLY mode cannot be |
| # auto-deleted. |
| "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the |
| # disk in READ_WRITE mode. |
| "source": "A String", # The URL of the disk resource that is stateful and should be attached |
| # to the VM instance. |
| }, |
| }, |
| "externalIPs": { # Preserved external IPs defined for this instance. |
| # This map is keyed with the name of the network interface. |
| "a_key": { |
| "autoDelete": "A String", # These stateful IPs will never be released during autohealing, |
| # update or VM instance recreate operations. |
| # This flag is used to configure if the IP reservation should be deleted |
| # after it is no longer used by the group, e.g. when the given instance |
| # or the whole group is deleted. |
| "ipAddress": { # Ip address representation |
| "address": "A String", # The URL of the reservation for this IP address. |
| "literal": "A String", # An IPv4 internal network address to assign to the instance for this |
| # network interface. |
| }, |
| }, |
| }, |
| "internalIPs": { # Preserved internal IPs defined for this instance. |
| # This map is keyed with the name of the network interface. |
| "a_key": { |
| "autoDelete": "A String", # These stateful IPs will never be released during autohealing, |
| # update or VM instance recreate operations. |
| # This flag is used to configure if the IP reservation should be deleted |
| # after it is no longer used by the group, e.g. when the given instance |
| # or the whole group is deleted. |
| "ipAddress": { # Ip address representation |
| "address": "A String", # The URL of the reservation for this IP address. |
| "literal": "A String", # An IPv4 internal network address to assign to the instance for this |
| # network interface. |
| }, |
| }, |
| }, |
| "metadata": { # Preserved metadata defined for this instance. |
| "a_key": "A String", |
| }, |
| }, |
| "status": "A String", # The status of applying this per-instance configuration on the corresponding |
| # managed instance. |
| }, |
| ], |
| } |
| |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so |
| that if you must retry your request, the server will know to ignore the |
| request if it has already been completed. |
| |
| For example, consider a situation where you make an initial request and |
| the request times out. If you make the request again with the same |
| request ID, the server can check if original operation with the same |
| request ID was received, and if so, will ignore the second request. |
| |
| The request ID must be |
| a valid UUID with the exception that zero UUID is not supported |
| (00000000-0000-0000-0000-000000000000). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/beta/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/beta/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # |
| # - For global operations, use the `globalOperations` |
| # resource. |
| # - For regional operations, use the |
| # `regionOperations` resource. |
| # - For zonal operations, use |
| # the `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. |
| # Not present otherwise. |
| "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| "description": "A String", # [Output Only] A textual description of the operation, which is |
| # set when the operation is created. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 |
| # text format. |
| "error": { # [Output Only] If errors are generated during processing of the operation, |
| # this field will be populated. |
| "errors": [ # [Output Only] The array of errors encountered while processing this |
| # operation. |
| { |
| "code": "A String", # [Output Only] The error type identifier for this error. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| }, |
| ], |
| }, |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error |
| # message that was returned, such as `NOT FOUND`. |
| "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. |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is |
| # defined by the server. |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. |
| # This value is inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, |
| # `update`, or `delete`, and so on. |
| "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. |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only |
| # applicable when performing regional operations. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # text format. |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the |
| # following: |
| # `PENDING`, `RUNNING`, or `DONE`. |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the |
| # operation. |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation |
| # of the target resource. |
| "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For |
| # operations related to creating a snapshot, this points to the disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `[email protected]` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the |
| # operation, this field will be populated. |
| { |
| "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. |
| "data": [ # [Output Only] Metadata about this warning in key: |
| # value format. For example: |
| # |
| # "data": [ |
| # { |
| # "key": "scope", |
| # "value": "zones/us-east1-d" |
| # } |
| { |
| "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). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| ], |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only |
| # applicable when performing per-zone operations. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(project, region, instanceGroupManager, requestId=None, x__xgafv=None)</code> |
| <pre>Deletes the specified managed instance group and all of the instances |
| in that group. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, Name of the region scoping this request. (required) |
| instanceGroupManager: string, Name of the managed instance group to delete. (required) |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so |
| that if you must retry your request, the server will know to ignore the |
| request if it has already been completed. |
| |
| For example, consider a situation where you make an initial request and |
| the request times out. If you make the request again with the same |
| request ID, the server can check if original operation with the same |
| request ID was received, and if so, will ignore the second request. This |
| prevents clients from accidentally creating duplicate commitments. |
| |
| The request ID must be |
| a valid UUID with the exception that zero UUID is not supported |
| (00000000-0000-0000-0000-000000000000). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/beta/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/beta/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # |
| # - For global operations, use the `globalOperations` |
| # resource. |
| # - For regional operations, use the |
| # `regionOperations` resource. |
| # - For zonal operations, use |
| # the `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. |
| # Not present otherwise. |
| "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| "description": "A String", # [Output Only] A textual description of the operation, which is |
| # set when the operation is created. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 |
| # text format. |
| "error": { # [Output Only] If errors are generated during processing of the operation, |
| # this field will be populated. |
| "errors": [ # [Output Only] The array of errors encountered while processing this |
| # operation. |
| { |
| "code": "A String", # [Output Only] The error type identifier for this error. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| }, |
| ], |
| }, |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error |
| # message that was returned, such as `NOT FOUND`. |
| "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. |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is |
| # defined by the server. |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. |
| # This value is inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, |
| # `update`, or `delete`, and so on. |
| "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. |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only |
| # applicable when performing regional operations. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # text format. |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the |
| # following: |
| # `PENDING`, `RUNNING`, or `DONE`. |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the |
| # operation. |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation |
| # of the target resource. |
| "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For |
| # operations related to creating a snapshot, this points to the disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `[email protected]` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the |
| # operation, this field will be populated. |
| { |
| "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. |
| "data": [ # [Output Only] Metadata about this warning in key: |
| # value format. For example: |
| # |
| # "data": [ |
| # { |
| # "key": "scope", |
| # "value": "zones/us-east1-d" |
| # } |
| { |
| "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). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| ], |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only |
| # applicable when performing per-zone operations. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="deleteInstances">deleteInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> |
| <pre>Flags the specified instances in the managed instance group to be |
| immediately deleted. The instances are also removed from any target |
| pools of which they were a member. This method reduces thetargetSize of the managed instance group by the number of |
| instances that you delete. |
| The deleteInstances operation is marked DONE if |
| the deleteInstances request is successful. The underlying |
| actions take additional time. You must separately verify the status of thedeleting action with thelistmanagedinstances |
| method. |
| |
| If the group is part of a backend |
| service that has enabled |
| connection draining, it can take up to 60 seconds after the connection |
| draining duration has elapsed before the VM instance is removed or deleted. |
| |
| You can specify a maximum of 1000 instances with this method per request. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, Name of the region scoping this request. (required) |
| instanceGroupManager: string, Name of the managed instance group. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "instances": [ # The URLs of one or more instances to delete. This can be a full URL or |
| # a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. |
| "A String", |
| ], |
| "skipInstancesOnValidationError": True or False, # Specifies whether the request should proceed despite the inclusion of |
| # instances that are not members of the group or that are already in the |
| # process of being deleted or abandoned. If this field is set to `false` and |
| # such an instance is specified in the request, the operation fails. The |
| # operation always fails if the request contains a malformed instance URL or |
| # a reference to an instance that exists in a zone or region other than the |
| # group's zone or region. |
| } |
| |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so |
| that if you must retry your request, the server will know to ignore the |
| request if it has already been completed. |
| |
| For example, consider a situation where you make an initial request and |
| the request times out. If you make the request again with the same |
| request ID, the server can check if original operation with the same |
| request ID was received, and if so, will ignore the second request. This |
| prevents clients from accidentally creating duplicate commitments. |
| |
| The request ID must be |
| a valid UUID with the exception that zero UUID is not supported |
| (00000000-0000-0000-0000-000000000000). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/beta/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/beta/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # |
| # - For global operations, use the `globalOperations` |
| # resource. |
| # - For regional operations, use the |
| # `regionOperations` resource. |
| # - For zonal operations, use |
| # the `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. |
| # Not present otherwise. |
| "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| "description": "A String", # [Output Only] A textual description of the operation, which is |
| # set when the operation is created. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 |
| # text format. |
| "error": { # [Output Only] If errors are generated during processing of the operation, |
| # this field will be populated. |
| "errors": [ # [Output Only] The array of errors encountered while processing this |
| # operation. |
| { |
| "code": "A String", # [Output Only] The error type identifier for this error. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| }, |
| ], |
| }, |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error |
| # message that was returned, such as `NOT FOUND`. |
| "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. |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is |
| # defined by the server. |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. |
| # This value is inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, |
| # `update`, or `delete`, and so on. |
| "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. |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only |
| # applicable when performing regional operations. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # text format. |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the |
| # following: |
| # `PENDING`, `RUNNING`, or `DONE`. |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the |
| # operation. |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation |
| # of the target resource. |
| "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For |
| # operations related to creating a snapshot, this points to the disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `[email protected]` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the |
| # operation, this field will be populated. |
| { |
| "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. |
| "data": [ # [Output Only] Metadata about this warning in key: |
| # value format. For example: |
| # |
| # "data": [ |
| # { |
| # "key": "scope", |
| # "value": "zones/us-east1-d" |
| # } |
| { |
| "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). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| ], |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only |
| # applicable when performing per-zone operations. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="deletePerInstanceConfigs">deletePerInstanceConfigs(project, region, instanceGroupManager, body=None, x__xgafv=None)</code> |
| <pre>Deletes selected per-instance configurations for the managed instance |
| group. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, Name of the region scoping this request, should conform to RFC1035. (required) |
| instanceGroupManager: string, The name of the managed instance group. It should conform to RFC1035. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # RegionInstanceGroupManagers.deletePerInstanceConfigs |
| "names": [ # The list of instance names for which we want to delete per-instance configs |
| # on this managed instance group. |
| "A String", |
| ], |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/beta/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/beta/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # |
| # - For global operations, use the `globalOperations` |
| # resource. |
| # - For regional operations, use the |
| # `regionOperations` resource. |
| # - For zonal operations, use |
| # the `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. |
| # Not present otherwise. |
| "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| "description": "A String", # [Output Only] A textual description of the operation, which is |
| # set when the operation is created. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 |
| # text format. |
| "error": { # [Output Only] If errors are generated during processing of the operation, |
| # this field will be populated. |
| "errors": [ # [Output Only] The array of errors encountered while processing this |
| # operation. |
| { |
| "code": "A String", # [Output Only] The error type identifier for this error. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| }, |
| ], |
| }, |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error |
| # message that was returned, such as `NOT FOUND`. |
| "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. |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is |
| # defined by the server. |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. |
| # This value is inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, |
| # `update`, or `delete`, and so on. |
| "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. |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only |
| # applicable when performing regional operations. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # text format. |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the |
| # following: |
| # `PENDING`, `RUNNING`, or `DONE`. |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the |
| # operation. |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation |
| # of the target resource. |
| "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For |
| # operations related to creating a snapshot, this points to the disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `[email protected]` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the |
| # operation, this field will be populated. |
| { |
| "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. |
| "data": [ # [Output Only] Metadata about this warning in key: |
| # value format. For example: |
| # |
| # "data": [ |
| # { |
| # "key": "scope", |
| # "value": "zones/us-east1-d" |
| # } |
| { |
| "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). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| ], |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only |
| # applicable when performing per-zone operations. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(project, region, instanceGroupManager, x__xgafv=None)</code> |
| <pre>Returns all of the details about the specified managed instance group. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, Name of the region scoping this request. (required) |
| instanceGroupManager: string, Name of the managed instance group to return. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents a Managed Instance Group resource. |
| # |
| # An instance group is a collection of VM instances that you can manage as a |
| # single entity. For more information, readInstance groups. |
| # |
| # For zonal Managed Instance Group, use the instanceGroupManagers |
| # resource. |
| # |
| # For regional Managed Instance Group, use theregionInstanceGroupManagers resource. |
| "allInstancesConfig": { # Specifies configuration that overrides the instance template configuration |
| # for the group. |
| "properties": { # Represents the change that you want to make to the instance properties. # Properties to set on all instances in the group. |
| # |
| # You can add or modify properties using theinstanceGroupManagers.patch orregionInstanceGroupManagers.patch. After settingallInstancesConfig on the group, you must update the group's |
| # instances to apply the configuration. To apply the configuration, set the |
| # group's updatePolicy.type field to use proactive updates or |
| # use the applyUpdatesToInstances method. |
| "labels": { # The label key-value pairs that you want to patch onto the instance. |
| "a_key": "A String", |
| }, |
| "metadata": { # The metadata key-value pairs that you want to patch onto the instance. For |
| # more information, see Project and |
| # instance metadata. |
| "a_key": "A String", |
| }, |
| }, |
| }, |
| "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify |
| # only one value. |
| { |
| "healthCheck": "A String", # The URL for the health check that signals autohealing. |
| "initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to |
| # initialize and run its startup script. During a VM's initial delay |
| # period, the MIG ignores unsuccessful health checks because the VM might |
| # be in the startup process. This prevents the MIG from prematurely |
| # recreating a VM. If the health check receives a healthy response during |
| # the initial delay, it indicates that the startup process is complete and |
| # the VM is ready. The value of initial delay must be between 0 and 3600 |
| # seconds. The default value is 0. |
| }, |
| ], |
| "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of |
| # all VMs in a MIG. The maximum character length is 58 and the name must |
| # comply with RFC1035 format. |
| # |
| # When a VM is created in the group, the MIG appends a hyphen and a random |
| # four-character string to the base instance name. If you want the MIG to |
| # assign sequential numbers instead of a random string, then end the base |
| # instance name with a hyphen followed by one or more hash symbols. The hash |
| # symbols indicate the number of digits. For example, a base instance name of |
| # "vm-###" results in "vm-001" as a VM name. |
| # @pattern |
| # [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\\[[0-9]{1,10}\\])?)) |
| "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group inRFC3339 |
| # text format. |
| "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. |
| "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. |
| "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. |
| # |
| # If you have disabled creation retries, this field will not be populated; |
| # instead, the creatingWithoutRetries field will be populated. |
| "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. |
| "deleting": 42, # [Output Only] The number of instances in the managed instance group that |
| # are scheduled to be deleted or are currently being deleted. |
| "none": 42, # [Output Only] The number of instances in the managed instance group that |
| # are running and have no scheduled actions. |
| "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. |
| "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. |
| "restarting": 42, # [Output Only] The number of instances in the managed instance group that |
| # are scheduled to be restarted or are currently being restarted. |
| "resuming": 42, # [Output Only] The number of instances in the managed instance group that |
| # are scheduled to be resumed or are currently being resumed. |
| "starting": 42, # [Output Only] The number of instances in the managed instance group that |
| # are scheduled to be started or are currently being started. |
| "stopping": 42, # [Output Only] The number of instances in the managed instance group that |
| # are scheduled to be stopped or are currently being stopped. |
| "suspending": 42, # [Output Only] The number of instances in the managed instance group that |
| # are scheduled to be suspended or are currently being suspended. |
| "verifying": 42, # [Output Only] The number of instances in the managed instance group that |
| # are being verified. See the managedInstances[].currentAction |
| # property in the listManagedInstances method documentation. |
| }, |
| "description": "A String", # An optional description of this resource. |
| "distributionPolicy": { # Policy specifying the intended distribution of managed instances across |
| # zones in a regional managed instance group. |
| "targetShape": "A String", # The distribution shape to which the group converges either proactively or |
| # on resize events (depending on the value set inupdatePolicy.instanceRedistributionType). |
| "zones": [ # Zones where the regional managed instance group will create and manage |
| # its instances. |
| { |
| "zone": "A String", # The URL of thezone. |
| # The zone must exist in the region where the managed instance group is |
| # located. |
| }, |
| ], |
| }, |
| "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported,NO_FAILOVER. The default is NO_FAILOVER. |
| "fingerprint": "A String", # Fingerprint of this resource. This field may be used in optimistic locking. |
| # It will be ignored when inserting an InstanceGroupManager. An up-to-date |
| # fingerprint must be provided in order to update the InstanceGroupManager, |
| # otherwise the request will fail with error412 conditionNotMet. |
| # |
| # To see the latest fingerprint, make a get() request to |
| # retrieve an InstanceGroupManager. |
| "id": "A String", # [Output Only] A unique identifier for this resource type. The server |
| # generates this identifier. |
| "instanceFlexibilityPolicy": { # Instance flexibility allowing MIG to create VMs from multiple |
| # types of machines. |
| # Instance flexibility configuration on MIG overrides instance |
| # template configuration. |
| "instanceSelections": { # Named instance selections configuring properties that the group will use |
| # when creating new VMs. |
| "a_key": { |
| "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16". |
| "A String", |
| ], |
| "rank": 42, # Preference of this instance selection. Lower number means higher |
| # preference. MIG will first try to create a VM based on the machine-type |
| # with lowest rank and fallback to next rank based on availability. |
| # Machine types and instance selections with the same rank have the same |
| # preference. |
| }, |
| }, |
| "provisioningModelMix": { # Provisioning model configuration used by this managed instance group to |
| # create instances. |
| "standardCapacityBase": 42, # The base capacity that will always use Standard VMs to avoid risk of |
| # more preemption than the minimum capacity user needs. MIG will create |
| # only Standard VMs until it reaches standard_capacity_base and only |
| # then will start using standard_capacity_percent_above_base to mix Spot |
| # with Standard VMs. |
| "standardCapacityPercentAboveBase": 42, # The percentage of target capacity that should use Standard VM. The |
| # remaining percentage will use Spot VMs. The percentage applies only to |
| # the capacity above standard_capacity_base. |
| }, |
| }, |
| "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource. |
| "instanceLifecyclePolicy": { # The repair policy for this managed instance group. |
| "defaultActionOnFailure": "A String", # The action that a MIG performs on a failed VM. If the value of the onFailedHealthCheck field |
| # is `DEFAULT_ACTION`, then the same action also applies to the VMs on which your application |
| # fails a health check. Valid values are - REPAIR (default): MIG automatically repairs a failed |
| # VM by recreating it. For more information, seeAbout repairing |
| # VMs in a MIG. - DO_NOTHING: MIG does not repair a failed VM. |
| "forceUpdateOnRepair": "A String", # A bit indicating whether to forcefully apply the group's latest |
| # configuration when repairing a VM. Valid options are: |
| # |
| # |
| # |
| # - NO (default): If configuration updates are available, they are not |
| # forcefully applied during repair. Instead, configuration updates are |
| # applied according to the group's update policy. |
| # |
| # - YES: If configuration updates are available, they are applied |
| # during repair. |
| "onFailedHealthCheck": "A String", # The action that a MIG performs on an unhealthy VM. A VM is marked as |
| # unhealthy when the application running on that VM fails a health check. |
| # Valid values are: |
| # |
| # - DEFAULT_ACTION (default): MIG uses the same action |
| # configured for instanceLifecyclePolicy.defaultActionOnFailure field. |
| # - REPAIR: MIG automatically repairs an unhealthy VM by |
| # recreating it. |
| # - DO_NOTHING: MIG doesn't repair an unhealthy VM. |
| # For more information, see |
| # About repairing VMs in a MIG. |
| "onRepair": { # Configuration for VM repairs in the MIG. # Configuration for VM repairs in the MIG. |
| "allowChangingZone": "A String", # Specifies whether the MIG can change a VM's zone during a repair. |
| # Valid values are: |
| # |
| # - NO (default): MIG cannot change a VM's zone during a |
| # repair. |
| # - YES: MIG can select a different zone for the VM during |
| # a repair. |
| }, |
| }, |
| "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. The templates for existing instances in the |
| # group do not change unless you run recreateInstances, runapplyUpdatesToInstances, or set the group'supdatePolicy.type to PROACTIVE. |
| "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is alwayscompute#instanceGroupManager for managed instance groups. |
| "listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for |
| # this managed instance group. |
| "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to. |
| "name": "A String", # The name of the managed instance group. The name must be 1-63 characters |
| # long, and comply withRFC1035. |
| "namedPorts": [ # [Output Only] Named ports configured on the Instance Groups complementary |
| # to this Instance Group Manager. |
| { # The named port. For example: <"http", 80>. |
| "name": "A String", # The name for this named port. |
| # The name must be 1-63 characters long, and comply withRFC1035. |
| "port": 42, # The port number, which can be a value between 1 and 65535. |
| }, |
| ], |
| "params": { # Input only additional params for instance group manager creation. # Input only. Additional params passed with the request, but not persisted |
| # as part of resource payload. |
| "resourceManagerTags": { # Resource manager tags to bind to the managed instance group. The tags are |
| # key-value pairs. Keys must be in the format tagKeys/123 and values in the |
| # format tagValues/456. For more information, seeManage tags |
| # for resources. |
| "a_key": "A String", |
| }, |
| }, |
| "region": "A String", # [Output Only] The URL of theregion |
| # where the managed instance group resides (for regional resources). |
| "resourcePolicies": { # Resource policies for this managed instance group. |
| "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed |
| # instance group. |
| # It can be a full or partial URL. For example, the following are |
| # all valid URLs to a workload policy: |
| # |
| # |
| # - https://www.googleapis.com/compute/v1/projects/project/regions/region/resourcePolicies/resourcePolicy |
| # - projects/project/regions/region/resourcePolicies/resourcePolicy |
| # - regions/region/resourcePolicies/resourcePolicy |
| }, |
| "satisfiesPzi": True or False, # [Output Only] Reserved for future use. |
| "satisfiesPzs": True or False, # [Output Only] Reserved for future use. |
| "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines |
| # this URL. |
| "serviceAccount": "A String", # The service account to be used as credentials for all operations performed |
| # by the managed instance group on instances. The service accounts needs all |
| # permissions required to create and delete instances. |
| # By default, the service account |
| # {projectNumber}@cloudservices.gserviceaccount.com is used. |
| "standbyPolicy": { # Standby policy for stopped and suspended instances. |
| "initialDelaySec": 42, # Specifies the number of seconds that the MIG should wait to suspend or |
| # stop a VM after that VM was created. The initial delay gives the |
| # initialization script the time to prepare your VM for a quick scale out. |
| # The value of initial delay must be between 0 and 3600 seconds. The |
| # default value is 0. |
| "mode": "A String", # Defines how a MIG resumes or starts VMs from a standby pool when the |
| # group scales out. The default mode is `MANUAL`. |
| }, |
| "statefulPolicy": { # Stateful configuration for this Instanced Group Manager |
| "preservedState": { # Configuration of preserved resources. |
| "disks": { # Disks created on the instances that will be preserved on instance |
| # delete, update, etc. This map is keyed with the device names of |
| # the disks. |
| "a_key": { |
| "autoDelete": "A String", # These stateful disks will never be deleted during autohealing, |
| # update or VM instance recreate operations. |
| # This flag is used to configure if the disk should be deleted after it |
| # is no longer used by the group, e.g. when the given instance or |
| # the whole group is deleted. Note: disks attached inREAD_ONLY mode cannot be auto-deleted. |
| }, |
| }, |
| "externalIPs": { # External network IPs assigned to the instances that will be preserved on |
| # instance delete, update, etc. This map is keyed with the network |
| # interface name. |
| "a_key": { |
| "autoDelete": "A String", # These stateful IPs will never be released during autohealing, |
| # update or VM instance recreate operations. |
| # This flag is used to configure if the IP reservation should be deleted |
| # after it is no longer used by the group, e.g. when the given instance |
| # or the whole group is deleted. |
| }, |
| }, |
| "internalIPs": { # Internal network IPs assigned to the instances that will be preserved on |
| # instance delete, update, etc. This map is keyed with the network |
| # interface name. |
| "a_key": { |
| "autoDelete": "A String", # These stateful IPs will never be released during autohealing, |
| # update or VM instance recreate operations. |
| # This flag is used to configure if the IP reservation should be deleted |
| # after it is no longer used by the group, e.g. when the given instance |
| # or the whole group is deleted. |
| }, |
| }, |
| }, |
| }, |
| "status": { # [Output Only] The status of this managed instance group. |
| "allInstancesConfig": { # [Output only] Status of all-instances configuration on the group. |
| "currentRevision": "A String", # [Output Only] Current all-instances configuration revision. |
| # This value is in RFC3339 text format. |
| "effective": True or False, # [Output Only] A bit indicating whether this configuration has |
| # been applied to all managed instances in the group. |
| }, |
| "autoscaler": "A String", # [Output Only] The URL of theAutoscaler |
| # that targets this instance group manager. |
| "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # [Output Only] The status of bulk instance operation. |
| # targetSizePolicy.mode is set to BULK. |
| "inProgress": True or False, # [Output Only] Informs whether bulk instance operation is in progress. |
| "lastProgressCheck": { # [Output Only] Information from the last progress check of bulk instance |
| # operation. |
| "error": { # [Output Only] Errors encountered during bulk instance operation. |
| "errors": [ # [Output Only] The array of errors encountered while processing this |
| # operation. |
| { |
| "code": "A String", # [Output Only] The error type identifier for this error. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| }, |
| ], |
| }, |
| "timestamp": "A String", # [Output Only] Timestamp of the last progress check of bulk instance |
| # operation. Timestamp is in RFC3339 text format. |
| }, |
| }, |
| "isStable": True or False, # [Output Only] A bit indicating whether the managed instance group is in a |
| # stable state. A stable state means that: none of the instances in the |
| # managed instance group is currently undergoing any type of change (for |
| # example, creation, restart, or deletion); no future changes are scheduled |
| # for instances in the managed instance group; and the managed instance |
| # group itself is not being modified. |
| "stateful": { # [Output Only] Stateful status of the given Instance Group Manager. |
| "hasStatefulConfig": True or False, # [Output Only] A bit indicating whether the managed instance group |
| # has stateful configuration, that is, if you have configured any items |
| # in a stateful policy or in per-instance configs. |
| # The group might report that it has no stateful configuration even when |
| # there is still some preserved state on a managed instance, for example, |
| # if you have deleted all PICs but not yet applied those deletions. |
| "isStateful": True or False, # [Output Only] A bit indicating whether the managed instance group |
| # has stateful configuration, that is, if you have configured any items |
| # in a stateful policy or in per-instance configs. |
| # The group might report that it has no stateful configuration even when |
| # there is still some preserved state on a managed instance, for example, |
| # if you have deleted all PICs but not yet applied those deletions. This |
| # field is deprecated in favor of has_stateful_config. |
| "perInstanceConfigs": { # [Output Only] Status of per-instance configurations on the instances. |
| "allEffective": True or False, # A bit indicating if all of the group's per-instance configurations |
| # (listed in the output of a listPerInstanceConfigs API call) have |
| # status EFFECTIVE or there are no per-instance-configs. |
| }, |
| }, |
| "versionTarget": { # [Output Only] A status of consistency of Instances' versions with their |
| # target version specified by version field on Instance Group |
| # Manager. |
| "isReached": True or False, # [Output Only] A bit indicating whether version target has been reached |
| # in this managed instance group, i.e. all instances are in their target |
| # version. Instances' target version are specified byversion field on Instance Group Manager. |
| }, |
| }, |
| "targetPools": [ # The URLs for all TargetPool resources to which instances in theinstanceGroup field are added. The target pools automatically |
| # apply to all of the instances in the managed instance group. |
| "A String", |
| ], |
| "targetSize": 42, # The target number of running instances for this managed instance group. |
| # You can reduce this number by using the instanceGroupManager |
| # deleteInstances or abandonInstances methods. Resizing the group also |
| # changes this number. |
| "targetSizePolicy": { # The policy that specifies how the MIG creates its VMs to achieve the target |
| # size. |
| "mode": "A String", # The mode of target size policy based on which the MIG creates its VMs |
| # individually or all at once. |
| }, |
| "targetStoppedSize": 42, # The target number of stopped instances for this managed instance group. |
| # This number changes when you: |
| # |
| # - Stop instance using the stopInstances |
| # method or start instances using the startInstances |
| # method. |
| # - Manually change the targetStoppedSize using the update |
| # method. |
| "targetSuspendedSize": 42, # The target number of suspended instances for this managed instance group. |
| # This number changes when you: |
| # |
| # - Suspend instance using the suspendInstances |
| # method or resume instances using the resumeInstances |
| # method. |
| # - Manually change the targetSuspendedSize using the update |
| # method. |
| "updatePolicy": { # The update policy for this managed instance group. |
| "instanceRedistributionType": "A String", # The |
| # instance redistribution policy for regional managed instance groups. |
| # Valid values are: |
| # |
| # - PROACTIVE (default): The group attempts to maintain an |
| # even distribution of VM instances across zones in the region. |
| # - NONE: For non-autoscaled groups, proactive |
| # redistribution is disabled. |
| "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be created above the specifiedtargetSize during the update process. This value can be |
| # either a fixed number or, if the group has 10 or more instances, a |
| # percentage. If you set a percentage, the number of instances is rounded |
| # if necessary. The default value for maxSurge is a fixed |
| # value equal to the number of zones in which the managed instance group |
| # operates. |
| # |
| # At least one of either maxSurge ormaxUnavailable must be greater than 0. Learn more about maxSurge. |
| "calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the |
| # specific mode. |
| # |
| # |
| # |
| # - If the value is fixed, then the calculated |
| # value is equal to the fixed value. |
| # - If the value is a percent, then the |
| # calculated |
| # value is percent/100 * targetSize. For example, |
| # the calculated value of a 80% of a managed instance group |
| # with 150 instances would be (80/100 * 150) = 120 VM instances. If there |
| # is a remainder, the number is rounded. |
| "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. |
| "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For |
| # example, specify 80 for 80%. |
| }, |
| "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be unavailable during the update |
| # process. An instance is considered available if all of the following |
| # conditions are satisfied: |
| # |
| # |
| # |
| # - The instance's status is |
| # RUNNING. |
| # - If there is a health |
| # check on the instance group, the instance's health check status |
| # must be HEALTHY at least once. If there is no health check |
| # on the group, then the instance only needs to have a status of |
| # RUNNING to be considered available. |
| # |
| # |
| # This value can be either a fixed number or, if the group has 10 or more |
| # instances, a percentage. If you set a percentage, the number of instances |
| # is rounded if necessary. The default value formaxUnavailable is a fixed value equal to the number of zones |
| # in which the managed instance group operates. |
| # |
| # At least one of either maxSurge ormaxUnavailable must be greater than 0. Learn more about maxUnavailable. |
| "calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the |
| # specific mode. |
| # |
| # |
| # |
| # - If the value is fixed, then the calculated |
| # value is equal to the fixed value. |
| # - If the value is a percent, then the |
| # calculated |
| # value is percent/100 * targetSize. For example, |
| # the calculated value of a 80% of a managed instance group |
| # with 150 instances would be (80/100 * 150) = 120 VM instances. If there |
| # is a remainder, the number is rounded. |
| "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. |
| "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For |
| # example, specify 80 for 80%. |
| }, |
| "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance |
| # becomes available. This value must be from range [0, 3600]. |
| "minimalAction": "A String", # Minimal action to be taken on an instance. Use this option to minimize |
| # disruption as much as possible or to apply a more disruptive action than |
| # is necessary. |
| # |
| # - To limit disruption as much as possible, set the minimal action toREFRESH. If your update requires a more disruptive action, |
| # Compute Engine performs the necessary action to execute the update. |
| # - To apply a more disruptive action than is strictly necessary, set the |
| # minimal action to RESTART or REPLACE. For |
| # example, Compute Engine does not need to restart a VM to change its |
| # metadata. But if your application reads instance metadata only when a VM |
| # is restarted, you can set the minimal action to RESTART in |
| # order to pick up metadata changes. |
| "mostDisruptiveAllowedAction": "A String", # Most disruptive action that is allowed to be taken on an instance. |
| # You can specify either NONE to forbid any actions,REFRESH to avoid restarting the VM and to limit disruption |
| # as much as possible. RESTART to allow actions that can be |
| # applied without instance replacing or REPLACE to allow all |
| # possible actions. If the Updater determines that the minimal update |
| # action needed is more disruptive than most disruptive allowed action you |
| # specify it will not perform the update at all. |
| "replacementMethod": "A String", # What action should be used to replace instances. |
| # See minimal_action.REPLACE |
| "type": "A String", # The type |
| # of update process. You can specify either PROACTIVE so |
| # that the MIG automatically updates VMs to the latest configurations orOPPORTUNISTIC so that you can select the VMs that you want |
| # to update. |
| }, |
| "versions": [ # Specifies the instance templates used by this managed instance group to |
| # create instances. |
| # |
| # Each version is defined by an instanceTemplate and aname. Every version can appear at most once per instance |
| # group. This field overrides the top-level instanceTemplate |
| # field. Read more about therelationships |
| # between these fields. Exactly one version must leave thetargetSize field unset. That version will be applied to all |
| # remaining instances. For more information, read aboutcanary |
| # updates. |
| { |
| "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed |
| # instance group. The group uses this template to create new instances in |
| # the managed instance group until the `targetSize` for this version is |
| # reached. The templates for existing instances in the group do not change |
| # unless you run recreateInstances, runapplyUpdatesToInstances, or set the group'supdatePolicy.type to PROACTIVE; in those cases, |
| # existing instances are updated until the `targetSize` for this version is |
| # reached. |
| "name": "A String", # Name of the version. Unique among all versions in the scope of this |
| # managed instance group. |
| "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Specifies the intended number of instances to be created from theinstanceTemplate. The final number of instances created |
| # from the template will be equal to: |
| # |
| # |
| # - If expressed as a fixed number, the minimum of either |
| # targetSize.fixed or |
| # instanceGroupManager.targetSize is used. |
| # - if expressed as a percent, the targetSize |
| # would be (targetSize.percent/100 * |
| # InstanceGroupManager.targetSize) If there is a remainder, the |
| # number is rounded. |
| # |
| # If unset, this version will update any remaining instances not |
| # updated by another version. ReadStarting |
| # a canary update for more information. |
| "calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the |
| # specific mode. |
| # |
| # |
| # |
| # - If the value is fixed, then the calculated |
| # value is equal to the fixed value. |
| # - If the value is a percent, then the |
| # calculated |
| # value is percent/100 * targetSize. For example, |
| # the calculated value of a 80% of a managed instance group |
| # with 150 instances would be (80/100 * 150) = 120 VM instances. If there |
| # is a remainder, the number is rounded. |
| "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. |
| "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For |
| # example, specify 80 for 80%. |
| }, |
| }, |
| ], |
| "zone": "A String", # [Output Only] The URL of azone |
| # where the managed instance group is located (for zonal resources). |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</code> |
| <pre>Creates a managed instance group using the information that you specify |
| in the request. After the group is created, instances in the group are |
| created 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 thelistmanagedinstances |
| method. |
| |
| A regional managed instance group can contain up to 2000 instances. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, Name of the region scoping this request. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Represents a Managed Instance Group resource. |
| # |
| # An instance group is a collection of VM instances that you can manage as a |
| # single entity. For more information, readInstance groups. |
| # |
| # For zonal Managed Instance Group, use the instanceGroupManagers |
| # resource. |
| # |
| # For regional Managed Instance Group, use theregionInstanceGroupManagers resource. |
| "allInstancesConfig": { # Specifies configuration that overrides the instance template configuration |
| # for the group. |
| "properties": { # Represents the change that you want to make to the instance properties. # Properties to set on all instances in the group. |
| # |
| # You can add or modify properties using theinstanceGroupManagers.patch orregionInstanceGroupManagers.patch. After settingallInstancesConfig on the group, you must update the group's |
| # instances to apply the configuration. To apply the configuration, set the |
| # group's updatePolicy.type field to use proactive updates or |
| # use the applyUpdatesToInstances method. |
| "labels": { # The label key-value pairs that you want to patch onto the instance. |
| "a_key": "A String", |
| }, |
| "metadata": { # The metadata key-value pairs that you want to patch onto the instance. For |
| # more information, see Project and |
| # instance metadata. |
| "a_key": "A String", |
| }, |
| }, |
| }, |
| "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify |
| # only one value. |
| { |
| "healthCheck": "A String", # The URL for the health check that signals autohealing. |
| "initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to |
| # initialize and run its startup script. During a VM's initial delay |
| # period, the MIG ignores unsuccessful health checks because the VM might |
| # be in the startup process. This prevents the MIG from prematurely |
| # recreating a VM. If the health check receives a healthy response during |
| # the initial delay, it indicates that the startup process is complete and |
| # the VM is ready. The value of initial delay must be between 0 and 3600 |
| # seconds. The default value is 0. |
| }, |
| ], |
| "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of |
| # all VMs in a MIG. The maximum character length is 58 and the name must |
| # comply with RFC1035 format. |
| # |
| # When a VM is created in the group, the MIG appends a hyphen and a random |
| # four-character string to the base instance name. If you want the MIG to |
| # assign sequential numbers instead of a random string, then end the base |
| # instance name with a hyphen followed by one or more hash symbols. The hash |
| # symbols indicate the number of digits. For example, a base instance name of |
| # "vm-###" results in "vm-001" as a VM name. |
| # @pattern |
| # [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\\[[0-9]{1,10}\\])?)) |
| "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group inRFC3339 |
| # text format. |
| "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. |
| "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. |
| "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. |
| # |
| # If you have disabled creation retries, this field will not be populated; |
| # instead, the creatingWithoutRetries field will be populated. |
| "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. |
| "deleting": 42, # [Output Only] The number of instances in the managed instance group that |
| # are scheduled to be deleted or are currently being deleted. |
| "none": 42, # [Output Only] The number of instances in the managed instance group that |
| # are running and have no scheduled actions. |
| "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. |
| "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. |
| "restarting": 42, # [Output Only] The number of instances in the managed instance group that |
| # are scheduled to be restarted or are currently being restarted. |
| "resuming": 42, # [Output Only] The number of instances in the managed instance group that |
| # are scheduled to be resumed or are currently being resumed. |
| "starting": 42, # [Output Only] The number of instances in the managed instance group that |
| # are scheduled to be started or are currently being started. |
| "stopping": 42, # [Output Only] The number of instances in the managed instance group that |
| # are scheduled to be stopped or are currently being stopped. |
| "suspending": 42, # [Output Only] The number of instances in the managed instance group that |
| # are scheduled to be suspended or are currently being suspended. |
| "verifying": 42, # [Output Only] The number of instances in the managed instance group that |
| # are being verified. See the managedInstances[].currentAction |
| # property in the listManagedInstances method documentation. |
| }, |
| "description": "A String", # An optional description of this resource. |
| "distributionPolicy": { # Policy specifying the intended distribution of managed instances across |
| # zones in a regional managed instance group. |
| "targetShape": "A String", # The distribution shape to which the group converges either proactively or |
| # on resize events (depending on the value set inupdatePolicy.instanceRedistributionType). |
| "zones": [ # Zones where the regional managed instance group will create and manage |
| # its instances. |
| { |
| "zone": "A String", # The URL of thezone. |
| # The zone must exist in the region where the managed instance group is |
| # located. |
| }, |
| ], |
| }, |
| "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported,NO_FAILOVER. The default is NO_FAILOVER. |
| "fingerprint": "A String", # Fingerprint of this resource. This field may be used in optimistic locking. |
| # It will be ignored when inserting an InstanceGroupManager. An up-to-date |
| # fingerprint must be provided in order to update the InstanceGroupManager, |
| # otherwise the request will fail with error412 conditionNotMet. |
| # |
| # To see the latest fingerprint, make a get() request to |
| # retrieve an InstanceGroupManager. |
| "id": "A String", # [Output Only] A unique identifier for this resource type. The server |
| # generates this identifier. |
| "instanceFlexibilityPolicy": { # Instance flexibility allowing MIG to create VMs from multiple |
| # types of machines. |
| # Instance flexibility configuration on MIG overrides instance |
| # template configuration. |
| "instanceSelections": { # Named instance selections configuring properties that the group will use |
| # when creating new VMs. |
| "a_key": { |
| "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16". |
| "A String", |
| ], |
| "rank": 42, # Preference of this instance selection. Lower number means higher |
| # preference. MIG will first try to create a VM based on the machine-type |
| # with lowest rank and fallback to next rank based on availability. |
| # Machine types and instance selections with the same rank have the same |
| # preference. |
| }, |
| }, |
| "provisioningModelMix": { # Provisioning model configuration used by this managed instance group to |
| # create instances. |
| "standardCapacityBase": 42, # The base capacity that will always use Standard VMs to avoid risk of |
| # more preemption than the minimum capacity user needs. MIG will create |
| # only Standard VMs until it reaches standard_capacity_base and only |
| # then will start using standard_capacity_percent_above_base to mix Spot |
| # with Standard VMs. |
| "standardCapacityPercentAboveBase": 42, # The percentage of target capacity that should use Standard VM. The |
| # remaining percentage will use Spot VMs. The percentage applies only to |
| # the capacity above standard_capacity_base. |
| }, |
| }, |
| "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource. |
| "instanceLifecyclePolicy": { # The repair policy for this managed instance group. |
| "defaultActionOnFailure": "A String", # The action that a MIG performs on a failed VM. If the value of the onFailedHealthCheck field |
| # is `DEFAULT_ACTION`, then the same action also applies to the VMs on which your application |
| # fails a health check. Valid values are - REPAIR (default): MIG automatically repairs a failed |
| # VM by recreating it. For more information, seeAbout repairing |
| # VMs in a MIG. - DO_NOTHING: MIG does not repair a failed VM. |
| "forceUpdateOnRepair": "A String", # A bit indicating whether to forcefully apply the group's latest |
| # configuration when repairing a VM. Valid options are: |
| # |
| # |
| # |
| # - NO (default): If configuration updates are available, they are not |
| # forcefully applied during repair. Instead, configuration updates are |
| # applied according to the group's update policy. |
| # |
| # - YES: If configuration updates are available, they are applied |
| # during repair. |
| "onFailedHealthCheck": "A String", # The action that a MIG performs on an unhealthy VM. A VM is marked as |
| # unhealthy when the application running on that VM fails a health check. |
| # Valid values are: |
| # |
| # - DEFAULT_ACTION (default): MIG uses the same action |
| # configured for instanceLifecyclePolicy.defaultActionOnFailure field. |
| # - REPAIR: MIG automatically repairs an unhealthy VM by |
| # recreating it. |
| # - DO_NOTHING: MIG doesn't repair an unhealthy VM. |
| # For more information, see |
| # About repairing VMs in a MIG. |
| "onRepair": { # Configuration for VM repairs in the MIG. # Configuration for VM repairs in the MIG. |
| "allowChangingZone": "A String", # Specifies whether the MIG can change a VM's zone during a repair. |
| # Valid values are: |
| # |
| # - NO (default): MIG cannot change a VM's zone during a |
| # repair. |
| # - YES: MIG can select a different zone for the VM during |
| # a repair. |
| }, |
| }, |
| "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. The templates for existing instances in the |
| # group do not change unless you run recreateInstances, runapplyUpdatesToInstances, or set the group'supdatePolicy.type to PROACTIVE. |
| "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is alwayscompute#instanceGroupManager for managed instance groups. |
| "listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for |
| # this managed instance group. |
| "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to. |
| "name": "A String", # The name of the managed instance group. The name must be 1-63 characters |
| # long, and comply withRFC1035. |
| "namedPorts": [ # [Output Only] Named ports configured on the Instance Groups complementary |
| # to this Instance Group Manager. |
| { # The named port. For example: <"http", 80>. |
| "name": "A String", # The name for this named port. |
| # The name must be 1-63 characters long, and comply withRFC1035. |
| "port": 42, # The port number, which can be a value between 1 and 65535. |
| }, |
| ], |
| "params": { # Input only additional params for instance group manager creation. # Input only. Additional params passed with the request, but not persisted |
| # as part of resource payload. |
| "resourceManagerTags": { # Resource manager tags to bind to the managed instance group. The tags are |
| # key-value pairs. Keys must be in the format tagKeys/123 and values in the |
| # format tagValues/456. For more information, seeManage tags |
| # for resources. |
| "a_key": "A String", |
| }, |
| }, |
| "region": "A String", # [Output Only] The URL of theregion |
| # where the managed instance group resides (for regional resources). |
| "resourcePolicies": { # Resource policies for this managed instance group. |
| "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed |
| # instance group. |
| # It can be a full or partial URL. For example, the following are |
| # all valid URLs to a workload policy: |
| # |
| # |
| # - https://www.googleapis.com/compute/v1/projects/project/regions/region/resourcePolicies/resourcePolicy |
| # - projects/project/regions/region/resourcePolicies/resourcePolicy |
| # - regions/region/resourcePolicies/resourcePolicy |
| }, |
| "satisfiesPzi": True or False, # [Output Only] Reserved for future use. |
| "satisfiesPzs": True or False, # [Output Only] Reserved for future use. |
| "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines |
| # this URL. |
| "serviceAccount": "A String", # The service account to be used as credentials for all operations performed |
| # by the managed instance group on instances. The service accounts needs all |
| # permissions required to create and delete instances. |
| # By default, the service account |
| # {projectNumber}@cloudservices.gserviceaccount.com is used. |
| "standbyPolicy": { # Standby policy for stopped and suspended instances. |
| "initialDelaySec": 42, # Specifies the number of seconds that the MIG should wait to suspend or |
| # stop a VM after that VM was created. The initial delay gives the |
| # initialization script the time to prepare your VM for a quick scale out. |
| # The value of initial delay must be between 0 and 3600 seconds. The |
| # default value is 0. |
| "mode": "A String", # Defines how a MIG resumes or starts VMs from a standby pool when the |
| # group scales out. The default mode is `MANUAL`. |
| }, |
| "statefulPolicy": { # Stateful configuration for this Instanced Group Manager |
| "preservedState": { # Configuration of preserved resources. |
| "disks": { # Disks created on the instances that will be preserved on instance |
| # delete, update, etc. This map is keyed with the device names of |
| # the disks. |
| "a_key": { |
| "autoDelete": "A String", # These stateful disks will never be deleted during autohealing, |
| # update or VM instance recreate operations. |
| # This flag is used to configure if the disk should be deleted after it |
| # is no longer used by the group, e.g. when the given instance or |
| # the whole group is deleted. Note: disks attached inREAD_ONLY mode cannot be auto-deleted. |
| }, |
| }, |
| "externalIPs": { # External network IPs assigned to the instances that will be preserved on |
| # instance delete, update, etc. This map is keyed with the network |
| # interface name. |
| "a_key": { |
| "autoDelete": "A String", # These stateful IPs will never be released during autohealing, |
| # update or VM instance recreate operations. |
| # This flag is used to configure if the IP reservation should be deleted |
| # after it is no longer used by the group, e.g. when the given instance |
| # or the whole group is deleted. |
| }, |
| }, |
| "internalIPs": { # Internal network IPs assigned to the instances that will be preserved on |
| # instance delete, update, etc. This map is keyed with the network |
| # interface name. |
| "a_key": { |
| "autoDelete": "A String", # These stateful IPs will never be released during autohealing, |
| # update or VM instance recreate operations. |
| # This flag is used to configure if the IP reservation should be deleted |
| # after it is no longer used by the group, e.g. when the given instance |
| # or the whole group is deleted. |
| }, |
| }, |
| }, |
| }, |
| "status": { # [Output Only] The status of this managed instance group. |
| "allInstancesConfig": { # [Output only] Status of all-instances configuration on the group. |
| "currentRevision": "A String", # [Output Only] Current all-instances configuration revision. |
| # This value is in RFC3339 text format. |
| "effective": True or False, # [Output Only] A bit indicating whether this configuration has |
| # been applied to all managed instances in the group. |
| }, |
| "autoscaler": "A String", # [Output Only] The URL of theAutoscaler |
| # that targets this instance group manager. |
| "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # [Output Only] The status of bulk instance operation. |
| # targetSizePolicy.mode is set to BULK. |
| "inProgress": True or False, # [Output Only] Informs whether bulk instance operation is in progress. |
| "lastProgressCheck": { # [Output Only] Information from the last progress check of bulk instance |
| # operation. |
| "error": { # [Output Only] Errors encountered during bulk instance operation. |
| "errors": [ # [Output Only] The array of errors encountered while processing this |
| # operation. |
| { |
| "code": "A String", # [Output Only] The error type identifier for this error. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| }, |
| ], |
| }, |
| "timestamp": "A String", # [Output Only] Timestamp of the last progress check of bulk instance |
| # operation. Timestamp is in RFC3339 text format. |
| }, |
| }, |
| "isStable": True or False, # [Output Only] A bit indicating whether the managed instance group is in a |
| # stable state. A stable state means that: none of the instances in the |
| # managed instance group is currently undergoing any type of change (for |
| # example, creation, restart, or deletion); no future changes are scheduled |
| # for instances in the managed instance group; and the managed instance |
| # group itself is not being modified. |
| "stateful": { # [Output Only] Stateful status of the given Instance Group Manager. |
| "hasStatefulConfig": True or False, # [Output Only] A bit indicating whether the managed instance group |
| # has stateful configuration, that is, if you have configured any items |
| # in a stateful policy or in per-instance configs. |
| # The group might report that it has no stateful configuration even when |
| # there is still some preserved state on a managed instance, for example, |
| # if you have deleted all PICs but not yet applied those deletions. |
| "isStateful": True or False, # [Output Only] A bit indicating whether the managed instance group |
| # has stateful configuration, that is, if you have configured any items |
| # in a stateful policy or in per-instance configs. |
| # The group might report that it has no stateful configuration even when |
| # there is still some preserved state on a managed instance, for example, |
| # if you have deleted all PICs but not yet applied those deletions. This |
| # field is deprecated in favor of has_stateful_config. |
| "perInstanceConfigs": { # [Output Only] Status of per-instance configurations on the instances. |
| "allEffective": True or False, # A bit indicating if all of the group's per-instance configurations |
| # (listed in the output of a listPerInstanceConfigs API call) have |
| # status EFFECTIVE or there are no per-instance-configs. |
| }, |
| }, |
| "versionTarget": { # [Output Only] A status of consistency of Instances' versions with their |
| # target version specified by version field on Instance Group |
| # Manager. |
| "isReached": True or False, # [Output Only] A bit indicating whether version target has been reached |
| # in this managed instance group, i.e. all instances are in their target |
| # version. Instances' target version are specified byversion field on Instance Group Manager. |
| }, |
| }, |
| "targetPools": [ # The URLs for all TargetPool resources to which instances in theinstanceGroup field are added. The target pools automatically |
| # apply to all of the instances in the managed instance group. |
| "A String", |
| ], |
| "targetSize": 42, # The target number of running instances for this managed instance group. |
| # You can reduce this number by using the instanceGroupManager |
| # deleteInstances or abandonInstances methods. Resizing the group also |
| # changes this number. |
| "targetSizePolicy": { # The policy that specifies how the MIG creates its VMs to achieve the target |
| # size. |
| "mode": "A String", # The mode of target size policy based on which the MIG creates its VMs |
| # individually or all at once. |
| }, |
| "targetStoppedSize": 42, # The target number of stopped instances for this managed instance group. |
| # This number changes when you: |
| # |
| # - Stop instance using the stopInstances |
| # method or start instances using the startInstances |
| # method. |
| # - Manually change the targetStoppedSize using the update |
| # method. |
| "targetSuspendedSize": 42, # The target number of suspended instances for this managed instance group. |
| # This number changes when you: |
| # |
| # - Suspend instance using the suspendInstances |
| # method or resume instances using the resumeInstances |
| # method. |
| # - Manually change the targetSuspendedSize using the update |
| # method. |
| "updatePolicy": { # The update policy for this managed instance group. |
| "instanceRedistributionType": "A String", # The |
| # instance redistribution policy for regional managed instance groups. |
| # Valid values are: |
| # |
| # - PROACTIVE (default): The group attempts to maintain an |
| # even distribution of VM instances across zones in the region. |
| # - NONE: For non-autoscaled groups, proactive |
| # redistribution is disabled. |
| "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be created above the specifiedtargetSize during the update process. This value can be |
| # either a fixed number or, if the group has 10 or more instances, a |
| # percentage. If you set a percentage, the number of instances is rounded |
| # if necessary. The default value for maxSurge is a fixed |
| # value equal to the number of zones in which the managed instance group |
| # operates. |
| # |
| # At least one of either maxSurge ormaxUnavailable must be greater than 0. Learn more about maxSurge. |
| "calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the |
| # specific mode. |
| # |
| # |
| # |
| # - If the value is fixed, then the calculated |
| # value is equal to the fixed value. |
| # - If the value is a percent, then the |
| # calculated |
| # value is percent/100 * targetSize. For example, |
| # the calculated value of a 80% of a managed instance group |
| # with 150 instances would be (80/100 * 150) = 120 VM instances. If there |
| # is a remainder, the number is rounded. |
| "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. |
| "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For |
| # example, specify 80 for 80%. |
| }, |
| "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be unavailable during the update |
| # process. An instance is considered available if all of the following |
| # conditions are satisfied: |
| # |
| # |
| # |
| # - The instance's status is |
| # RUNNING. |
| # - If there is a health |
| # check on the instance group, the instance's health check status |
| # must be HEALTHY at least once. If there is no health check |
| # on the group, then the instance only needs to have a status of |
| # RUNNING to be considered available. |
| # |
| # |
| # This value can be either a fixed number or, if the group has 10 or more |
| # instances, a percentage. If you set a percentage, the number of instances |
| # is rounded if necessary. The default value formaxUnavailable is a fixed value equal to the number of zones |
| # in which the managed instance group operates. |
| # |
| # At least one of either maxSurge ormaxUnavailable must be greater than 0. Learn more about maxUnavailable. |
| "calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the |
| # specific mode. |
| # |
| # |
| # |
| # - If the value is fixed, then the calculated |
| # value is equal to the fixed value. |
| # - If the value is a percent, then the |
| # calculated |
| # value is percent/100 * targetSize. For example, |
| # the calculated value of a 80% of a managed instance group |
| # with 150 instances would be (80/100 * 150) = 120 VM instances. If there |
| # is a remainder, the number is rounded. |
| "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. |
| "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For |
| # example, specify 80 for 80%. |
| }, |
| "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance |
| # becomes available. This value must be from range [0, 3600]. |
| "minimalAction": "A String", # Minimal action to be taken on an instance. Use this option to minimize |
| # disruption as much as possible or to apply a more disruptive action than |
| # is necessary. |
| # |
| # - To limit disruption as much as possible, set the minimal action toREFRESH. If your update requires a more disruptive action, |
| # Compute Engine performs the necessary action to execute the update. |
| # - To apply a more disruptive action than is strictly necessary, set the |
| # minimal action to RESTART or REPLACE. For |
| # example, Compute Engine does not need to restart a VM to change its |
| # metadata. But if your application reads instance metadata only when a VM |
| # is restarted, you can set the minimal action to RESTART in |
| # order to pick up metadata changes. |
| "mostDisruptiveAllowedAction": "A String", # Most disruptive action that is allowed to be taken on an instance. |
| # You can specify either NONE to forbid any actions,REFRESH to avoid restarting the VM and to limit disruption |
| # as much as possible. RESTART to allow actions that can be |
| # applied without instance replacing or REPLACE to allow all |
| # possible actions. If the Updater determines that the minimal update |
| # action needed is more disruptive than most disruptive allowed action you |
| # specify it will not perform the update at all. |
| "replacementMethod": "A String", # What action should be used to replace instances. |
| # See minimal_action.REPLACE |
| "type": "A String", # The type |
| # of update process. You can specify either PROACTIVE so |
| # that the MIG automatically updates VMs to the latest configurations orOPPORTUNISTIC so that you can select the VMs that you want |
| # to update. |
| }, |
| "versions": [ # Specifies the instance templates used by this managed instance group to |
| # create instances. |
| # |
| # Each version is defined by an instanceTemplate and aname. Every version can appear at most once per instance |
| # group. This field overrides the top-level instanceTemplate |
| # field. Read more about therelationships |
| # between these fields. Exactly one version must leave thetargetSize field unset. That version will be applied to all |
| # remaining instances. For more information, read aboutcanary |
| # updates. |
| { |
| "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed |
| # instance group. The group uses this template to create new instances in |
| # the managed instance group until the `targetSize` for this version is |
| # reached. The templates for existing instances in the group do not change |
| # unless you run recreateInstances, runapplyUpdatesToInstances, or set the group'supdatePolicy.type to PROACTIVE; in those cases, |
| # existing instances are updated until the `targetSize` for this version is |
| # reached. |
| "name": "A String", # Name of the version. Unique among all versions in the scope of this |
| # managed instance group. |
| "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Specifies the intended number of instances to be created from theinstanceTemplate. The final number of instances created |
| # from the template will be equal to: |
| # |
| # |
| # - If expressed as a fixed number, the minimum of either |
| # targetSize.fixed or |
| # instanceGroupManager.targetSize is used. |
| # - if expressed as a percent, the targetSize |
| # would be (targetSize.percent/100 * |
| # InstanceGroupManager.targetSize) If there is a remainder, the |
| # number is rounded. |
| # |
| # If unset, this version will update any remaining instances not |
| # updated by another version. ReadStarting |
| # a canary update for more information. |
| "calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the |
| # specific mode. |
| # |
| # |
| # |
| # - If the value is fixed, then the calculated |
| # value is equal to the fixed value. |
| # - If the value is a percent, then the |
| # calculated |
| # value is percent/100 * targetSize. For example, |
| # the calculated value of a 80% of a managed instance group |
| # with 150 instances would be (80/100 * 150) = 120 VM instances. If there |
| # is a remainder, the number is rounded. |
| "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. |
| "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For |
| # example, specify 80 for 80%. |
| }, |
| }, |
| ], |
| "zone": "A String", # [Output Only] The URL of azone |
| # where the managed instance group is located (for zonal resources). |
| } |
| |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so |
| that if you must retry your request, the server will know to ignore the |
| request if it has already been completed. |
| |
| For example, consider a situation where you make an initial request and |
| the request times out. If you make the request again with the same |
| request ID, the server can check if original operation with the same |
| request ID was received, and if so, will ignore the second request. This |
| prevents clients from accidentally creating duplicate commitments. |
| |
| The request ID must be |
| a valid UUID with the exception that zero UUID is not supported |
| (00000000-0000-0000-0000-000000000000). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/beta/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/beta/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # |
| # - For global operations, use the `globalOperations` |
| # resource. |
| # - For regional operations, use the |
| # `regionOperations` resource. |
| # - For zonal operations, use |
| # the `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. |
| # Not present otherwise. |
| "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| "description": "A String", # [Output Only] A textual description of the operation, which is |
| # set when the operation is created. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 |
| # text format. |
| "error": { # [Output Only] If errors are generated during processing of the operation, |
| # this field will be populated. |
| "errors": [ # [Output Only] The array of errors encountered while processing this |
| # operation. |
| { |
| "code": "A String", # [Output Only] The error type identifier for this error. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| }, |
| ], |
| }, |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error |
| # message that was returned, such as `NOT FOUND`. |
| "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. |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is |
| # defined by the server. |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. |
| # This value is inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, |
| # `update`, or `delete`, and so on. |
| "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. |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only |
| # applicable when performing regional operations. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # text format. |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the |
| # following: |
| # `PENDING`, `RUNNING`, or `DONE`. |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the |
| # operation. |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation |
| # of the target resource. |
| "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For |
| # operations related to creating a snapshot, this points to the disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `[email protected]` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the |
| # operation, this field will be populated. |
| { |
| "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. |
| "data": [ # [Output Only] Metadata about this warning in key: |
| # value format. For example: |
| # |
| # "data": [ |
| # { |
| # "key": "scope", |
| # "value": "zones/us-east1-d" |
| # } |
| { |
| "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). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| ], |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only |
| # applicable when performing per-zone operations. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> |
| <pre>Retrieves the list of managed instance groups that are contained |
| within the specified region. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, Name of the region scoping this request. (required) |
| filter: string, A filter expression that filters resources listed in the response. Most |
| Compute resources support two types of filter expressions: |
| expressions that support regular expressions and expressions that follow |
| API improvement proposal AIP-160. |
| These two types of filter expressions cannot be mixed in one request. |
| |
| If you want to use AIP-160, your expression must specify the field name, an |
| operator, and the value that you want to use for filtering. The value |
| must be a string, a number, or a boolean. The operator |
| must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. |
| |
| For example, if you are filtering Compute Engine instances, you can |
| exclude instances named `example-instance` by specifying |
| `name != example-instance`. |
| |
| The `:*` comparison can be used to test whether a key has been defined. |
| For example, to find all objects with `owner` label use: |
| ``` |
| labels.owner:* |
| ``` |
| |
| You can also filter nested fields. For example, you could specify |
| `scheduling.automaticRestart = false` to include instances only |
| if they are not scheduled for automatic restarts. You can use filtering |
| on nested fields to filter based onresource labels. |
| |
| To filter on multiple expressions, provide each separate expression within |
| parentheses. For example: |
| ``` |
| (scheduling.automaticRestart = true) |
| (cpuPlatform = "Intel Skylake") |
| ``` |
| By default, each expression is an `AND` expression. However, you |
| can include `AND` and `OR` expressions explicitly. |
| For example: |
| ``` |
| (cpuPlatform = "Intel Skylake") OR |
| (cpuPlatform = "Intel Broadwell") AND |
| (scheduling.automaticRestart = true) |
| ``` |
| |
| If you want to use a regular expression, use the `eq` (equal) or `ne` |
| (not equal) operator against a single un-parenthesized expression with or |
| without quotes or against multiple parenthesized expressions. Examples: |
| |
| `fieldname eq unquoted literal` |
| `fieldname eq 'single quoted literal'` |
| `fieldname eq "double quoted literal"` |
| `(fieldname1 eq literal) (fieldname2 ne "literal")` |
| |
| The literal value is interpreted as a regular expression using GoogleRE2 library syntax. |
| The literal value must match the entire field. |
| |
| For example, to filter for instances that do not end with name "instance", |
| you would use `name ne .*instance`. |
| |
| You cannot combine constraints on multiple fields using regular |
| expressions. |
| 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. Acceptable values are |
| `0` to `500`, inclusive. (Default: `500`) |
| orderBy: string, Sorts list results by a certain order. By default, results |
| are returned in alphanumerical order based on the resource name. |
| |
| You 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. |
| |
| Currently, only sorting by `name` or |
| `creationTimestamp desc` is supported. |
| 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. |
| returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case |
| of failure. The default value is false. |
| |
| For example, when partial success behavior is enabled, aggregatedList for a |
| single zone scope either returns all resources in the zone or no resources, |
| with an error code. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Contains a list of managed instance groups. |
| "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. |
| "items": [ # A list of InstanceGroupManager resources. |
| { # Represents a Managed Instance Group resource. |
| # |
| # An instance group is a collection of VM instances that you can manage as a |
| # single entity. For more information, readInstance groups. |
| # |
| # For zonal Managed Instance Group, use the instanceGroupManagers |
| # resource. |
| # |
| # For regional Managed Instance Group, use theregionInstanceGroupManagers resource. |
| "allInstancesConfig": { # Specifies configuration that overrides the instance template configuration |
| # for the group. |
| "properties": { # Represents the change that you want to make to the instance properties. # Properties to set on all instances in the group. |
| # |
| # You can add or modify properties using theinstanceGroupManagers.patch orregionInstanceGroupManagers.patch. After settingallInstancesConfig on the group, you must update the group's |
| # instances to apply the configuration. To apply the configuration, set the |
| # group's updatePolicy.type field to use proactive updates or |
| # use the applyUpdatesToInstances method. |
| "labels": { # The label key-value pairs that you want to patch onto the instance. |
| "a_key": "A String", |
| }, |
| "metadata": { # The metadata key-value pairs that you want to patch onto the instance. For |
| # more information, see Project and |
| # instance metadata. |
| "a_key": "A String", |
| }, |
| }, |
| }, |
| "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify |
| # only one value. |
| { |
| "healthCheck": "A String", # The URL for the health check that signals autohealing. |
| "initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to |
| # initialize and run its startup script. During a VM's initial delay |
| # period, the MIG ignores unsuccessful health checks because the VM might |
| # be in the startup process. This prevents the MIG from prematurely |
| # recreating a VM. If the health check receives a healthy response during |
| # the initial delay, it indicates that the startup process is complete and |
| # the VM is ready. The value of initial delay must be between 0 and 3600 |
| # seconds. The default value is 0. |
| }, |
| ], |
| "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of |
| # all VMs in a MIG. The maximum character length is 58 and the name must |
| # comply with RFC1035 format. |
| # |
| # When a VM is created in the group, the MIG appends a hyphen and a random |
| # four-character string to the base instance name. If you want the MIG to |
| # assign sequential numbers instead of a random string, then end the base |
| # instance name with a hyphen followed by one or more hash symbols. The hash |
| # symbols indicate the number of digits. For example, a base instance name of |
| # "vm-###" results in "vm-001" as a VM name. |
| # @pattern |
| # [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\\[[0-9]{1,10}\\])?)) |
| "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group inRFC3339 |
| # text format. |
| "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. |
| "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. |
| "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. |
| # |
| # If you have disabled creation retries, this field will not be populated; |
| # instead, the creatingWithoutRetries field will be populated. |
| "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. |
| "deleting": 42, # [Output Only] The number of instances in the managed instance group that |
| # are scheduled to be deleted or are currently being deleted. |
| "none": 42, # [Output Only] The number of instances in the managed instance group that |
| # are running and have no scheduled actions. |
| "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. |
| "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. |
| "restarting": 42, # [Output Only] The number of instances in the managed instance group that |
| # are scheduled to be restarted or are currently being restarted. |
| "resuming": 42, # [Output Only] The number of instances in the managed instance group that |
| # are scheduled to be resumed or are currently being resumed. |
| "starting": 42, # [Output Only] The number of instances in the managed instance group that |
| # are scheduled to be started or are currently being started. |
| "stopping": 42, # [Output Only] The number of instances in the managed instance group that |
| # are scheduled to be stopped or are currently being stopped. |
| "suspending": 42, # [Output Only] The number of instances in the managed instance group that |
| # are scheduled to be suspended or are currently being suspended. |
| "verifying": 42, # [Output Only] The number of instances in the managed instance group that |
| # are being verified. See the managedInstances[].currentAction |
| # property in the listManagedInstances method documentation. |
| }, |
| "description": "A String", # An optional description of this resource. |
| "distributionPolicy": { # Policy specifying the intended distribution of managed instances across |
| # zones in a regional managed instance group. |
| "targetShape": "A String", # The distribution shape to which the group converges either proactively or |
| # on resize events (depending on the value set inupdatePolicy.instanceRedistributionType). |
| "zones": [ # Zones where the regional managed instance group will create and manage |
| # its instances. |
| { |
| "zone": "A String", # The URL of thezone. |
| # The zone must exist in the region where the managed instance group is |
| # located. |
| }, |
| ], |
| }, |
| "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported,NO_FAILOVER. The default is NO_FAILOVER. |
| "fingerprint": "A String", # Fingerprint of this resource. This field may be used in optimistic locking. |
| # It will be ignored when inserting an InstanceGroupManager. An up-to-date |
| # fingerprint must be provided in order to update the InstanceGroupManager, |
| # otherwise the request will fail with error412 conditionNotMet. |
| # |
| # To see the latest fingerprint, make a get() request to |
| # retrieve an InstanceGroupManager. |
| "id": "A String", # [Output Only] A unique identifier for this resource type. The server |
| # generates this identifier. |
| "instanceFlexibilityPolicy": { # Instance flexibility allowing MIG to create VMs from multiple |
| # types of machines. |
| # Instance flexibility configuration on MIG overrides instance |
| # template configuration. |
| "instanceSelections": { # Named instance selections configuring properties that the group will use |
| # when creating new VMs. |
| "a_key": { |
| "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16". |
| "A String", |
| ], |
| "rank": 42, # Preference of this instance selection. Lower number means higher |
| # preference. MIG will first try to create a VM based on the machine-type |
| # with lowest rank and fallback to next rank based on availability. |
| # Machine types and instance selections with the same rank have the same |
| # preference. |
| }, |
| }, |
| "provisioningModelMix": { # Provisioning model configuration used by this managed instance group to |
| # create instances. |
| "standardCapacityBase": 42, # The base capacity that will always use Standard VMs to avoid risk of |
| # more preemption than the minimum capacity user needs. MIG will create |
| # only Standard VMs until it reaches standard_capacity_base and only |
| # then will start using standard_capacity_percent_above_base to mix Spot |
| # with Standard VMs. |
| "standardCapacityPercentAboveBase": 42, # The percentage of target capacity that should use Standard VM. The |
| # remaining percentage will use Spot VMs. The percentage applies only to |
| # the capacity above standard_capacity_base. |
| }, |
| }, |
| "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource. |
| "instanceLifecyclePolicy": { # The repair policy for this managed instance group. |
| "defaultActionOnFailure": "A String", # The action that a MIG performs on a failed VM. If the value of the onFailedHealthCheck field |
| # is `DEFAULT_ACTION`, then the same action also applies to the VMs on which your application |
| # fails a health check. Valid values are - REPAIR (default): MIG automatically repairs a failed |
| # VM by recreating it. For more information, seeAbout repairing |
| # VMs in a MIG. - DO_NOTHING: MIG does not repair a failed VM. |
| "forceUpdateOnRepair": "A String", # A bit indicating whether to forcefully apply the group's latest |
| # configuration when repairing a VM. Valid options are: |
| # |
| # |
| # |
| # - NO (default): If configuration updates are available, they are not |
| # forcefully applied during repair. Instead, configuration updates are |
| # applied according to the group's update policy. |
| # |
| # - YES: If configuration updates are available, they are applied |
| # during repair. |
| "onFailedHealthCheck": "A String", # The action that a MIG performs on an unhealthy VM. A VM is marked as |
| # unhealthy when the application running on that VM fails a health check. |
| # Valid values are: |
| # |
| # - DEFAULT_ACTION (default): MIG uses the same action |
| # configured for instanceLifecyclePolicy.defaultActionOnFailure field. |
| # - REPAIR: MIG automatically repairs an unhealthy VM by |
| # recreating it. |
| # - DO_NOTHING: MIG doesn't repair an unhealthy VM. |
| # For more information, see |
| # About repairing VMs in a MIG. |
| "onRepair": { # Configuration for VM repairs in the MIG. # Configuration for VM repairs in the MIG. |
| "allowChangingZone": "A String", # Specifies whether the MIG can change a VM's zone during a repair. |
| # Valid values are: |
| # |
| # - NO (default): MIG cannot change a VM's zone during a |
| # repair. |
| # - YES: MIG can select a different zone for the VM during |
| # a repair. |
| }, |
| }, |
| "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. The templates for existing instances in the |
| # group do not change unless you run recreateInstances, runapplyUpdatesToInstances, or set the group'supdatePolicy.type to PROACTIVE. |
| "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is alwayscompute#instanceGroupManager for managed instance groups. |
| "listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for |
| # this managed instance group. |
| "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to. |
| "name": "A String", # The name of the managed instance group. The name must be 1-63 characters |
| # long, and comply withRFC1035. |
| "namedPorts": [ # [Output Only] Named ports configured on the Instance Groups complementary |
| # to this Instance Group Manager. |
| { # The named port. For example: <"http", 80>. |
| "name": "A String", # The name for this named port. |
| # The name must be 1-63 characters long, and comply withRFC1035. |
| "port": 42, # The port number, which can be a value between 1 and 65535. |
| }, |
| ], |
| "params": { # Input only additional params for instance group manager creation. # Input only. Additional params passed with the request, but not persisted |
| # as part of resource payload. |
| "resourceManagerTags": { # Resource manager tags to bind to the managed instance group. The tags are |
| # key-value pairs. Keys must be in the format tagKeys/123 and values in the |
| # format tagValues/456. For more information, seeManage tags |
| # for resources. |
| "a_key": "A String", |
| }, |
| }, |
| "region": "A String", # [Output Only] The URL of theregion |
| # where the managed instance group resides (for regional resources). |
| "resourcePolicies": { # Resource policies for this managed instance group. |
| "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed |
| # instance group. |
| # It can be a full or partial URL. For example, the following are |
| # all valid URLs to a workload policy: |
| # |
| # |
| # - https://www.googleapis.com/compute/v1/projects/project/regions/region/resourcePolicies/resourcePolicy |
| # - projects/project/regions/region/resourcePolicies/resourcePolicy |
| # - regions/region/resourcePolicies/resourcePolicy |
| }, |
| "satisfiesPzi": True or False, # [Output Only] Reserved for future use. |
| "satisfiesPzs": True or False, # [Output Only] Reserved for future use. |
| "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines |
| # this URL. |
| "serviceAccount": "A String", # The service account to be used as credentials for all operations performed |
| # by the managed instance group on instances. The service accounts needs all |
| # permissions required to create and delete instances. |
| # By default, the service account |
| # {projectNumber}@cloudservices.gserviceaccount.com is used. |
| "standbyPolicy": { # Standby policy for stopped and suspended instances. |
| "initialDelaySec": 42, # Specifies the number of seconds that the MIG should wait to suspend or |
| # stop a VM after that VM was created. The initial delay gives the |
| # initialization script the time to prepare your VM for a quick scale out. |
| # The value of initial delay must be between 0 and 3600 seconds. The |
| # default value is 0. |
| "mode": "A String", # Defines how a MIG resumes or starts VMs from a standby pool when the |
| # group scales out. The default mode is `MANUAL`. |
| }, |
| "statefulPolicy": { # Stateful configuration for this Instanced Group Manager |
| "preservedState": { # Configuration of preserved resources. |
| "disks": { # Disks created on the instances that will be preserved on instance |
| # delete, update, etc. This map is keyed with the device names of |
| # the disks. |
| "a_key": { |
| "autoDelete": "A String", # These stateful disks will never be deleted during autohealing, |
| # update or VM instance recreate operations. |
| # This flag is used to configure if the disk should be deleted after it |
| # is no longer used by the group, e.g. when the given instance or |
| # the whole group is deleted. Note: disks attached inREAD_ONLY mode cannot be auto-deleted. |
| }, |
| }, |
| "externalIPs": { # External network IPs assigned to the instances that will be preserved on |
| # instance delete, update, etc. This map is keyed with the network |
| # interface name. |
| "a_key": { |
| "autoDelete": "A String", # These stateful IPs will never be released during autohealing, |
| # update or VM instance recreate operations. |
| # This flag is used to configure if the IP reservation should be deleted |
| # after it is no longer used by the group, e.g. when the given instance |
| # or the whole group is deleted. |
| }, |
| }, |
| "internalIPs": { # Internal network IPs assigned to the instances that will be preserved on |
| # instance delete, update, etc. This map is keyed with the network |
| # interface name. |
| "a_key": { |
| "autoDelete": "A String", # These stateful IPs will never be released during autohealing, |
| # update or VM instance recreate operations. |
| # This flag is used to configure if the IP reservation should be deleted |
| # after it is no longer used by the group, e.g. when the given instance |
| # or the whole group is deleted. |
| }, |
| }, |
| }, |
| }, |
| "status": { # [Output Only] The status of this managed instance group. |
| "allInstancesConfig": { # [Output only] Status of all-instances configuration on the group. |
| "currentRevision": "A String", # [Output Only] Current all-instances configuration revision. |
| # This value is in RFC3339 text format. |
| "effective": True or False, # [Output Only] A bit indicating whether this configuration has |
| # been applied to all managed instances in the group. |
| }, |
| "autoscaler": "A String", # [Output Only] The URL of theAutoscaler |
| # that targets this instance group manager. |
| "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # [Output Only] The status of bulk instance operation. |
| # targetSizePolicy.mode is set to BULK. |
| "inProgress": True or False, # [Output Only] Informs whether bulk instance operation is in progress. |
| "lastProgressCheck": { # [Output Only] Information from the last progress check of bulk instance |
| # operation. |
| "error": { # [Output Only] Errors encountered during bulk instance operation. |
| "errors": [ # [Output Only] The array of errors encountered while processing this |
| # operation. |
| { |
| "code": "A String", # [Output Only] The error type identifier for this error. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| }, |
| ], |
| }, |
| "timestamp": "A String", # [Output Only] Timestamp of the last progress check of bulk instance |
| # operation. Timestamp is in RFC3339 text format. |
| }, |
| }, |
| "isStable": True or False, # [Output Only] A bit indicating whether the managed instance group is in a |
| # stable state. A stable state means that: none of the instances in the |
| # managed instance group is currently undergoing any type of change (for |
| # example, creation, restart, or deletion); no future changes are scheduled |
| # for instances in the managed instance group; and the managed instance |
| # group itself is not being modified. |
| "stateful": { # [Output Only] Stateful status of the given Instance Group Manager. |
| "hasStatefulConfig": True or False, # [Output Only] A bit indicating whether the managed instance group |
| # has stateful configuration, that is, if you have configured any items |
| # in a stateful policy or in per-instance configs. |
| # The group might report that it has no stateful configuration even when |
| # there is still some preserved state on a managed instance, for example, |
| # if you have deleted all PICs but not yet applied those deletions. |
| "isStateful": True or False, # [Output Only] A bit indicating whether the managed instance group |
| # has stateful configuration, that is, if you have configured any items |
| # in a stateful policy or in per-instance configs. |
| # The group might report that it has no stateful configuration even when |
| # there is still some preserved state on a managed instance, for example, |
| # if you have deleted all PICs but not yet applied those deletions. This |
| # field is deprecated in favor of has_stateful_config. |
| "perInstanceConfigs": { # [Output Only] Status of per-instance configurations on the instances. |
| "allEffective": True or False, # A bit indicating if all of the group's per-instance configurations |
| # (listed in the output of a listPerInstanceConfigs API call) have |
| # status EFFECTIVE or there are no per-instance-configs. |
| }, |
| }, |
| "versionTarget": { # [Output Only] A status of consistency of Instances' versions with their |
| # target version specified by version field on Instance Group |
| # Manager. |
| "isReached": True or False, # [Output Only] A bit indicating whether version target has been reached |
| # in this managed instance group, i.e. all instances are in their target |
| # version. Instances' target version are specified byversion field on Instance Group Manager. |
| }, |
| }, |
| "targetPools": [ # The URLs for all TargetPool resources to which instances in theinstanceGroup field are added. The target pools automatically |
| # apply to all of the instances in the managed instance group. |
| "A String", |
| ], |
| "targetSize": 42, # The target number of running instances for this managed instance group. |
| # You can reduce this number by using the instanceGroupManager |
| # deleteInstances or abandonInstances methods. Resizing the group also |
| # changes this number. |
| "targetSizePolicy": { # The policy that specifies how the MIG creates its VMs to achieve the target |
| # size. |
| "mode": "A String", # The mode of target size policy based on which the MIG creates its VMs |
| # individually or all at once. |
| }, |
| "targetStoppedSize": 42, # The target number of stopped instances for this managed instance group. |
| # This number changes when you: |
| # |
| # - Stop instance using the stopInstances |
| # method or start instances using the startInstances |
| # method. |
| # - Manually change the targetStoppedSize using the update |
| # method. |
| "targetSuspendedSize": 42, # The target number of suspended instances for this managed instance group. |
| # This number changes when you: |
| # |
| # - Suspend instance using the suspendInstances |
| # method or resume instances using the resumeInstances |
| # method. |
| # - Manually change the targetSuspendedSize using the update |
| # method. |
| "updatePolicy": { # The update policy for this managed instance group. |
| "instanceRedistributionType": "A String", # The |
| # instance redistribution policy for regional managed instance groups. |
| # Valid values are: |
| # |
| # - PROACTIVE (default): The group attempts to maintain an |
| # even distribution of VM instances across zones in the region. |
| # - NONE: For non-autoscaled groups, proactive |
| # redistribution is disabled. |
| "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be created above the specifiedtargetSize during the update process. This value can be |
| # either a fixed number or, if the group has 10 or more instances, a |
| # percentage. If you set a percentage, the number of instances is rounded |
| # if necessary. The default value for maxSurge is a fixed |
| # value equal to the number of zones in which the managed instance group |
| # operates. |
| # |
| # At least one of either maxSurge ormaxUnavailable must be greater than 0. Learn more about maxSurge. |
| "calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the |
| # specific mode. |
| # |
| # |
| # |
| # - If the value is fixed, then the calculated |
| # value is equal to the fixed value. |
| # - If the value is a percent, then the |
| # calculated |
| # value is percent/100 * targetSize. For example, |
| # the calculated value of a 80% of a managed instance group |
| # with 150 instances would be (80/100 * 150) = 120 VM instances. If there |
| # is a remainder, the number is rounded. |
| "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. |
| "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For |
| # example, specify 80 for 80%. |
| }, |
| "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be unavailable during the update |
| # process. An instance is considered available if all of the following |
| # conditions are satisfied: |
| # |
| # |
| # |
| # - The instance's status is |
| # RUNNING. |
| # - If there is a health |
| # check on the instance group, the instance's health check status |
| # must be HEALTHY at least once. If there is no health check |
| # on the group, then the instance only needs to have a status of |
| # RUNNING to be considered available. |
| # |
| # |
| # This value can be either a fixed number or, if the group has 10 or more |
| # instances, a percentage. If you set a percentage, the number of instances |
| # is rounded if necessary. The default value formaxUnavailable is a fixed value equal to the number of zones |
| # in which the managed instance group operates. |
| # |
| # At least one of either maxSurge ormaxUnavailable must be greater than 0. Learn more about maxUnavailable. |
| "calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the |
| # specific mode. |
| # |
| # |
| # |
| # - If the value is fixed, then the calculated |
| # value is equal to the fixed value. |
| # - If the value is a percent, then the |
| # calculated |
| # value is percent/100 * targetSize. For example, |
| # the calculated value of a 80% of a managed instance group |
| # with 150 instances would be (80/100 * 150) = 120 VM instances. If there |
| # is a remainder, the number is rounded. |
| "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. |
| "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For |
| # example, specify 80 for 80%. |
| }, |
| "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance |
| # becomes available. This value must be from range [0, 3600]. |
| "minimalAction": "A String", # Minimal action to be taken on an instance. Use this option to minimize |
| # disruption as much as possible or to apply a more disruptive action than |
| # is necessary. |
| # |
| # - To limit disruption as much as possible, set the minimal action toREFRESH. If your update requires a more disruptive action, |
| # Compute Engine performs the necessary action to execute the update. |
| # - To apply a more disruptive action than is strictly necessary, set the |
| # minimal action to RESTART or REPLACE. For |
| # example, Compute Engine does not need to restart a VM to change its |
| # metadata. But if your application reads instance metadata only when a VM |
| # is restarted, you can set the minimal action to RESTART in |
| # order to pick up metadata changes. |
| "mostDisruptiveAllowedAction": "A String", # Most disruptive action that is allowed to be taken on an instance. |
| # You can specify either NONE to forbid any actions,REFRESH to avoid restarting the VM and to limit disruption |
| # as much as possible. RESTART to allow actions that can be |
| # applied without instance replacing or REPLACE to allow all |
| # possible actions. If the Updater determines that the minimal update |
| # action needed is more disruptive than most disruptive allowed action you |
| # specify it will not perform the update at all. |
| "replacementMethod": "A String", # What action should be used to replace instances. |
| # See minimal_action.REPLACE |
| "type": "A String", # The type |
| # of update process. You can specify either PROACTIVE so |
| # that the MIG automatically updates VMs to the latest configurations orOPPORTUNISTIC so that you can select the VMs that you want |
| # to update. |
| }, |
| "versions": [ # Specifies the instance templates used by this managed instance group to |
| # create instances. |
| # |
| # Each version is defined by an instanceTemplate and aname. Every version can appear at most once per instance |
| # group. This field overrides the top-level instanceTemplate |
| # field. Read more about therelationships |
| # between these fields. Exactly one version must leave thetargetSize field unset. That version will be applied to all |
| # remaining instances. For more information, read aboutcanary |
| # updates. |
| { |
| "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed |
| # instance group. The group uses this template to create new instances in |
| # the managed instance group until the `targetSize` for this version is |
| # reached. The templates for existing instances in the group do not change |
| # unless you run recreateInstances, runapplyUpdatesToInstances, or set the group'supdatePolicy.type to PROACTIVE; in those cases, |
| # existing instances are updated until the `targetSize` for this version is |
| # reached. |
| "name": "A String", # Name of the version. Unique among all versions in the scope of this |
| # managed instance group. |
| "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Specifies the intended number of instances to be created from theinstanceTemplate. The final number of instances created |
| # from the template will be equal to: |
| # |
| # |
| # - If expressed as a fixed number, the minimum of either |
| # targetSize.fixed or |
| # instanceGroupManager.targetSize is used. |
| # - if expressed as a percent, the targetSize |
| # would be (targetSize.percent/100 * |
| # InstanceGroupManager.targetSize) If there is a remainder, the |
| # number is rounded. |
| # |
| # If unset, this version will update any remaining instances not |
| # updated by another version. ReadStarting |
| # a canary update for more information. |
| "calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the |
| # specific mode. |
| # |
| # |
| # |
| # - If the value is fixed, then the calculated |
| # value is equal to the fixed value. |
| # - If the value is a percent, then the |
| # calculated |
| # value is percent/100 * targetSize. For example, |
| # the calculated value of a 80% of a managed instance group |
| # with 150 instances would be (80/100 * 150) = 120 VM instances. If there |
| # is a remainder, the number is rounded. |
| "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. |
| "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For |
| # example, specify 80 for 80%. |
| }, |
| }, |
| ], |
| "zone": "A String", # [Output Only] The URL of azone |
| # where the managed instance group is located (for zonal resources). |
| }, |
| ], |
| "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. |
| "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for |
| # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for |
| # the query parameter pageToken in the next list request. |
| # Subsequent list requests will have their own nextPageToken to |
| # continue paging through the results. |
| "selfLink": "A String", # [Output Only] Server-defined URL for this resource. |
| "warning": { # [Output Only] Informational warning message. |
| "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. |
| "data": [ # [Output Only] Metadata about this warning in key: |
| # value format. For example: |
| # |
| # "data": [ |
| # { |
| # "key": "scope", |
| # "value": "zones/us-east1-d" |
| # } |
| { |
| "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). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="listErrors">listErrors(project, region, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> |
| <pre>Lists all errors thrown by actions on instances for a given regional |
| managed instance group. The filter andorderBy query parameters are not supported. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, Name of the region scoping this request. |
| This should conform to RFC1035. (required) |
| instanceGroupManager: string, The name of the managed instance group. |
| It must be a string that meets the requirements in RFC1035, or an |
| unsigned long integer: must match regexp pattern: |
| (?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)|1-9{0,19}. (required) |
| filter: string, A filter expression that filters resources listed in the response. Most |
| Compute resources support two types of filter expressions: |
| expressions that support regular expressions and expressions that follow |
| API improvement proposal AIP-160. |
| These two types of filter expressions cannot be mixed in one request. |
| |
| If you want to use AIP-160, your expression must specify the field name, an |
| operator, and the value that you want to use for filtering. The value |
| must be a string, a number, or a boolean. The operator |
| must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. |
| |
| For example, if you are filtering Compute Engine instances, you can |
| exclude instances named `example-instance` by specifying |
| `name != example-instance`. |
| |
| The `:*` comparison can be used to test whether a key has been defined. |
| For example, to find all objects with `owner` label use: |
| ``` |
| labels.owner:* |
| ``` |
| |
| You can also filter nested fields. For example, you could specify |
| `scheduling.automaticRestart = false` to include instances only |
| if they are not scheduled for automatic restarts. You can use filtering |
| on nested fields to filter based onresource labels. |
| |
| To filter on multiple expressions, provide each separate expression within |
| parentheses. For example: |
| ``` |
| (scheduling.automaticRestart = true) |
| (cpuPlatform = "Intel Skylake") |
| ``` |
| By default, each expression is an `AND` expression. However, you |
| can include `AND` and `OR` expressions explicitly. |
| For example: |
| ``` |
| (cpuPlatform = "Intel Skylake") OR |
| (cpuPlatform = "Intel Broadwell") AND |
| (scheduling.automaticRestart = true) |
| ``` |
| |
| If you want to use a regular expression, use the `eq` (equal) or `ne` |
| (not equal) operator against a single un-parenthesized expression with or |
| without quotes or against multiple parenthesized expressions. Examples: |
| |
| `fieldname eq unquoted literal` |
| `fieldname eq 'single quoted literal'` |
| `fieldname eq "double quoted literal"` |
| `(fieldname1 eq literal) (fieldname2 ne "literal")` |
| |
| The literal value is interpreted as a regular expression using GoogleRE2 library syntax. |
| The literal value must match the entire field. |
| |
| For example, to filter for instances that do not end with name "instance", |
| you would use `name ne .*instance`. |
| |
| You cannot combine constraints on multiple fields using regular |
| expressions. |
| 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. Acceptable values are |
| `0` to `500`, inclusive. (Default: `500`) |
| orderBy: string, Sorts list results by a certain order. By default, results |
| are returned in alphanumerical order based on the resource name. |
| |
| You 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. |
| |
| Currently, only sorting by `name` or |
| `creationTimestamp desc` is supported. |
| 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. |
| returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case |
| of failure. The default value is false. |
| |
| For example, when partial success behavior is enabled, aggregatedList for a |
| single zone scope either returns all resources in the zone or no resources, |
| with an error code. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "items": [ # [Output Only] The list of errors of the managed instance group. |
| { |
| "error": { # [Output Only] Contents of the error. |
| "code": "A String", # [Output Only] Error code. |
| "message": "A String", # [Output Only] Error message. |
| }, |
| "instanceActionDetails": { # [Output Only] Details of the instance action that triggered this error. |
| # May be null, if the error was not caused by an action on an instance. |
| # This field is optional. |
| "action": "A String", # [Output Only] Action that managed instance group was executing on |
| # the instance when the error occurred. Possible values: |
| "instance": "A String", # [Output Only] The URL of the instance. |
| # The URL can be set even if the instance has not yet been created. |
| "version": { # [Output Only] Version this instance was created from, or was being |
| # created from, but the creation failed. Corresponds to one of the versions |
| # that were set on the Instance Group Manager resource at the time this |
| # instance was being created. |
| "instanceTemplate": "A String", # [Output Only] The intended template of the instance. This field is empty |
| # when current_action is one of { DELETING, ABANDONING }. |
| "name": "A String", # [Output Only] Name of the version. |
| }, |
| }, |
| "timestamp": "A String", # [Output Only] The time that this error occurred. |
| # This value is in RFC3339 text format. |
| }, |
| ], |
| "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for |
| # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for |
| # the query parameter pageToken in the next list request. |
| # Subsequent list requests will have their own nextPageToken to |
| # continue paging through the results. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="listErrors_next">listErrors_next()</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="listManagedInstances">listManagedInstances(project, region, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> |
| <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. The orderBy |
| query parameter is not supported. The `pageToken` query parameter is |
| supported only if the group's `listManagedInstancesResults` field is set |
| to `PAGINATED`. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, Name of the region scoping this request. (required) |
| instanceGroupManager: string, The name of the managed instance group. (required) |
| filter: string, A filter expression that filters resources listed in the response. Most |
| Compute resources support two types of filter expressions: |
| expressions that support regular expressions and expressions that follow |
| API improvement proposal AIP-160. |
| These two types of filter expressions cannot be mixed in one request. |
| |
| If you want to use AIP-160, your expression must specify the field name, an |
| operator, and the value that you want to use for filtering. The value |
| must be a string, a number, or a boolean. The operator |
| must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. |
| |
| For example, if you are filtering Compute Engine instances, you can |
| exclude instances named `example-instance` by specifying |
| `name != example-instance`. |
| |
| The `:*` comparison can be used to test whether a key has been defined. |
| For example, to find all objects with `owner` label use: |
| ``` |
| labels.owner:* |
| ``` |
| |
| You can also filter nested fields. For example, you could specify |
| `scheduling.automaticRestart = false` to include instances only |
| if they are not scheduled for automatic restarts. You can use filtering |
| on nested fields to filter based onresource labels. |
| |
| To filter on multiple expressions, provide each separate expression within |
| parentheses. For example: |
| ``` |
| (scheduling.automaticRestart = true) |
| (cpuPlatform = "Intel Skylake") |
| ``` |
| By default, each expression is an `AND` expression. However, you |
| can include `AND` and `OR` expressions explicitly. |
| For example: |
| ``` |
| (cpuPlatform = "Intel Skylake") OR |
| (cpuPlatform = "Intel Broadwell") AND |
| (scheduling.automaticRestart = true) |
| ``` |
| |
| If you want to use a regular expression, use the `eq` (equal) or `ne` |
| (not equal) operator against a single un-parenthesized expression with or |
| without quotes or against multiple parenthesized expressions. Examples: |
| |
| `fieldname eq unquoted literal` |
| `fieldname eq 'single quoted literal'` |
| `fieldname eq "double quoted literal"` |
| `(fieldname1 eq literal) (fieldname2 ne "literal")` |
| |
| The literal value is interpreted as a regular expression using GoogleRE2 library syntax. |
| The literal value must match the entire field. |
| |
| For example, to filter for instances that do not end with name "instance", |
| you would use `name ne .*instance`. |
| |
| You cannot combine constraints on multiple fields using regular |
| expressions. |
| 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. Acceptable values are |
| `0` to `500`, inclusive. (Default: `500`) |
| orderBy: string, Sorts list results by a certain order. By default, results |
| are returned in alphanumerical order based on the resource name. |
| |
| You 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. |
| |
| Currently, only sorting by `name` or |
| `creationTimestamp desc` is supported. |
| 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. |
| returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case |
| of failure. The default value is false. |
| |
| For example, when partial success behavior is enabled, aggregatedList for a |
| single zone scope either returns all resources in the zone or no resources, |
| with an error code. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "managedInstances": [ # A list of managed instances. |
| { # A Managed Instance resource. |
| "allInstancesConfig": { # [Output Only] Current all-instances configuration revision applied to this |
| # instance. |
| "revision": "A String", # [Output Only] Current all-instances configuration revision. |
| # This value is in RFC3339 text format. |
| }, |
| "currentAction": "A String", # [Output Only] The current action that the managed instance group has |
| # scheduled for the instance. Possible values: |
| # |
| # - NONE The instance is running, and the managed |
| # instance group does not have any scheduled actions for this instance. |
| # - 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. |
| # - 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'stargetSize value is decreased instead. |
| # - RECREATING The managed instance group is recreating |
| # this instance. |
| # - DELETING The managed instance group is permanently |
| # deleting this instance. |
| # - 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. |
| # - RESTARTING The managed instance group is restarting |
| # the instance. |
| # - 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. |
| # - VERIFYING The managed instance group has created the |
| # instance and it is in the process of being verified. |
| "id": "A String", # [Output only] The unique identifier for this resource. This field is empty |
| # when instance does not exist. |
| "instance": "A String", # [Output Only] The URL of the instance. The URL can exist even if the |
| # instance has not yet been created. |
| "instanceHealth": [ # [Output Only] Health state of the instance per health-check. |
| { |
| "detailedHealthState": "A String", # [Output Only] The current detailed instance health state. |
| "healthCheck": "A String", # [Output Only] The URL for the health check that verifies whether the |
| # instance is healthy. |
| }, |
| ], |
| "instanceStatus": "A String", # [Output Only] The status of the instance. This field is empty when |
| # the instance does not exist. |
| "lastAttempt": { # [Output Only] Information about the last attempt to create or delete |
| # the instance. |
| "errors": { # [Output Only] Encountered errors during the last attempt to create or |
| # delete the instance. |
| "errors": [ # [Output Only] The array of errors encountered while processing this |
| # operation. |
| { |
| "code": "A String", # [Output Only] The error type identifier for this error. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| }, |
| ], |
| }, |
| }, |
| "name": "A String", # [Output Only] The name of the instance. The name always exists even if the |
| # instance has not yet been created. |
| "preservedStateFromConfig": { # Preserved state for a given instance. # [Output Only] Preserved state applied from per-instance config |
| # for this instance. |
| "disks": { # Preserved disks defined for this instance. |
| # This map is keyed with the device names of the disks. |
| "a_key": { |
| "autoDelete": "A String", # These stateful disks will never be deleted during autohealing, |
| # update, instance recreate operations. This flag is used to configure |
| # if the disk should be deleted after it is no longer used by the group, |
| # e.g. when the given instance or the whole MIG is deleted. |
| # Note: disks attached in READ_ONLY mode cannot be |
| # auto-deleted. |
| "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the |
| # disk in READ_WRITE mode. |
| "source": "A String", # The URL of the disk resource that is stateful and should be attached |
| # to the VM instance. |
| }, |
| }, |
| "externalIPs": { # Preserved external IPs defined for this instance. |
| # This map is keyed with the name of the network interface. |
| "a_key": { |
| "autoDelete": "A String", # These stateful IPs will never be released during autohealing, |
| # update or VM instance recreate operations. |
| # This flag is used to configure if the IP reservation should be deleted |
| # after it is no longer used by the group, e.g. when the given instance |
| # or the whole group is deleted. |
| "ipAddress": { # Ip address representation |
| "address": "A String", # The URL of the reservation for this IP address. |
| "literal": "A String", # An IPv4 internal network address to assign to the instance for this |
| # network interface. |
| }, |
| }, |
| }, |
| "internalIPs": { # Preserved internal IPs defined for this instance. |
| # This map is keyed with the name of the network interface. |
| "a_key": { |
| "autoDelete": "A String", # These stateful IPs will never be released during autohealing, |
| # update or VM instance recreate operations. |
| # This flag is used to configure if the IP reservation should be deleted |
| # after it is no longer used by the group, e.g. when the given instance |
| # or the whole group is deleted. |
| "ipAddress": { # Ip address representation |
| "address": "A String", # The URL of the reservation for this IP address. |
| "literal": "A String", # An IPv4 internal network address to assign to the instance for this |
| # network interface. |
| }, |
| }, |
| }, |
| "metadata": { # Preserved metadata defined for this instance. |
| "a_key": "A String", |
| }, |
| }, |
| "preservedStateFromPolicy": { # Preserved state for a given instance. # [Output Only] Preserved state generated based on stateful policy |
| # for this instance. |
| "disks": { # Preserved disks defined for this instance. |
| # This map is keyed with the device names of the disks. |
| "a_key": { |
| "autoDelete": "A String", # These stateful disks will never be deleted during autohealing, |
| # update, instance recreate operations. This flag is used to configure |
| # if the disk should be deleted after it is no longer used by the group, |
| # e.g. when the given instance or the whole MIG is deleted. |
| # Note: disks attached in READ_ONLY mode cannot be |
| # auto-deleted. |
| "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the |
| # disk in READ_WRITE mode. |
| "source": "A String", # The URL of the disk resource that is stateful and should be attached |
| # to the VM instance. |
| }, |
| }, |
| "externalIPs": { # Preserved external IPs defined for this instance. |
| # This map is keyed with the name of the network interface. |
| "a_key": { |
| "autoDelete": "A String", # These stateful IPs will never be released during autohealing, |
| # update or VM instance recreate operations. |
| # This flag is used to configure if the IP reservation should be deleted |
| # after it is no longer used by the group, e.g. when the given instance |
| # or the whole group is deleted. |
| "ipAddress": { # Ip address representation |
| "address": "A String", # The URL of the reservation for this IP address. |
| "literal": "A String", # An IPv4 internal network address to assign to the instance for this |
| # network interface. |
| }, |
| }, |
| }, |
| "internalIPs": { # Preserved internal IPs defined for this instance. |
| # This map is keyed with the name of the network interface. |
| "a_key": { |
| "autoDelete": "A String", # These stateful IPs will never be released during autohealing, |
| # update or VM instance recreate operations. |
| # This flag is used to configure if the IP reservation should be deleted |
| # after it is no longer used by the group, e.g. when the given instance |
| # or the whole group is deleted. |
| "ipAddress": { # Ip address representation |
| "address": "A String", # The URL of the reservation for this IP address. |
| "literal": "A String", # An IPv4 internal network address to assign to the instance for this |
| # network interface. |
| }, |
| }, |
| }, |
| "metadata": { # Preserved metadata defined for this instance. |
| "a_key": "A String", |
| }, |
| }, |
| "propertiesFromFlexibilityPolicy": { # [Output Only] Instance properties selected for this instance resulting from |
| # InstanceFlexibilityPolicy. |
| "machineType": "A String", # The machine type to be used for this instance. |
| "provisioningModel": "A String", # The provisioning model to be used for this instance. |
| }, |
| "scheduling": { # [Output Only] Information about the termination timestamp of the instance, |
| # if applicable. |
| "terminationTimestamp": "A String", # [Output Only] The timestamp at which the managed instance will be |
| # terminated. This is in RFC3339 text format. |
| }, |
| "targetStatus": "A String", # [Output Only] The eventual status of the instance. The instance group |
| # manager will not be identified as stable till each managed instance reaches |
| # its targetStatus. |
| "version": { # [Output Only] Intended version of this instance. |
| "instanceTemplate": "A String", # [Output Only] The intended template of the instance. This field is empty |
| # when current_action is one of { DELETING, ABANDONING }. |
| "name": "A String", # [Output Only] Name of the version. |
| }, |
| }, |
| ], |
| "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for |
| # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for |
| # the query parameter pageToken in the next list request. |
| # Subsequent list requests will have their own nextPageToken to |
| # continue paging through the results. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="listManagedInstances_next">listManagedInstances_next()</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="listPerInstanceConfigs">listPerInstanceConfigs(project, region, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> |
| <pre>Lists all of the per-instance configurations defined for the managed |
| instance group. The orderBy query parameter is not supported. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, Name of the region scoping this request, should conform to RFC1035. (required) |
| instanceGroupManager: string, The name of the managed instance group. It should conform to RFC1035. (required) |
| filter: string, A filter expression that filters resources listed in the response. Most |
| Compute resources support two types of filter expressions: |
| expressions that support regular expressions and expressions that follow |
| API improvement proposal AIP-160. |
| These two types of filter expressions cannot be mixed in one request. |
| |
| If you want to use AIP-160, your expression must specify the field name, an |
| operator, and the value that you want to use for filtering. The value |
| must be a string, a number, or a boolean. The operator |
| must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. |
| |
| For example, if you are filtering Compute Engine instances, you can |
| exclude instances named `example-instance` by specifying |
| `name != example-instance`. |
| |
| The `:*` comparison can be used to test whether a key has been defined. |
| For example, to find all objects with `owner` label use: |
| ``` |
| labels.owner:* |
| ``` |
| |
| You can also filter nested fields. For example, you could specify |
| `scheduling.automaticRestart = false` to include instances only |
| if they are not scheduled for automatic restarts. You can use filtering |
| on nested fields to filter based onresource labels. |
| |
| To filter on multiple expressions, provide each separate expression within |
| parentheses. For example: |
| ``` |
| (scheduling.automaticRestart = true) |
| (cpuPlatform = "Intel Skylake") |
| ``` |
| By default, each expression is an `AND` expression. However, you |
| can include `AND` and `OR` expressions explicitly. |
| For example: |
| ``` |
| (cpuPlatform = "Intel Skylake") OR |
| (cpuPlatform = "Intel Broadwell") AND |
| (scheduling.automaticRestart = true) |
| ``` |
| |
| If you want to use a regular expression, use the `eq` (equal) or `ne` |
| (not equal) operator against a single un-parenthesized expression with or |
| without quotes or against multiple parenthesized expressions. Examples: |
| |
| `fieldname eq unquoted literal` |
| `fieldname eq 'single quoted literal'` |
| `fieldname eq "double quoted literal"` |
| `(fieldname1 eq literal) (fieldname2 ne "literal")` |
| |
| The literal value is interpreted as a regular expression using GoogleRE2 library syntax. |
| The literal value must match the entire field. |
| |
| For example, to filter for instances that do not end with name "instance", |
| you would use `name ne .*instance`. |
| |
| You cannot combine constraints on multiple fields using regular |
| expressions. |
| 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. Acceptable values are |
| `0` to `500`, inclusive. (Default: `500`) |
| orderBy: string, Sorts list results by a certain order. By default, results |
| are returned in alphanumerical order based on the resource name. |
| |
| You 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. |
| |
| Currently, only sorting by `name` or |
| `creationTimestamp desc` is supported. |
| 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. |
| returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case |
| of failure. The default value is false. |
| |
| For example, when partial success behavior is enabled, aggregatedList for a |
| single zone scope either returns all resources in the zone or no resources, |
| with an error code. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "items": [ # [Output Only] The list of PerInstanceConfig. |
| { |
| "fingerprint": "A String", # Fingerprint of this per-instance config. This field can be used in |
| # optimistic locking. It is ignored when inserting a per-instance |
| # config. An up-to-date fingerprint must be provided in order to update an |
| # existing per-instance configuration or the field needs to be unset. |
| "name": "A String", # The name of a per-instance configuration and its corresponding instance. |
| # Serves as a merge key during UpdatePerInstanceConfigs |
| # operations, that is, if a per-instance configuration with the same name |
| # exists then it will be updated, otherwise a new one will be created for the |
| # VM instance with the same name. An attempt to create a per-instance |
| # configuration for a VM instance that either doesn't exist or is not part |
| # of the group will result in an error. |
| "preservedState": { # Preserved state for a given instance. # The intended preserved state for the given instance. Does not contain |
| # preserved state generated from a stateful policy. |
| "disks": { # Preserved disks defined for this instance. |
| # This map is keyed with the device names of the disks. |
| "a_key": { |
| "autoDelete": "A String", # These stateful disks will never be deleted during autohealing, |
| # update, instance recreate operations. This flag is used to configure |
| # if the disk should be deleted after it is no longer used by the group, |
| # e.g. when the given instance or the whole MIG is deleted. |
| # Note: disks attached in READ_ONLY mode cannot be |
| # auto-deleted. |
| "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the |
| # disk in READ_WRITE mode. |
| "source": "A String", # The URL of the disk resource that is stateful and should be attached |
| # to the VM instance. |
| }, |
| }, |
| "externalIPs": { # Preserved external IPs defined for this instance. |
| # This map is keyed with the name of the network interface. |
| "a_key": { |
| "autoDelete": "A String", # These stateful IPs will never be released during autohealing, |
| # update or VM instance recreate operations. |
| # This flag is used to configure if the IP reservation should be deleted |
| # after it is no longer used by the group, e.g. when the given instance |
| # or the whole group is deleted. |
| "ipAddress": { # Ip address representation |
| "address": "A String", # The URL of the reservation for this IP address. |
| "literal": "A String", # An IPv4 internal network address to assign to the instance for this |
| # network interface. |
| }, |
| }, |
| }, |
| "internalIPs": { # Preserved internal IPs defined for this instance. |
| # This map is keyed with the name of the network interface. |
| "a_key": { |
| "autoDelete": "A String", # These stateful IPs will never be released during autohealing, |
| # update or VM instance recreate operations. |
| # This flag is used to configure if the IP reservation should be deleted |
| # after it is no longer used by the group, e.g. when the given instance |
| # or the whole group is deleted. |
| "ipAddress": { # Ip address representation |
| "address": "A String", # The URL of the reservation for this IP address. |
| "literal": "A String", # An IPv4 internal network address to assign to the instance for this |
| # network interface. |
| }, |
| }, |
| }, |
| "metadata": { # Preserved metadata defined for this instance. |
| "a_key": "A String", |
| }, |
| }, |
| "status": "A String", # The status of applying this per-instance configuration on the corresponding |
| # managed instance. |
| }, |
| ], |
| "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for |
| # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for |
| # the query parameter pageToken in the next list request. |
| # Subsequent list requests will have their own nextPageToken to |
| # continue paging through the results. |
| "warning": { # [Output Only] Informational warning message. |
| "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. |
| "data": [ # [Output Only] Metadata about this warning in key: |
| # value format. For example: |
| # |
| # "data": [ |
| # { |
| # "key": "scope", |
| # "value": "zones/us-east1-d" |
| # } |
| { |
| "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). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="listPerInstanceConfigs_next">listPerInstanceConfigs_next()</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="list_next">list_next()</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="patch">patch(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> |
| <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 patched |
| even if the instances in the group are still in the process of being |
| patched. You must separately verify the status of the individual instances |
| with the listmanagedinstances |
| method. This method supportsPATCH |
| semantics and uses theJSON merge |
| patch format and processing rules. |
| |
| If you update your group to specify a new template or instance |
| configuration, it's possible that your intended specification for each VM |
| in the group is different from the current state of that VM. To learn how |
| to apply an updated configuration to the VMs in a MIG, seeUpdating instances in |
| a MIG. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, Name of the region scoping this request. (required) |
| instanceGroupManager: string, The name of the instance group manager. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Represents a Managed Instance Group resource. |
| # |
| # An instance group is a collection of VM instances that you can manage as a |
| # single entity. For more information, readInstance groups. |
| # |
| # For zonal Managed Instance Group, use the instanceGroupManagers |
| # resource. |
| # |
| # For regional Managed Instance Group, use theregionInstanceGroupManagers resource. |
| "allInstancesConfig": { # Specifies configuration that overrides the instance template configuration |
| # for the group. |
| "properties": { # Represents the change that you want to make to the instance properties. # Properties to set on all instances in the group. |
| # |
| # You can add or modify properties using theinstanceGroupManagers.patch orregionInstanceGroupManagers.patch. After settingallInstancesConfig on the group, you must update the group's |
| # instances to apply the configuration. To apply the configuration, set the |
| # group's updatePolicy.type field to use proactive updates or |
| # use the applyUpdatesToInstances method. |
| "labels": { # The label key-value pairs that you want to patch onto the instance. |
| "a_key": "A String", |
| }, |
| "metadata": { # The metadata key-value pairs that you want to patch onto the instance. For |
| # more information, see Project and |
| # instance metadata. |
| "a_key": "A String", |
| }, |
| }, |
| }, |
| "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify |
| # only one value. |
| { |
| "healthCheck": "A String", # The URL for the health check that signals autohealing. |
| "initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to |
| # initialize and run its startup script. During a VM's initial delay |
| # period, the MIG ignores unsuccessful health checks because the VM might |
| # be in the startup process. This prevents the MIG from prematurely |
| # recreating a VM. If the health check receives a healthy response during |
| # the initial delay, it indicates that the startup process is complete and |
| # the VM is ready. The value of initial delay must be between 0 and 3600 |
| # seconds. The default value is 0. |
| }, |
| ], |
| "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of |
| # all VMs in a MIG. The maximum character length is 58 and the name must |
| # comply with RFC1035 format. |
| # |
| # When a VM is created in the group, the MIG appends a hyphen and a random |
| # four-character string to the base instance name. If you want the MIG to |
| # assign sequential numbers instead of a random string, then end the base |
| # instance name with a hyphen followed by one or more hash symbols. The hash |
| # symbols indicate the number of digits. For example, a base instance name of |
| # "vm-###" results in "vm-001" as a VM name. |
| # @pattern |
| # [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\\[[0-9]{1,10}\\])?)) |
| "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group inRFC3339 |
| # text format. |
| "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. |
| "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. |
| "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. |
| # |
| # If you have disabled creation retries, this field will not be populated; |
| # instead, the creatingWithoutRetries field will be populated. |
| "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. |
| "deleting": 42, # [Output Only] The number of instances in the managed instance group that |
| # are scheduled to be deleted or are currently being deleted. |
| "none": 42, # [Output Only] The number of instances in the managed instance group that |
| # are running and have no scheduled actions. |
| "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. |
| "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. |
| "restarting": 42, # [Output Only] The number of instances in the managed instance group that |
| # are scheduled to be restarted or are currently being restarted. |
| "resuming": 42, # [Output Only] The number of instances in the managed instance group that |
| # are scheduled to be resumed or are currently being resumed. |
| "starting": 42, # [Output Only] The number of instances in the managed instance group that |
| # are scheduled to be started or are currently being started. |
| "stopping": 42, # [Output Only] The number of instances in the managed instance group that |
| # are scheduled to be stopped or are currently being stopped. |
| "suspending": 42, # [Output Only] The number of instances in the managed instance group that |
| # are scheduled to be suspended or are currently being suspended. |
| "verifying": 42, # [Output Only] The number of instances in the managed instance group that |
| # are being verified. See the managedInstances[].currentAction |
| # property in the listManagedInstances method documentation. |
| }, |
| "description": "A String", # An optional description of this resource. |
| "distributionPolicy": { # Policy specifying the intended distribution of managed instances across |
| # zones in a regional managed instance group. |
| "targetShape": "A String", # The distribution shape to which the group converges either proactively or |
| # on resize events (depending on the value set inupdatePolicy.instanceRedistributionType). |
| "zones": [ # Zones where the regional managed instance group will create and manage |
| # its instances. |
| { |
| "zone": "A String", # The URL of thezone. |
| # The zone must exist in the region where the managed instance group is |
| # located. |
| }, |
| ], |
| }, |
| "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported,NO_FAILOVER. The default is NO_FAILOVER. |
| "fingerprint": "A String", # Fingerprint of this resource. This field may be used in optimistic locking. |
| # It will be ignored when inserting an InstanceGroupManager. An up-to-date |
| # fingerprint must be provided in order to update the InstanceGroupManager, |
| # otherwise the request will fail with error412 conditionNotMet. |
| # |
| # To see the latest fingerprint, make a get() request to |
| # retrieve an InstanceGroupManager. |
| "id": "A String", # [Output Only] A unique identifier for this resource type. The server |
| # generates this identifier. |
| "instanceFlexibilityPolicy": { # Instance flexibility allowing MIG to create VMs from multiple |
| # types of machines. |
| # Instance flexibility configuration on MIG overrides instance |
| # template configuration. |
| "instanceSelections": { # Named instance selections configuring properties that the group will use |
| # when creating new VMs. |
| "a_key": { |
| "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16". |
| "A String", |
| ], |
| "rank": 42, # Preference of this instance selection. Lower number means higher |
| # preference. MIG will first try to create a VM based on the machine-type |
| # with lowest rank and fallback to next rank based on availability. |
| # Machine types and instance selections with the same rank have the same |
| # preference. |
| }, |
| }, |
| "provisioningModelMix": { # Provisioning model configuration used by this managed instance group to |
| # create instances. |
| "standardCapacityBase": 42, # The base capacity that will always use Standard VMs to avoid risk of |
| # more preemption than the minimum capacity user needs. MIG will create |
| # only Standard VMs until it reaches standard_capacity_base and only |
| # then will start using standard_capacity_percent_above_base to mix Spot |
| # with Standard VMs. |
| "standardCapacityPercentAboveBase": 42, # The percentage of target capacity that should use Standard VM. The |
| # remaining percentage will use Spot VMs. The percentage applies only to |
| # the capacity above standard_capacity_base. |
| }, |
| }, |
| "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource. |
| "instanceLifecyclePolicy": { # The repair policy for this managed instance group. |
| "defaultActionOnFailure": "A String", # The action that a MIG performs on a failed VM. If the value of the onFailedHealthCheck field |
| # is `DEFAULT_ACTION`, then the same action also applies to the VMs on which your application |
| # fails a health check. Valid values are - REPAIR (default): MIG automatically repairs a failed |
| # VM by recreating it. For more information, seeAbout repairing |
| # VMs in a MIG. - DO_NOTHING: MIG does not repair a failed VM. |
| "forceUpdateOnRepair": "A String", # A bit indicating whether to forcefully apply the group's latest |
| # configuration when repairing a VM. Valid options are: |
| # |
| # |
| # |
| # - NO (default): If configuration updates are available, they are not |
| # forcefully applied during repair. Instead, configuration updates are |
| # applied according to the group's update policy. |
| # |
| # - YES: If configuration updates are available, they are applied |
| # during repair. |
| "onFailedHealthCheck": "A String", # The action that a MIG performs on an unhealthy VM. A VM is marked as |
| # unhealthy when the application running on that VM fails a health check. |
| # Valid values are: |
| # |
| # - DEFAULT_ACTION (default): MIG uses the same action |
| # configured for instanceLifecyclePolicy.defaultActionOnFailure field. |
| # - REPAIR: MIG automatically repairs an unhealthy VM by |
| # recreating it. |
| # - DO_NOTHING: MIG doesn't repair an unhealthy VM. |
| # For more information, see |
| # About repairing VMs in a MIG. |
| "onRepair": { # Configuration for VM repairs in the MIG. # Configuration for VM repairs in the MIG. |
| "allowChangingZone": "A String", # Specifies whether the MIG can change a VM's zone during a repair. |
| # Valid values are: |
| # |
| # - NO (default): MIG cannot change a VM's zone during a |
| # repair. |
| # - YES: MIG can select a different zone for the VM during |
| # a repair. |
| }, |
| }, |
| "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. The templates for existing instances in the |
| # group do not change unless you run recreateInstances, runapplyUpdatesToInstances, or set the group'supdatePolicy.type to PROACTIVE. |
| "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is alwayscompute#instanceGroupManager for managed instance groups. |
| "listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for |
| # this managed instance group. |
| "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to. |
| "name": "A String", # The name of the managed instance group. The name must be 1-63 characters |
| # long, and comply withRFC1035. |
| "namedPorts": [ # [Output Only] Named ports configured on the Instance Groups complementary |
| # to this Instance Group Manager. |
| { # The named port. For example: <"http", 80>. |
| "name": "A String", # The name for this named port. |
| # The name must be 1-63 characters long, and comply withRFC1035. |
| "port": 42, # The port number, which can be a value between 1 and 65535. |
| }, |
| ], |
| "params": { # Input only additional params for instance group manager creation. # Input only. Additional params passed with the request, but not persisted |
| # as part of resource payload. |
| "resourceManagerTags": { # Resource manager tags to bind to the managed instance group. The tags are |
| # key-value pairs. Keys must be in the format tagKeys/123 and values in the |
| # format tagValues/456. For more information, seeManage tags |
| # for resources. |
| "a_key": "A String", |
| }, |
| }, |
| "region": "A String", # [Output Only] The URL of theregion |
| # where the managed instance group resides (for regional resources). |
| "resourcePolicies": { # Resource policies for this managed instance group. |
| "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed |
| # instance group. |
| # It can be a full or partial URL. For example, the following are |
| # all valid URLs to a workload policy: |
| # |
| # |
| # - https://www.googleapis.com/compute/v1/projects/project/regions/region/resourcePolicies/resourcePolicy |
| # - projects/project/regions/region/resourcePolicies/resourcePolicy |
| # - regions/region/resourcePolicies/resourcePolicy |
| }, |
| "satisfiesPzi": True or False, # [Output Only] Reserved for future use. |
| "satisfiesPzs": True or False, # [Output Only] Reserved for future use. |
| "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines |
| # this URL. |
| "serviceAccount": "A String", # The service account to be used as credentials for all operations performed |
| # by the managed instance group on instances. The service accounts needs all |
| # permissions required to create and delete instances. |
| # By default, the service account |
| # {projectNumber}@cloudservices.gserviceaccount.com is used. |
| "standbyPolicy": { # Standby policy for stopped and suspended instances. |
| "initialDelaySec": 42, # Specifies the number of seconds that the MIG should wait to suspend or |
| # stop a VM after that VM was created. The initial delay gives the |
| # initialization script the time to prepare your VM for a quick scale out. |
| # The value of initial delay must be between 0 and 3600 seconds. The |
| # default value is 0. |
| "mode": "A String", # Defines how a MIG resumes or starts VMs from a standby pool when the |
| # group scales out. The default mode is `MANUAL`. |
| }, |
| "statefulPolicy": { # Stateful configuration for this Instanced Group Manager |
| "preservedState": { # Configuration of preserved resources. |
| "disks": { # Disks created on the instances that will be preserved on instance |
| # delete, update, etc. This map is keyed with the device names of |
| # the disks. |
| "a_key": { |
| "autoDelete": "A String", # These stateful disks will never be deleted during autohealing, |
| # update or VM instance recreate operations. |
| # This flag is used to configure if the disk should be deleted after it |
| # is no longer used by the group, e.g. when the given instance or |
| # the whole group is deleted. Note: disks attached inREAD_ONLY mode cannot be auto-deleted. |
| }, |
| }, |
| "externalIPs": { # External network IPs assigned to the instances that will be preserved on |
| # instance delete, update, etc. This map is keyed with the network |
| # interface name. |
| "a_key": { |
| "autoDelete": "A String", # These stateful IPs will never be released during autohealing, |
| # update or VM instance recreate operations. |
| # This flag is used to configure if the IP reservation should be deleted |
| # after it is no longer used by the group, e.g. when the given instance |
| # or the whole group is deleted. |
| }, |
| }, |
| "internalIPs": { # Internal network IPs assigned to the instances that will be preserved on |
| # instance delete, update, etc. This map is keyed with the network |
| # interface name. |
| "a_key": { |
| "autoDelete": "A String", # These stateful IPs will never be released during autohealing, |
| # update or VM instance recreate operations. |
| # This flag is used to configure if the IP reservation should be deleted |
| # after it is no longer used by the group, e.g. when the given instance |
| # or the whole group is deleted. |
| }, |
| }, |
| }, |
| }, |
| "status": { # [Output Only] The status of this managed instance group. |
| "allInstancesConfig": { # [Output only] Status of all-instances configuration on the group. |
| "currentRevision": "A String", # [Output Only] Current all-instances configuration revision. |
| # This value is in RFC3339 text format. |
| "effective": True or False, # [Output Only] A bit indicating whether this configuration has |
| # been applied to all managed instances in the group. |
| }, |
| "autoscaler": "A String", # [Output Only] The URL of theAutoscaler |
| # that targets this instance group manager. |
| "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # [Output Only] The status of bulk instance operation. |
| # targetSizePolicy.mode is set to BULK. |
| "inProgress": True or False, # [Output Only] Informs whether bulk instance operation is in progress. |
| "lastProgressCheck": { # [Output Only] Information from the last progress check of bulk instance |
| # operation. |
| "error": { # [Output Only] Errors encountered during bulk instance operation. |
| "errors": [ # [Output Only] The array of errors encountered while processing this |
| # operation. |
| { |
| "code": "A String", # [Output Only] The error type identifier for this error. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| }, |
| ], |
| }, |
| "timestamp": "A String", # [Output Only] Timestamp of the last progress check of bulk instance |
| # operation. Timestamp is in RFC3339 text format. |
| }, |
| }, |
| "isStable": True or False, # [Output Only] A bit indicating whether the managed instance group is in a |
| # stable state. A stable state means that: none of the instances in the |
| # managed instance group is currently undergoing any type of change (for |
| # example, creation, restart, or deletion); no future changes are scheduled |
| # for instances in the managed instance group; and the managed instance |
| # group itself is not being modified. |
| "stateful": { # [Output Only] Stateful status of the given Instance Group Manager. |
| "hasStatefulConfig": True or False, # [Output Only] A bit indicating whether the managed instance group |
| # has stateful configuration, that is, if you have configured any items |
| # in a stateful policy or in per-instance configs. |
| # The group might report that it has no stateful configuration even when |
| # there is still some preserved state on a managed instance, for example, |
| # if you have deleted all PICs but not yet applied those deletions. |
| "isStateful": True or False, # [Output Only] A bit indicating whether the managed instance group |
| # has stateful configuration, that is, if you have configured any items |
| # in a stateful policy or in per-instance configs. |
| # The group might report that it has no stateful configuration even when |
| # there is still some preserved state on a managed instance, for example, |
| # if you have deleted all PICs but not yet applied those deletions. This |
| # field is deprecated in favor of has_stateful_config. |
| "perInstanceConfigs": { # [Output Only] Status of per-instance configurations on the instances. |
| "allEffective": True or False, # A bit indicating if all of the group's per-instance configurations |
| # (listed in the output of a listPerInstanceConfigs API call) have |
| # status EFFECTIVE or there are no per-instance-configs. |
| }, |
| }, |
| "versionTarget": { # [Output Only] A status of consistency of Instances' versions with their |
| # target version specified by version field on Instance Group |
| # Manager. |
| "isReached": True or False, # [Output Only] A bit indicating whether version target has been reached |
| # in this managed instance group, i.e. all instances are in their target |
| # version. Instances' target version are specified byversion field on Instance Group Manager. |
| }, |
| }, |
| "targetPools": [ # The URLs for all TargetPool resources to which instances in theinstanceGroup field are added. The target pools automatically |
| # apply to all of the instances in the managed instance group. |
| "A String", |
| ], |
| "targetSize": 42, # The target number of running instances for this managed instance group. |
| # You can reduce this number by using the instanceGroupManager |
| # deleteInstances or abandonInstances methods. Resizing the group also |
| # changes this number. |
| "targetSizePolicy": { # The policy that specifies how the MIG creates its VMs to achieve the target |
| # size. |
| "mode": "A String", # The mode of target size policy based on which the MIG creates its VMs |
| # individually or all at once. |
| }, |
| "targetStoppedSize": 42, # The target number of stopped instances for this managed instance group. |
| # This number changes when you: |
| # |
| # - Stop instance using the stopInstances |
| # method or start instances using the startInstances |
| # method. |
| # - Manually change the targetStoppedSize using the update |
| # method. |
| "targetSuspendedSize": 42, # The target number of suspended instances for this managed instance group. |
| # This number changes when you: |
| # |
| # - Suspend instance using the suspendInstances |
| # method or resume instances using the resumeInstances |
| # method. |
| # - Manually change the targetSuspendedSize using the update |
| # method. |
| "updatePolicy": { # The update policy for this managed instance group. |
| "instanceRedistributionType": "A String", # The |
| # instance redistribution policy for regional managed instance groups. |
| # Valid values are: |
| # |
| # - PROACTIVE (default): The group attempts to maintain an |
| # even distribution of VM instances across zones in the region. |
| # - NONE: For non-autoscaled groups, proactive |
| # redistribution is disabled. |
| "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be created above the specifiedtargetSize during the update process. This value can be |
| # either a fixed number or, if the group has 10 or more instances, a |
| # percentage. If you set a percentage, the number of instances is rounded |
| # if necessary. The default value for maxSurge is a fixed |
| # value equal to the number of zones in which the managed instance group |
| # operates. |
| # |
| # At least one of either maxSurge ormaxUnavailable must be greater than 0. Learn more about maxSurge. |
| "calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the |
| # specific mode. |
| # |
| # |
| # |
| # - If the value is fixed, then the calculated |
| # value is equal to the fixed value. |
| # - If the value is a percent, then the |
| # calculated |
| # value is percent/100 * targetSize. For example, |
| # the calculated value of a 80% of a managed instance group |
| # with 150 instances would be (80/100 * 150) = 120 VM instances. If there |
| # is a remainder, the number is rounded. |
| "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. |
| "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For |
| # example, specify 80 for 80%. |
| }, |
| "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be unavailable during the update |
| # process. An instance is considered available if all of the following |
| # conditions are satisfied: |
| # |
| # |
| # |
| # - The instance's status is |
| # RUNNING. |
| # - If there is a health |
| # check on the instance group, the instance's health check status |
| # must be HEALTHY at least once. If there is no health check |
| # on the group, then the instance only needs to have a status of |
| # RUNNING to be considered available. |
| # |
| # |
| # This value can be either a fixed number or, if the group has 10 or more |
| # instances, a percentage. If you set a percentage, the number of instances |
| # is rounded if necessary. The default value formaxUnavailable is a fixed value equal to the number of zones |
| # in which the managed instance group operates. |
| # |
| # At least one of either maxSurge ormaxUnavailable must be greater than 0. Learn more about maxUnavailable. |
| "calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the |
| # specific mode. |
| # |
| # |
| # |
| # - If the value is fixed, then the calculated |
| # value is equal to the fixed value. |
| # - If the value is a percent, then the |
| # calculated |
| # value is percent/100 * targetSize. For example, |
| # the calculated value of a 80% of a managed instance group |
| # with 150 instances would be (80/100 * 150) = 120 VM instances. If there |
| # is a remainder, the number is rounded. |
| "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. |
| "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For |
| # example, specify 80 for 80%. |
| }, |
| "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance |
| # becomes available. This value must be from range [0, 3600]. |
| "minimalAction": "A String", # Minimal action to be taken on an instance. Use this option to minimize |
| # disruption as much as possible or to apply a more disruptive action than |
| # is necessary. |
| # |
| # - To limit disruption as much as possible, set the minimal action toREFRESH. If your update requires a more disruptive action, |
| # Compute Engine performs the necessary action to execute the update. |
| # - To apply a more disruptive action than is strictly necessary, set the |
| # minimal action to RESTART or REPLACE. For |
| # example, Compute Engine does not need to restart a VM to change its |
| # metadata. But if your application reads instance metadata only when a VM |
| # is restarted, you can set the minimal action to RESTART in |
| # order to pick up metadata changes. |
| "mostDisruptiveAllowedAction": "A String", # Most disruptive action that is allowed to be taken on an instance. |
| # You can specify either NONE to forbid any actions,REFRESH to avoid restarting the VM and to limit disruption |
| # as much as possible. RESTART to allow actions that can be |
| # applied without instance replacing or REPLACE to allow all |
| # possible actions. If the Updater determines that the minimal update |
| # action needed is more disruptive than most disruptive allowed action you |
| # specify it will not perform the update at all. |
| "replacementMethod": "A String", # What action should be used to replace instances. |
| # See minimal_action.REPLACE |
| "type": "A String", # The type |
| # of update process. You can specify either PROACTIVE so |
| # that the MIG automatically updates VMs to the latest configurations orOPPORTUNISTIC so that you can select the VMs that you want |
| # to update. |
| }, |
| "versions": [ # Specifies the instance templates used by this managed instance group to |
| # create instances. |
| # |
| # Each version is defined by an instanceTemplate and aname. Every version can appear at most once per instance |
| # group. This field overrides the top-level instanceTemplate |
| # field. Read more about therelationships |
| # between these fields. Exactly one version must leave thetargetSize field unset. That version will be applied to all |
| # remaining instances. For more information, read aboutcanary |
| # updates. |
| { |
| "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed |
| # instance group. The group uses this template to create new instances in |
| # the managed instance group until the `targetSize` for this version is |
| # reached. The templates for existing instances in the group do not change |
| # unless you run recreateInstances, runapplyUpdatesToInstances, or set the group'supdatePolicy.type to PROACTIVE; in those cases, |
| # existing instances are updated until the `targetSize` for this version is |
| # reached. |
| "name": "A String", # Name of the version. Unique among all versions in the scope of this |
| # managed instance group. |
| "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Specifies the intended number of instances to be created from theinstanceTemplate. The final number of instances created |
| # from the template will be equal to: |
| # |
| # |
| # - If expressed as a fixed number, the minimum of either |
| # targetSize.fixed or |
| # instanceGroupManager.targetSize is used. |
| # - if expressed as a percent, the targetSize |
| # would be (targetSize.percent/100 * |
| # InstanceGroupManager.targetSize) If there is a remainder, the |
| # number is rounded. |
| # |
| # If unset, this version will update any remaining instances not |
| # updated by another version. ReadStarting |
| # a canary update for more information. |
| "calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the |
| # specific mode. |
| # |
| # |
| # |
| # - If the value is fixed, then the calculated |
| # value is equal to the fixed value. |
| # - If the value is a percent, then the |
| # calculated |
| # value is percent/100 * targetSize. For example, |
| # the calculated value of a 80% of a managed instance group |
| # with 150 instances would be (80/100 * 150) = 120 VM instances. If there |
| # is a remainder, the number is rounded. |
| "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. |
| "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For |
| # example, specify 80 for 80%. |
| }, |
| }, |
| ], |
| "zone": "A String", # [Output Only] The URL of azone |
| # where the managed instance group is located (for zonal resources). |
| } |
| |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so |
| that if you must retry your request, the server will know to ignore the |
| request if it has already been completed. |
| |
| For example, consider a situation where you make an initial request and |
| the request times out. If you make the request again with the same |
| request ID, the server can check if original operation with the same |
| request ID was received, and if so, will ignore the second request. This |
| prevents clients from accidentally creating duplicate commitments. |
| |
| The request ID must be |
| a valid UUID with the exception that zero UUID is not supported |
| (00000000-0000-0000-0000-000000000000). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/beta/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/beta/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # |
| # - For global operations, use the `globalOperations` |
| # resource. |
| # - For regional operations, use the |
| # `regionOperations` resource. |
| # - For zonal operations, use |
| # the `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. |
| # Not present otherwise. |
| "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| "description": "A String", # [Output Only] A textual description of the operation, which is |
| # set when the operation is created. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 |
| # text format. |
| "error": { # [Output Only] If errors are generated during processing of the operation, |
| # this field will be populated. |
| "errors": [ # [Output Only] The array of errors encountered while processing this |
| # operation. |
| { |
| "code": "A String", # [Output Only] The error type identifier for this error. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| }, |
| ], |
| }, |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error |
| # message that was returned, such as `NOT FOUND`. |
| "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. |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is |
| # defined by the server. |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. |
| # This value is inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, |
| # `update`, or `delete`, and so on. |
| "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. |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only |
| # applicable when performing regional operations. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # text format. |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the |
| # following: |
| # `PENDING`, `RUNNING`, or `DONE`. |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the |
| # operation. |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation |
| # of the target resource. |
| "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For |
| # operations related to creating a snapshot, this points to the disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `[email protected]` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the |
| # operation, this field will be populated. |
| { |
| "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. |
| "data": [ # [Output Only] Metadata about this warning in key: |
| # value format. For example: |
| # |
| # "data": [ |
| # { |
| # "key": "scope", |
| # "value": "zones/us-east1-d" |
| # } |
| { |
| "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). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| ], |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only |
| # applicable when performing per-zone operations. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="patchPerInstanceConfigs">patchPerInstanceConfigs(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> |
| <pre>Inserts or patches per-instance configurations for the managed instance |
| group. perInstanceConfig.name serves as a key used to |
| distinguish whether to perform insert or patch. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, Name of the region scoping this request, should conform to RFC1035. (required) |
| instanceGroupManager: string, The name of the managed instance group. |
| It should conform to RFC1035. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # RegionInstanceGroupManagers.patchPerInstanceConfigs |
| "perInstanceConfigs": [ # The list of per-instance configurations to insert or patch on this managed |
| # instance group. |
| { |
| "fingerprint": "A String", # Fingerprint of this per-instance config. This field can be used in |
| # optimistic locking. It is ignored when inserting a per-instance |
| # config. An up-to-date fingerprint must be provided in order to update an |
| # existing per-instance configuration or the field needs to be unset. |
| "name": "A String", # The name of a per-instance configuration and its corresponding instance. |
| # Serves as a merge key during UpdatePerInstanceConfigs |
| # operations, that is, if a per-instance configuration with the same name |
| # exists then it will be updated, otherwise a new one will be created for the |
| # VM instance with the same name. An attempt to create a per-instance |
| # configuration for a VM instance that either doesn't exist or is not part |
| # of the group will result in an error. |
| "preservedState": { # Preserved state for a given instance. # The intended preserved state for the given instance. Does not contain |
| # preserved state generated from a stateful policy. |
| "disks": { # Preserved disks defined for this instance. |
| # This map is keyed with the device names of the disks. |
| "a_key": { |
| "autoDelete": "A String", # These stateful disks will never be deleted during autohealing, |
| # update, instance recreate operations. This flag is used to configure |
| # if the disk should be deleted after it is no longer used by the group, |
| # e.g. when the given instance or the whole MIG is deleted. |
| # Note: disks attached in READ_ONLY mode cannot be |
| # auto-deleted. |
| "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the |
| # disk in READ_WRITE mode. |
| "source": "A String", # The URL of the disk resource that is stateful and should be attached |
| # to the VM instance. |
| }, |
| }, |
| "externalIPs": { # Preserved external IPs defined for this instance. |
| # This map is keyed with the name of the network interface. |
| "a_key": { |
| "autoDelete": "A String", # These stateful IPs will never be released during autohealing, |
| # update or VM instance recreate operations. |
| # This flag is used to configure if the IP reservation should be deleted |
| # after it is no longer used by the group, e.g. when the given instance |
| # or the whole group is deleted. |
| "ipAddress": { # Ip address representation |
| "address": "A String", # The URL of the reservation for this IP address. |
| "literal": "A String", # An IPv4 internal network address to assign to the instance for this |
| # network interface. |
| }, |
| }, |
| }, |
| "internalIPs": { # Preserved internal IPs defined for this instance. |
| # This map is keyed with the name of the network interface. |
| "a_key": { |
| "autoDelete": "A String", # These stateful IPs will never be released during autohealing, |
| # update or VM instance recreate operations. |
| # This flag is used to configure if the IP reservation should be deleted |
| # after it is no longer used by the group, e.g. when the given instance |
| # or the whole group is deleted. |
| "ipAddress": { # Ip address representation |
| "address": "A String", # The URL of the reservation for this IP address. |
| "literal": "A String", # An IPv4 internal network address to assign to the instance for this |
| # network interface. |
| }, |
| }, |
| }, |
| "metadata": { # Preserved metadata defined for this instance. |
| "a_key": "A String", |
| }, |
| }, |
| "status": "A String", # The status of applying this per-instance configuration on the corresponding |
| # managed instance. |
| }, |
| ], |
| } |
| |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so |
| that if you must retry your request, the server will know to ignore the |
| request if it has already been completed. |
| |
| For example, consider a situation where you make an initial request and |
| the request times out. If you make the request again with the same |
| request ID, the server can check if original operation with the same |
| request ID was received, and if so, will ignore the second request. This |
| prevents clients from accidentally creating duplicate commitments. |
| |
| The request ID must be |
| a valid UUID with the exception that zero UUID is not supported |
| (00000000-0000-0000-0000-000000000000). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/beta/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/beta/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # |
| # - For global operations, use the `globalOperations` |
| # resource. |
| # - For regional operations, use the |
| # `regionOperations` resource. |
| # - For zonal operations, use |
| # the `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. |
| # Not present otherwise. |
| "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| "description": "A String", # [Output Only] A textual description of the operation, which is |
| # set when the operation is created. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 |
| # text format. |
| "error": { # [Output Only] If errors are generated during processing of the operation, |
| # this field will be populated. |
| "errors": [ # [Output Only] The array of errors encountered while processing this |
| # operation. |
| { |
| "code": "A String", # [Output Only] The error type identifier for this error. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| }, |
| ], |
| }, |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error |
| # message that was returned, such as `NOT FOUND`. |
| "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. |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is |
| # defined by the server. |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. |
| # This value is inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, |
| # `update`, or `delete`, and so on. |
| "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. |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only |
| # applicable when performing regional operations. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # text format. |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the |
| # following: |
| # `PENDING`, `RUNNING`, or `DONE`. |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the |
| # operation. |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation |
| # of the target resource. |
| "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For |
| # operations related to creating a snapshot, this points to the disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `[email protected]` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the |
| # operation, this field will be populated. |
| { |
| "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. |
| "data": [ # [Output Only] Metadata about this warning in key: |
| # value format. For example: |
| # |
| # "data": [ |
| # { |
| # "key": "scope", |
| # "value": "zones/us-east1-d" |
| # } |
| { |
| "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). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| ], |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only |
| # applicable when performing per-zone operations. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="recreateInstances">recreateInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> |
| <pre>Flags the specified VM instances in the managed instance group to be |
| immediately recreated. Each instance is recreated using the group's current |
| configuration. This operation is marked as DONE when the flag |
| is set even if the instances have not yet been recreated. You must |
| separately verify the status of each instance by checking itscurrentAction field; for more information, see Checking |
| the status of managed instances. |
| |
| If the group is part of a backend |
| service that has enabled |
| connection draining, it can take up to 60 seconds after the connection |
| draining duration has elapsed before the VM instance is removed or deleted. |
| |
| You can specify a maximum of 1000 instances with this method per request. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, Name of the region scoping this request. (required) |
| instanceGroupManager: string, Name of the managed instance group. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "instances": [ # The URLs of one or more instances to recreate. This can be a full URL or |
| # a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. |
| "A String", |
| ], |
| } |
| |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so |
| that if you must retry your request, the server will know to ignore the |
| request if it has already been completed. |
| |
| For example, consider a situation where you make an initial request and |
| the request times out. If you make the request again with the same |
| request ID, the server can check if original operation with the same |
| request ID was received, and if so, will ignore the second request. This |
| prevents clients from accidentally creating duplicate commitments. |
| |
| The request ID must be |
| a valid UUID with the exception that zero UUID is not supported |
| (00000000-0000-0000-0000-000000000000). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/beta/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/beta/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # |
| # - For global operations, use the `globalOperations` |
| # resource. |
| # - For regional operations, use the |
| # `regionOperations` resource. |
| # - For zonal operations, use |
| # the `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. |
| # Not present otherwise. |
| "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| "description": "A String", # [Output Only] A textual description of the operation, which is |
| # set when the operation is created. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 |
| # text format. |
| "error": { # [Output Only] If errors are generated during processing of the operation, |
| # this field will be populated. |
| "errors": [ # [Output Only] The array of errors encountered while processing this |
| # operation. |
| { |
| "code": "A String", # [Output Only] The error type identifier for this error. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| }, |
| ], |
| }, |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error |
| # message that was returned, such as `NOT FOUND`. |
| "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. |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is |
| # defined by the server. |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. |
| # This value is inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, |
| # `update`, or `delete`, and so on. |
| "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. |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only |
| # applicable when performing regional operations. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # text format. |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the |
| # following: |
| # `PENDING`, `RUNNING`, or `DONE`. |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the |
| # operation. |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation |
| # of the target resource. |
| "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For |
| # operations related to creating a snapshot, this points to the disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `[email protected]` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the |
| # operation, this field will be populated. |
| { |
| "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. |
| "data": [ # [Output Only] Metadata about this warning in key: |
| # value format. For example: |
| # |
| # "data": [ |
| # { |
| # "key": "scope", |
| # "value": "zones/us-east1-d" |
| # } |
| { |
| "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). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| ], |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only |
| # applicable when performing per-zone operations. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="resize">resize(project, region, instanceGroupManager, size, requestId=None, x__xgafv=None)</code> |
| <pre>Changes the intended size of the managed instance group. If you increase |
| the size, the group creates new instances using the current instance |
| template. If you decrease the size, the group deletes one or more |
| instances. |
| |
| The resize operation is marked DONE if theresize request is successful. The underlying actions take |
| additional time. You must separately verify the status of thecreating or deleting actions with thelistmanagedinstances |
| method. |
| |
| If the group is part of a backend |
| service that has enabled |
| connection draining, it can take up to 60 seconds after the connection |
| draining duration has elapsed before the VM instance is removed or deleted. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, Name of the region scoping this request. (required) |
| instanceGroupManager: string, Name of the managed instance group. (required) |
| size: integer, Number of instances that should exist in this instance group |
| manager. (required) |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so |
| that if you must retry your request, the server will know to ignore the |
| request if it has already been completed. |
| |
| For example, consider a situation where you make an initial request and |
| the request times out. If you make the request again with the same |
| request ID, the server can check if original operation with the same |
| request ID was received, and if so, will ignore the second request. This |
| prevents clients from accidentally creating duplicate commitments. |
| |
| The request ID must be |
| a valid UUID with the exception that zero UUID is not supported |
| (00000000-0000-0000-0000-000000000000). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/beta/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/beta/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # |
| # - For global operations, use the `globalOperations` |
| # resource. |
| # - For regional operations, use the |
| # `regionOperations` resource. |
| # - For zonal operations, use |
| # the `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. |
| # Not present otherwise. |
| "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| "description": "A String", # [Output Only] A textual description of the operation, which is |
| # set when the operation is created. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 |
| # text format. |
| "error": { # [Output Only] If errors are generated during processing of the operation, |
| # this field will be populated. |
| "errors": [ # [Output Only] The array of errors encountered while processing this |
| # operation. |
| { |
| "code": "A String", # [Output Only] The error type identifier for this error. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| }, |
| ], |
| }, |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error |
| # message that was returned, such as `NOT FOUND`. |
| "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. |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is |
| # defined by the server. |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. |
| # This value is inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, |
| # `update`, or `delete`, and so on. |
| "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. |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only |
| # applicable when performing regional operations. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # text format. |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the |
| # following: |
| # `PENDING`, `RUNNING`, or `DONE`. |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the |
| # operation. |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation |
| # of the target resource. |
| "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For |
| # operations related to creating a snapshot, this points to the disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `[email protected]` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the |
| # operation, this field will be populated. |
| { |
| "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. |
| "data": [ # [Output Only] Metadata about this warning in key: |
| # value format. For example: |
| # |
| # "data": [ |
| # { |
| # "key": "scope", |
| # "value": "zones/us-east1-d" |
| # } |
| { |
| "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). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| ], |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only |
| # applicable when performing per-zone operations. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="resizeAdvanced">resizeAdvanced(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> |
| <pre>Resizes the regional managed instance group with advanced configuration |
| options like disabling creation retries. This is an extended version of theresize method. |
| |
| If you increase the size, the group creates new instances using the current |
| instance template. If you decrease the size, the group deletes one or more |
| instances. |
| |
| The resize operation is marked DONE if theresize request is successful. The underlying actions take |
| additional time. You must separately verify the status of thecreating or deleting actions with the get |
| orlistmanagedinstances |
| method. |
| |
| If the group is part of a backend |
| service that has enabled |
| connection draining, it can take up to 60 seconds after the connection |
| draining duration has elapsed before the VM instance is removed or deleted. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, Name of the region scoping this request. |
| It must be a string that meets the requirements in RFC1035. (required) |
| instanceGroupManager: string, The name of the managed instance group. |
| It must be a string that meets the requirements in RFC1035. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "noCreationRetries": True or False, # If this flag is true, the managed instance group attempts to create all |
| # instances initiated by this resize request only once. If there is an error |
| # during creation, the managed instance group does not retry create this |
| # instance, and we will decrease the targetSize of the request |
| # instead. If the flag is false, the group attempts to recreate each instance |
| # continuously until it succeeds. |
| # |
| # This flag matters only in the first attempt of creation of an instance. |
| # After an instance is successfully created while this flag is enabled, the |
| # instance behaves the same way as all the other instances created with a |
| # regular resize request. In particular, if a running instance dies |
| # unexpectedly at a later time and needs to be recreated, this mode does not |
| # affect the recreation behavior in that scenario. |
| # |
| # This flag is applicable only to the current resize request. It does not |
| # influence other resize requests in any way. |
| # |
| # You can see which instances ar being created in which mode by calling |
| # the get or listManagedInstances API. |
| "targetSize": 42, # The number of running instances that the managed instance group should |
| # maintain at any given time. The group automatically adds or removes |
| # instances to maintain the number of instances specified by this parameter. |
| } |
| |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so |
| that if you must retry your request, the server will know to ignore the |
| request if it has already been completed. |
| |
| For example, consider a situation where you make an initial request and |
| the request times out. If you make the request again with the same |
| request ID, the server can check if original operation with the same |
| request ID was received, and if so, will ignore the second request. This |
| prevents clients from accidentally creating duplicate commitments. |
| |
| The request ID must be |
| a valid UUID with the exception that zero UUID is not supported |
| (00000000-0000-0000-0000-000000000000). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/beta/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/beta/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # |
| # - For global operations, use the `globalOperations` |
| # resource. |
| # - For regional operations, use the |
| # `regionOperations` resource. |
| # - For zonal operations, use |
| # the `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. |
| # Not present otherwise. |
| "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| "description": "A String", # [Output Only] A textual description of the operation, which is |
| # set when the operation is created. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 |
| # text format. |
| "error": { # [Output Only] If errors are generated during processing of the operation, |
| # this field will be populated. |
| "errors": [ # [Output Only] The array of errors encountered while processing this |
| # operation. |
| { |
| "code": "A String", # [Output Only] The error type identifier for this error. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| }, |
| ], |
| }, |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error |
| # message that was returned, such as `NOT FOUND`. |
| "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. |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is |
| # defined by the server. |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. |
| # This value is inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, |
| # `update`, or `delete`, and so on. |
| "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. |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only |
| # applicable when performing regional operations. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # text format. |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the |
| # following: |
| # `PENDING`, `RUNNING`, or `DONE`. |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the |
| # operation. |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation |
| # of the target resource. |
| "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For |
| # operations related to creating a snapshot, this points to the disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `[email protected]` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the |
| # operation, this field will be populated. |
| { |
| "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. |
| "data": [ # [Output Only] Metadata about this warning in key: |
| # value format. For example: |
| # |
| # "data": [ |
| # { |
| # "key": "scope", |
| # "value": "zones/us-east1-d" |
| # } |
| { |
| "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). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| ], |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only |
| # applicable when performing per-zone operations. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="resumeInstances">resumeInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> |
| <pre>Flags the specified instances in the managed instance group to be |
| resumed. This method increases thetargetSize and decreases the targetSuspendedSize |
| of the managed instance group by the number of instances that you resume. |
| The resumeInstances operation is marked DONE if |
| the resumeInstances request is successful. The underlying |
| actions take additional time. You must separately verify the status of theRESUMING action with thelistmanagedinstances |
| method. |
| |
| In this request, you can only specify instances that are suspended. For |
| example, if an instance was previously suspended using the suspendInstances |
| method, it can be resumed using the resumeInstances method. |
| |
| If a health check is attached to the managed instance group, the specified |
| instances will be verified as healthy after they are resumed. |
| |
| You can specify a maximum of 1000 instances with this method per request. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, Name of the region scoping this request. (required) |
| instanceGroupManager: string, Name of the managed instance group. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "instances": [ # The URLs of one or more instances to resume. This can be a full URL or |
| # a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. |
| "A String", |
| ], |
| } |
| |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so |
| that if you must retry your request, the server will know to ignore the |
| request if it has already been completed. |
| |
| For example, consider a situation where you make an initial request and |
| the request times out. If you make the request again with the same |
| request ID, the server can check if original operation with the same |
| request ID was received, and if so, will ignore the second request. This |
| prevents clients from accidentally creating duplicate commitments. |
| |
| The request ID must be |
| a valid UUID with the exception that zero UUID is not supported |
| (00000000-0000-0000-0000-000000000000). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/beta/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/beta/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # |
| # - For global operations, use the `globalOperations` |
| # resource. |
| # - For regional operations, use the |
| # `regionOperations` resource. |
| # - For zonal operations, use |
| # the `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. |
| # Not present otherwise. |
| "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| "description": "A String", # [Output Only] A textual description of the operation, which is |
| # set when the operation is created. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 |
| # text format. |
| "error": { # [Output Only] If errors are generated during processing of the operation, |
| # this field will be populated. |
| "errors": [ # [Output Only] The array of errors encountered while processing this |
| # operation. |
| { |
| "code": "A String", # [Output Only] The error type identifier for this error. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| }, |
| ], |
| }, |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error |
| # message that was returned, such as `NOT FOUND`. |
| "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. |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is |
| # defined by the server. |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. |
| # This value is inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, |
| # `update`, or `delete`, and so on. |
| "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. |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only |
| # applicable when performing regional operations. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # text format. |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the |
| # following: |
| # `PENDING`, `RUNNING`, or `DONE`. |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the |
| # operation. |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation |
| # of the target resource. |
| "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For |
| # operations related to creating a snapshot, this points to the disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `[email protected]` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the |
| # operation, this field will be populated. |
| { |
| "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. |
| "data": [ # [Output Only] Metadata about this warning in key: |
| # value format. For example: |
| # |
| # "data": [ |
| # { |
| # "key": "scope", |
| # "value": "zones/us-east1-d" |
| # } |
| { |
| "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). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| ], |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only |
| # applicable when performing per-zone operations. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="setAutoHealingPolicies">setAutoHealingPolicies(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> |
| <pre>Modifies the autohealing policy for the instances in this managed |
| instance group. |
| [Deprecated] This method is deprecated. UseregionInstanceGroupManagers.patch instead. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, Name of the region scoping this request. (required) |
| instanceGroupManager: string, Name of the managed instance group. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "autoHealingPolicies": [ |
| { |
| "healthCheck": "A String", # The URL for the health check that signals autohealing. |
| "initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to |
| # initialize and run its startup script. During a VM's initial delay |
| # period, the MIG ignores unsuccessful health checks because the VM might |
| # be in the startup process. This prevents the MIG from prematurely |
| # recreating a VM. If the health check receives a healthy response during |
| # the initial delay, it indicates that the startup process is complete and |
| # the VM is ready. The value of initial delay must be between 0 and 3600 |
| # seconds. The default value is 0. |
| }, |
| ], |
| } |
| |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so |
| that if you must retry your request, the server will know to ignore the |
| request if it has already been completed. |
| |
| For example, consider a situation where you make an initial request and |
| the request times out. If you make the request again with the same |
| request ID, the server can check if original operation with the same |
| request ID was received, and if so, will ignore the second request. This |
| prevents clients from accidentally creating duplicate commitments. |
| |
| The request ID must be |
| a valid UUID with the exception that zero UUID is not supported |
| (00000000-0000-0000-0000-000000000000). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/beta/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/beta/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # |
| # - For global operations, use the `globalOperations` |
| # resource. |
| # - For regional operations, use the |
| # `regionOperations` resource. |
| # - For zonal operations, use |
| # the `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. |
| # Not present otherwise. |
| "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| "description": "A String", # [Output Only] A textual description of the operation, which is |
| # set when the operation is created. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 |
| # text format. |
| "error": { # [Output Only] If errors are generated during processing of the operation, |
| # this field will be populated. |
| "errors": [ # [Output Only] The array of errors encountered while processing this |
| # operation. |
| { |
| "code": "A String", # [Output Only] The error type identifier for this error. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| }, |
| ], |
| }, |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error |
| # message that was returned, such as `NOT FOUND`. |
| "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. |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is |
| # defined by the server. |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. |
| # This value is inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, |
| # `update`, or `delete`, and so on. |
| "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. |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only |
| # applicable when performing regional operations. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # text format. |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the |
| # following: |
| # `PENDING`, `RUNNING`, or `DONE`. |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the |
| # operation. |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation |
| # of the target resource. |
| "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For |
| # operations related to creating a snapshot, this points to the disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `[email protected]` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the |
| # operation, this field will be populated. |
| { |
| "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. |
| "data": [ # [Output Only] Metadata about this warning in key: |
| # value format. For example: |
| # |
| # "data": [ |
| # { |
| # "key": "scope", |
| # "value": "zones/us-east1-d" |
| # } |
| { |
| "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). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| ], |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only |
| # applicable when performing per-zone operations. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="setInstanceTemplate">setInstanceTemplate(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> |
| <pre>Sets the instance template to use when creating new instances or recreating |
| instances in this group. Existing instances are not affected. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, Name of the region scoping this request. (required) |
| instanceGroupManager: string, The name of the managed instance group. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "instanceTemplate": "A String", # URL of the InstanceTemplate resource from which all new instances will be |
| # created. |
| } |
| |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so |
| that if you must retry your request, the server will know to ignore the |
| request if it has already been completed. |
| |
| For example, consider a situation where you make an initial request and |
| the request times out. If you make the request again with the same |
| request ID, the server can check if original operation with the same |
| request ID was received, and if so, will ignore the second request. This |
| prevents clients from accidentally creating duplicate commitments. |
| |
| The request ID must be |
| a valid UUID with the exception that zero UUID is not supported |
| (00000000-0000-0000-0000-000000000000). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/beta/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/beta/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # |
| # - For global operations, use the `globalOperations` |
| # resource. |
| # - For regional operations, use the |
| # `regionOperations` resource. |
| # - For zonal operations, use |
| # the `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. |
| # Not present otherwise. |
| "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| "description": "A String", # [Output Only] A textual description of the operation, which is |
| # set when the operation is created. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 |
| # text format. |
| "error": { # [Output Only] If errors are generated during processing of the operation, |
| # this field will be populated. |
| "errors": [ # [Output Only] The array of errors encountered while processing this |
| # operation. |
| { |
| "code": "A String", # [Output Only] The error type identifier for this error. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| }, |
| ], |
| }, |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error |
| # message that was returned, such as `NOT FOUND`. |
| "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. |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is |
| # defined by the server. |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. |
| # This value is inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, |
| # `update`, or `delete`, and so on. |
| "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. |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only |
| # applicable when performing regional operations. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # text format. |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the |
| # following: |
| # `PENDING`, `RUNNING`, or `DONE`. |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the |
| # operation. |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation |
| # of the target resource. |
| "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For |
| # operations related to creating a snapshot, this points to the disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `[email protected]` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the |
| # operation, this field will be populated. |
| { |
| "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. |
| "data": [ # [Output Only] Metadata about this warning in key: |
| # value format. For example: |
| # |
| # "data": [ |
| # { |
| # "key": "scope", |
| # "value": "zones/us-east1-d" |
| # } |
| { |
| "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). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| ], |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only |
| # applicable when performing per-zone operations. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="setTargetPools">setTargetPools(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</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, Project ID for this request. (required) |
| region: string, Name of the region scoping this request. (required) |
| instanceGroupManager: string, Name of the managed instance group. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "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. |
| "targetPools": [ # The URL of all TargetPool resources to which instances in theinstanceGroup field are added. The target pools automatically |
| # apply to all of the instances in the managed instance group. |
| "A String", |
| ], |
| } |
| |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so |
| that if you must retry your request, the server will know to ignore the |
| request if it has already been completed. |
| |
| For example, consider a situation where you make an initial request and |
| the request times out. If you make the request again with the same |
| request ID, the server can check if original operation with the same |
| request ID was received, and if so, will ignore the second request. This |
| prevents clients from accidentally creating duplicate commitments. |
| |
| The request ID must be |
| a valid UUID with the exception that zero UUID is not supported |
| (00000000-0000-0000-0000-000000000000). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/beta/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/beta/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # |
| # - For global operations, use the `globalOperations` |
| # resource. |
| # - For regional operations, use the |
| # `regionOperations` resource. |
| # - For zonal operations, use |
| # the `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. |
| # Not present otherwise. |
| "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| "description": "A String", # [Output Only] A textual description of the operation, which is |
| # set when the operation is created. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 |
| # text format. |
| "error": { # [Output Only] If errors are generated during processing of the operation, |
| # this field will be populated. |
| "errors": [ # [Output Only] The array of errors encountered while processing this |
| # operation. |
| { |
| "code": "A String", # [Output Only] The error type identifier for this error. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| }, |
| ], |
| }, |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error |
| # message that was returned, such as `NOT FOUND`. |
| "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. |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is |
| # defined by the server. |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. |
| # This value is inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, |
| # `update`, or `delete`, and so on. |
| "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. |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only |
| # applicable when performing regional operations. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # text format. |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the |
| # following: |
| # `PENDING`, `RUNNING`, or `DONE`. |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the |
| # operation. |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation |
| # of the target resource. |
| "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For |
| # operations related to creating a snapshot, this points to the disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `[email protected]` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the |
| # operation, this field will be populated. |
| { |
| "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. |
| "data": [ # [Output Only] Metadata about this warning in key: |
| # value format. For example: |
| # |
| # "data": [ |
| # { |
| # "key": "scope", |
| # "value": "zones/us-east1-d" |
| # } |
| { |
| "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). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| ], |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only |
| # applicable when performing per-zone operations. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="startInstances">startInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> |
| <pre>Flags the specified instances in the managed instance group to be |
| started. This method increases thetargetSize and decreases the targetStoppedSize |
| of the managed instance group by the number of instances that you start. |
| The startInstances operation is marked DONE if |
| the startInstances request is successful. The underlying |
| actions take additional time. You must separately verify the status of theSTARTING action with thelistmanagedinstances |
| method. |
| |
| In this request, you can only specify instances that are stopped. For |
| example, if an instance was previously stopped using the stopInstances |
| method, it can be started using the startInstances method. |
| |
| If a health check is attached to the managed instance group, the specified |
| instances will be verified as healthy after they are started. |
| |
| You can specify a maximum of 1000 instances with this method per request. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, Name of the region scoping this request. (required) |
| instanceGroupManager: string, Name of the managed instance group. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "instances": [ # The URLs of one or more instances to start. This can be a full URL or |
| # a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. |
| "A String", |
| ], |
| } |
| |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so |
| that if you must retry your request, the server will know to ignore the |
| request if it has already been completed. |
| |
| For example, consider a situation where you make an initial request and |
| the request times out. If you make the request again with the same |
| request ID, the server can check if original operation with the same |
| request ID was received, and if so, will ignore the second request. This |
| prevents clients from accidentally creating duplicate commitments. |
| |
| The request ID must be |
| a valid UUID with the exception that zero UUID is not supported |
| (00000000-0000-0000-0000-000000000000). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/beta/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/beta/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # |
| # - For global operations, use the `globalOperations` |
| # resource. |
| # - For regional operations, use the |
| # `regionOperations` resource. |
| # - For zonal operations, use |
| # the `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. |
| # Not present otherwise. |
| "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| "description": "A String", # [Output Only] A textual description of the operation, which is |
| # set when the operation is created. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 |
| # text format. |
| "error": { # [Output Only] If errors are generated during processing of the operation, |
| # this field will be populated. |
| "errors": [ # [Output Only] The array of errors encountered while processing this |
| # operation. |
| { |
| "code": "A String", # [Output Only] The error type identifier for this error. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| }, |
| ], |
| }, |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error |
| # message that was returned, such as `NOT FOUND`. |
| "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. |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is |
| # defined by the server. |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. |
| # This value is inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, |
| # `update`, or `delete`, and so on. |
| "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. |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only |
| # applicable when performing regional operations. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # text format. |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the |
| # following: |
| # `PENDING`, `RUNNING`, or `DONE`. |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the |
| # operation. |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation |
| # of the target resource. |
| "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For |
| # operations related to creating a snapshot, this points to the disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `[email protected]` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the |
| # operation, this field will be populated. |
| { |
| "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. |
| "data": [ # [Output Only] Metadata about this warning in key: |
| # value format. For example: |
| # |
| # "data": [ |
| # { |
| # "key": "scope", |
| # "value": "zones/us-east1-d" |
| # } |
| { |
| "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). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| ], |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only |
| # applicable when performing per-zone operations. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="stopInstances">stopInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> |
| <pre>Flags the specified instances in the managed instance group to be |
| immediately stopped. You can only specify instances that are running in |
| this request. This method reduces thetargetSize and increases the targetStoppedSize |
| of the managed instance group by the number of instances that you stop. |
| The stopInstances operation is marked DONE if |
| the stopInstances request is successful. The underlying |
| actions take additional time. You must separately verify the status of theSTOPPING action with thelistmanagedinstances |
| method. |
| |
| If the standbyPolicy.initialDelaySec field is set, the group |
| delays stopping the instances until initialDelaySec have |
| passed from instance.creationTimestamp (that is, when the |
| instance was created). This delay gives your application time to |
| set itself up and initialize on the instance. If more thaninitialDelaySec seconds have passed sinceinstance.creationTimestamp when this method is called, there |
| will be zero delay. |
| |
| If the group is part of a backend |
| service that has enabled |
| connection draining, it can take up to 60 seconds after the connection |
| draining duration has elapsed before the VM instance is stopped. |
| |
| Stopped instances can be started using the startInstances |
| method. |
| |
| You can specify a maximum of 1000 instances with this method per request. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, Name of the region scoping this request. (required) |
| instanceGroupManager: string, The name of the managed instance group. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "forceStop": True or False, # If this flag is set to true, the Instance Group Manager will proceed to |
| # stop the instances, skipping initialization on them. |
| "instances": [ # The URLs of one or more instances to stop. This can be a full URL or |
| # a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. |
| "A String", |
| ], |
| } |
| |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so |
| that if you must retry your request, the server will know to ignore the |
| request if it has already been completed. |
| |
| For example, consider a situation where you make an initial request and |
| the request times out. If you make the request again with the same |
| request ID, the server can check if original operation with the same |
| request ID was received, and if so, will ignore the second request. This |
| prevents clients from accidentally creating duplicate commitments. |
| |
| The request ID must be |
| a valid UUID with the exception that zero UUID is not supported |
| (00000000-0000-0000-0000-000000000000). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/beta/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/beta/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # |
| # - For global operations, use the `globalOperations` |
| # resource. |
| # - For regional operations, use the |
| # `regionOperations` resource. |
| # - For zonal operations, use |
| # the `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. |
| # Not present otherwise. |
| "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| "description": "A String", # [Output Only] A textual description of the operation, which is |
| # set when the operation is created. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 |
| # text format. |
| "error": { # [Output Only] If errors are generated during processing of the operation, |
| # this field will be populated. |
| "errors": [ # [Output Only] The array of errors encountered while processing this |
| # operation. |
| { |
| "code": "A String", # [Output Only] The error type identifier for this error. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| }, |
| ], |
| }, |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error |
| # message that was returned, such as `NOT FOUND`. |
| "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. |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is |
| # defined by the server. |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. |
| # This value is inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, |
| # `update`, or `delete`, and so on. |
| "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. |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only |
| # applicable when performing regional operations. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # text format. |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the |
| # following: |
| # `PENDING`, `RUNNING`, or `DONE`. |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the |
| # operation. |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation |
| # of the target resource. |
| "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For |
| # operations related to creating a snapshot, this points to the disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `[email protected]` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the |
| # operation, this field will be populated. |
| { |
| "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. |
| "data": [ # [Output Only] Metadata about this warning in key: |
| # value format. For example: |
| # |
| # "data": [ |
| # { |
| # "key": "scope", |
| # "value": "zones/us-east1-d" |
| # } |
| { |
| "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). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| ], |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only |
| # applicable when performing per-zone operations. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="suspendInstances">suspendInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> |
| <pre>Flags the specified instances in the managed instance group to be |
| immediately suspended. You can only specify instances that are running in |
| this request. This method reduces thetargetSize and increases the targetSuspendedSize |
| of the managed instance group by the number of instances that you suspend. |
| The suspendInstances operation is marked DONE if |
| the suspendInstances request is successful. The underlying |
| actions take additional time. You must separately verify the status of theSUSPENDING action with thelistmanagedinstances |
| method. |
| |
| If the standbyPolicy.initialDelaySec field is set, the group |
| delays suspension of the instances until initialDelaySec have |
| passed from instance.creationTimestamp (that is, when the |
| instance was created). This delay gives your application time to |
| set itself up and initialize on the instance. If more thaninitialDelaySec seconds have passed sinceinstance.creationTimestamp when this method is called, there |
| will be zero delay. |
| |
| If the group is part of a backend |
| service that has enabled |
| connection draining, it can take up to 60 seconds after the connection |
| draining duration has elapsed before the VM instance is suspended. |
| |
| Suspended instances can be resumed using the resumeInstances |
| method. |
| |
| You can specify a maximum of 1000 instances with this method per request. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, Name of the region scoping this request. (required) |
| instanceGroupManager: string, Name of the managed instance group. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "forceSuspend": True or False, # If this flag is set to true, the Instance Group Manager will proceed to |
| # suspend the instances, skipping initialization on them. |
| "instances": [ # The URLs of one or more instances to suspend. This can be a full URL or |
| # a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. |
| "A String", |
| ], |
| } |
| |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so |
| that if you must retry your request, the server will know to ignore the |
| request if it has already been completed. |
| |
| For example, consider a situation where you make an initial request and |
| the request times out. If you make the request again with the same |
| request ID, the server can check if original operation with the same |
| request ID was received, and if so, will ignore the second request. This |
| prevents clients from accidentally creating duplicate commitments. |
| |
| The request ID must be |
| a valid UUID with the exception that zero UUID is not supported |
| (00000000-0000-0000-0000-000000000000). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/beta/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/beta/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # |
| # - For global operations, use the `globalOperations` |
| # resource. |
| # - For regional operations, use the |
| # `regionOperations` resource. |
| # - For zonal operations, use |
| # the `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. |
| # Not present otherwise. |
| "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| "description": "A String", # [Output Only] A textual description of the operation, which is |
| # set when the operation is created. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 |
| # text format. |
| "error": { # [Output Only] If errors are generated during processing of the operation, |
| # this field will be populated. |
| "errors": [ # [Output Only] The array of errors encountered while processing this |
| # operation. |
| { |
| "code": "A String", # [Output Only] The error type identifier for this error. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| }, |
| ], |
| }, |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error |
| # message that was returned, such as `NOT FOUND`. |
| "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. |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is |
| # defined by the server. |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. |
| # This value is inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, |
| # `update`, or `delete`, and so on. |
| "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. |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only |
| # applicable when performing regional operations. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # text format. |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the |
| # following: |
| # `PENDING`, `RUNNING`, or `DONE`. |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the |
| # operation. |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation |
| # of the target resource. |
| "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For |
| # operations related to creating a snapshot, this points to the disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `[email protected]` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the |
| # operation, this field will be populated. |
| { |
| "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. |
| "data": [ # [Output Only] Metadata about this warning in key: |
| # value format. For example: |
| # |
| # "data": [ |
| # { |
| # "key": "scope", |
| # "value": "zones/us-east1-d" |
| # } |
| { |
| "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). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| ], |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only |
| # applicable when performing per-zone operations. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</code> |
| <pre>Returns permissions that a caller has on the specified resource. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, The name of the region for this request. (required) |
| resource: string, Name or id of the resource for this request. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "permissions": [ # The set of permissions to check for the 'resource'. Permissions with |
| # wildcards (such as '*' or 'storage.*') are not allowed. |
| "A String", |
| ], |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is |
| # allowed. |
| "A String", |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="update">update(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> |
| <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 thelistmanagedinstances |
| method. |
| |
| If you update your group to specify a new template or instance |
| configuration, it's possible that your intended specification for each VM |
| in the group is different from the current state of that VM. To learn how |
| to apply an updated configuration to the VMs in a MIG, seeUpdating instances in |
| a MIG. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, Name of the region scoping this request. (required) |
| instanceGroupManager: string, The name of the instance group manager. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Represents a Managed Instance Group resource. |
| # |
| # An instance group is a collection of VM instances that you can manage as a |
| # single entity. For more information, readInstance groups. |
| # |
| # For zonal Managed Instance Group, use the instanceGroupManagers |
| # resource. |
| # |
| # For regional Managed Instance Group, use theregionInstanceGroupManagers resource. |
| "allInstancesConfig": { # Specifies configuration that overrides the instance template configuration |
| # for the group. |
| "properties": { # Represents the change that you want to make to the instance properties. # Properties to set on all instances in the group. |
| # |
| # You can add or modify properties using theinstanceGroupManagers.patch orregionInstanceGroupManagers.patch. After settingallInstancesConfig on the group, you must update the group's |
| # instances to apply the configuration. To apply the configuration, set the |
| # group's updatePolicy.type field to use proactive updates or |
| # use the applyUpdatesToInstances method. |
| "labels": { # The label key-value pairs that you want to patch onto the instance. |
| "a_key": "A String", |
| }, |
| "metadata": { # The metadata key-value pairs that you want to patch onto the instance. For |
| # more information, see Project and |
| # instance metadata. |
| "a_key": "A String", |
| }, |
| }, |
| }, |
| "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify |
| # only one value. |
| { |
| "healthCheck": "A String", # The URL for the health check that signals autohealing. |
| "initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to |
| # initialize and run its startup script. During a VM's initial delay |
| # period, the MIG ignores unsuccessful health checks because the VM might |
| # be in the startup process. This prevents the MIG from prematurely |
| # recreating a VM. If the health check receives a healthy response during |
| # the initial delay, it indicates that the startup process is complete and |
| # the VM is ready. The value of initial delay must be between 0 and 3600 |
| # seconds. The default value is 0. |
| }, |
| ], |
| "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of |
| # all VMs in a MIG. The maximum character length is 58 and the name must |
| # comply with RFC1035 format. |
| # |
| # When a VM is created in the group, the MIG appends a hyphen and a random |
| # four-character string to the base instance name. If you want the MIG to |
| # assign sequential numbers instead of a random string, then end the base |
| # instance name with a hyphen followed by one or more hash symbols. The hash |
| # symbols indicate the number of digits. For example, a base instance name of |
| # "vm-###" results in "vm-001" as a VM name. |
| # @pattern |
| # [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\\[[0-9]{1,10}\\])?)) |
| "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group inRFC3339 |
| # text format. |
| "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. |
| "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. |
| "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. |
| # |
| # If you have disabled creation retries, this field will not be populated; |
| # instead, the creatingWithoutRetries field will be populated. |
| "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. |
| "deleting": 42, # [Output Only] The number of instances in the managed instance group that |
| # are scheduled to be deleted or are currently being deleted. |
| "none": 42, # [Output Only] The number of instances in the managed instance group that |
| # are running and have no scheduled actions. |
| "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. |
| "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. |
| "restarting": 42, # [Output Only] The number of instances in the managed instance group that |
| # are scheduled to be restarted or are currently being restarted. |
| "resuming": 42, # [Output Only] The number of instances in the managed instance group that |
| # are scheduled to be resumed or are currently being resumed. |
| "starting": 42, # [Output Only] The number of instances in the managed instance group that |
| # are scheduled to be started or are currently being started. |
| "stopping": 42, # [Output Only] The number of instances in the managed instance group that |
| # are scheduled to be stopped or are currently being stopped. |
| "suspending": 42, # [Output Only] The number of instances in the managed instance group that |
| # are scheduled to be suspended or are currently being suspended. |
| "verifying": 42, # [Output Only] The number of instances in the managed instance group that |
| # are being verified. See the managedInstances[].currentAction |
| # property in the listManagedInstances method documentation. |
| }, |
| "description": "A String", # An optional description of this resource. |
| "distributionPolicy": { # Policy specifying the intended distribution of managed instances across |
| # zones in a regional managed instance group. |
| "targetShape": "A String", # The distribution shape to which the group converges either proactively or |
| # on resize events (depending on the value set inupdatePolicy.instanceRedistributionType). |
| "zones": [ # Zones where the regional managed instance group will create and manage |
| # its instances. |
| { |
| "zone": "A String", # The URL of thezone. |
| # The zone must exist in the region where the managed instance group is |
| # located. |
| }, |
| ], |
| }, |
| "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported,NO_FAILOVER. The default is NO_FAILOVER. |
| "fingerprint": "A String", # Fingerprint of this resource. This field may be used in optimistic locking. |
| # It will be ignored when inserting an InstanceGroupManager. An up-to-date |
| # fingerprint must be provided in order to update the InstanceGroupManager, |
| # otherwise the request will fail with error412 conditionNotMet. |
| # |
| # To see the latest fingerprint, make a get() request to |
| # retrieve an InstanceGroupManager. |
| "id": "A String", # [Output Only] A unique identifier for this resource type. The server |
| # generates this identifier. |
| "instanceFlexibilityPolicy": { # Instance flexibility allowing MIG to create VMs from multiple |
| # types of machines. |
| # Instance flexibility configuration on MIG overrides instance |
| # template configuration. |
| "instanceSelections": { # Named instance selections configuring properties that the group will use |
| # when creating new VMs. |
| "a_key": { |
| "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16". |
| "A String", |
| ], |
| "rank": 42, # Preference of this instance selection. Lower number means higher |
| # preference. MIG will first try to create a VM based on the machine-type |
| # with lowest rank and fallback to next rank based on availability. |
| # Machine types and instance selections with the same rank have the same |
| # preference. |
| }, |
| }, |
| "provisioningModelMix": { # Provisioning model configuration used by this managed instance group to |
| # create instances. |
| "standardCapacityBase": 42, # The base capacity that will always use Standard VMs to avoid risk of |
| # more preemption than the minimum capacity user needs. MIG will create |
| # only Standard VMs until it reaches standard_capacity_base and only |
| # then will start using standard_capacity_percent_above_base to mix Spot |
| # with Standard VMs. |
| "standardCapacityPercentAboveBase": 42, # The percentage of target capacity that should use Standard VM. The |
| # remaining percentage will use Spot VMs. The percentage applies only to |
| # the capacity above standard_capacity_base. |
| }, |
| }, |
| "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource. |
| "instanceLifecyclePolicy": { # The repair policy for this managed instance group. |
| "defaultActionOnFailure": "A String", # The action that a MIG performs on a failed VM. If the value of the onFailedHealthCheck field |
| # is `DEFAULT_ACTION`, then the same action also applies to the VMs on which your application |
| # fails a health check. Valid values are - REPAIR (default): MIG automatically repairs a failed |
| # VM by recreating it. For more information, seeAbout repairing |
| # VMs in a MIG. - DO_NOTHING: MIG does not repair a failed VM. |
| "forceUpdateOnRepair": "A String", # A bit indicating whether to forcefully apply the group's latest |
| # configuration when repairing a VM. Valid options are: |
| # |
| # |
| # |
| # - NO (default): If configuration updates are available, they are not |
| # forcefully applied during repair. Instead, configuration updates are |
| # applied according to the group's update policy. |
| # |
| # - YES: If configuration updates are available, they are applied |
| # during repair. |
| "onFailedHealthCheck": "A String", # The action that a MIG performs on an unhealthy VM. A VM is marked as |
| # unhealthy when the application running on that VM fails a health check. |
| # Valid values are: |
| # |
| # - DEFAULT_ACTION (default): MIG uses the same action |
| # configured for instanceLifecyclePolicy.defaultActionOnFailure field. |
| # - REPAIR: MIG automatically repairs an unhealthy VM by |
| # recreating it. |
| # - DO_NOTHING: MIG doesn't repair an unhealthy VM. |
| # For more information, see |
| # About repairing VMs in a MIG. |
| "onRepair": { # Configuration for VM repairs in the MIG. # Configuration for VM repairs in the MIG. |
| "allowChangingZone": "A String", # Specifies whether the MIG can change a VM's zone during a repair. |
| # Valid values are: |
| # |
| # - NO (default): MIG cannot change a VM's zone during a |
| # repair. |
| # - YES: MIG can select a different zone for the VM during |
| # a repair. |
| }, |
| }, |
| "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. The templates for existing instances in the |
| # group do not change unless you run recreateInstances, runapplyUpdatesToInstances, or set the group'supdatePolicy.type to PROACTIVE. |
| "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is alwayscompute#instanceGroupManager for managed instance groups. |
| "listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for |
| # this managed instance group. |
| "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to. |
| "name": "A String", # The name of the managed instance group. The name must be 1-63 characters |
| # long, and comply withRFC1035. |
| "namedPorts": [ # [Output Only] Named ports configured on the Instance Groups complementary |
| # to this Instance Group Manager. |
| { # The named port. For example: <"http", 80>. |
| "name": "A String", # The name for this named port. |
| # The name must be 1-63 characters long, and comply withRFC1035. |
| "port": 42, # The port number, which can be a value between 1 and 65535. |
| }, |
| ], |
| "params": { # Input only additional params for instance group manager creation. # Input only. Additional params passed with the request, but not persisted |
| # as part of resource payload. |
| "resourceManagerTags": { # Resource manager tags to bind to the managed instance group. The tags are |
| # key-value pairs. Keys must be in the format tagKeys/123 and values in the |
| # format tagValues/456. For more information, seeManage tags |
| # for resources. |
| "a_key": "A String", |
| }, |
| }, |
| "region": "A String", # [Output Only] The URL of theregion |
| # where the managed instance group resides (for regional resources). |
| "resourcePolicies": { # Resource policies for this managed instance group. |
| "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed |
| # instance group. |
| # It can be a full or partial URL. For example, the following are |
| # all valid URLs to a workload policy: |
| # |
| # |
| # - https://www.googleapis.com/compute/v1/projects/project/regions/region/resourcePolicies/resourcePolicy |
| # - projects/project/regions/region/resourcePolicies/resourcePolicy |
| # - regions/region/resourcePolicies/resourcePolicy |
| }, |
| "satisfiesPzi": True or False, # [Output Only] Reserved for future use. |
| "satisfiesPzs": True or False, # [Output Only] Reserved for future use. |
| "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines |
| # this URL. |
| "serviceAccount": "A String", # The service account to be used as credentials for all operations performed |
| # by the managed instance group on instances. The service accounts needs all |
| # permissions required to create and delete instances. |
| # By default, the service account |
| # {projectNumber}@cloudservices.gserviceaccount.com is used. |
| "standbyPolicy": { # Standby policy for stopped and suspended instances. |
| "initialDelaySec": 42, # Specifies the number of seconds that the MIG should wait to suspend or |
| # stop a VM after that VM was created. The initial delay gives the |
| # initialization script the time to prepare your VM for a quick scale out. |
| # The value of initial delay must be between 0 and 3600 seconds. The |
| # default value is 0. |
| "mode": "A String", # Defines how a MIG resumes or starts VMs from a standby pool when the |
| # group scales out. The default mode is `MANUAL`. |
| }, |
| "statefulPolicy": { # Stateful configuration for this Instanced Group Manager |
| "preservedState": { # Configuration of preserved resources. |
| "disks": { # Disks created on the instances that will be preserved on instance |
| # delete, update, etc. This map is keyed with the device names of |
| # the disks. |
| "a_key": { |
| "autoDelete": "A String", # These stateful disks will never be deleted during autohealing, |
| # update or VM instance recreate operations. |
| # This flag is used to configure if the disk should be deleted after it |
| # is no longer used by the group, e.g. when the given instance or |
| # the whole group is deleted. Note: disks attached inREAD_ONLY mode cannot be auto-deleted. |
| }, |
| }, |
| "externalIPs": { # External network IPs assigned to the instances that will be preserved on |
| # instance delete, update, etc. This map is keyed with the network |
| # interface name. |
| "a_key": { |
| "autoDelete": "A String", # These stateful IPs will never be released during autohealing, |
| # update or VM instance recreate operations. |
| # This flag is used to configure if the IP reservation should be deleted |
| # after it is no longer used by the group, e.g. when the given instance |
| # or the whole group is deleted. |
| }, |
| }, |
| "internalIPs": { # Internal network IPs assigned to the instances that will be preserved on |
| # instance delete, update, etc. This map is keyed with the network |
| # interface name. |
| "a_key": { |
| "autoDelete": "A String", # These stateful IPs will never be released during autohealing, |
| # update or VM instance recreate operations. |
| # This flag is used to configure if the IP reservation should be deleted |
| # after it is no longer used by the group, e.g. when the given instance |
| # or the whole group is deleted. |
| }, |
| }, |
| }, |
| }, |
| "status": { # [Output Only] The status of this managed instance group. |
| "allInstancesConfig": { # [Output only] Status of all-instances configuration on the group. |
| "currentRevision": "A String", # [Output Only] Current all-instances configuration revision. |
| # This value is in RFC3339 text format. |
| "effective": True or False, # [Output Only] A bit indicating whether this configuration has |
| # been applied to all managed instances in the group. |
| }, |
| "autoscaler": "A String", # [Output Only] The URL of theAutoscaler |
| # that targets this instance group manager. |
| "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # [Output Only] The status of bulk instance operation. |
| # targetSizePolicy.mode is set to BULK. |
| "inProgress": True or False, # [Output Only] Informs whether bulk instance operation is in progress. |
| "lastProgressCheck": { # [Output Only] Information from the last progress check of bulk instance |
| # operation. |
| "error": { # [Output Only] Errors encountered during bulk instance operation. |
| "errors": [ # [Output Only] The array of errors encountered while processing this |
| # operation. |
| { |
| "code": "A String", # [Output Only] The error type identifier for this error. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| }, |
| ], |
| }, |
| "timestamp": "A String", # [Output Only] Timestamp of the last progress check of bulk instance |
| # operation. Timestamp is in RFC3339 text format. |
| }, |
| }, |
| "isStable": True or False, # [Output Only] A bit indicating whether the managed instance group is in a |
| # stable state. A stable state means that: none of the instances in the |
| # managed instance group is currently undergoing any type of change (for |
| # example, creation, restart, or deletion); no future changes are scheduled |
| # for instances in the managed instance group; and the managed instance |
| # group itself is not being modified. |
| "stateful": { # [Output Only] Stateful status of the given Instance Group Manager. |
| "hasStatefulConfig": True or False, # [Output Only] A bit indicating whether the managed instance group |
| # has stateful configuration, that is, if you have configured any items |
| # in a stateful policy or in per-instance configs. |
| # The group might report that it has no stateful configuration even when |
| # there is still some preserved state on a managed instance, for example, |
| # if you have deleted all PICs but not yet applied those deletions. |
| "isStateful": True or False, # [Output Only] A bit indicating whether the managed instance group |
| # has stateful configuration, that is, if you have configured any items |
| # in a stateful policy or in per-instance configs. |
| # The group might report that it has no stateful configuration even when |
| # there is still some preserved state on a managed instance, for example, |
| # if you have deleted all PICs but not yet applied those deletions. This |
| # field is deprecated in favor of has_stateful_config. |
| "perInstanceConfigs": { # [Output Only] Status of per-instance configurations on the instances. |
| "allEffective": True or False, # A bit indicating if all of the group's per-instance configurations |
| # (listed in the output of a listPerInstanceConfigs API call) have |
| # status EFFECTIVE or there are no per-instance-configs. |
| }, |
| }, |
| "versionTarget": { # [Output Only] A status of consistency of Instances' versions with their |
| # target version specified by version field on Instance Group |
| # Manager. |
| "isReached": True or False, # [Output Only] A bit indicating whether version target has been reached |
| # in this managed instance group, i.e. all instances are in their target |
| # version. Instances' target version are specified byversion field on Instance Group Manager. |
| }, |
| }, |
| "targetPools": [ # The URLs for all TargetPool resources to which instances in theinstanceGroup field are added. The target pools automatically |
| # apply to all of the instances in the managed instance group. |
| "A String", |
| ], |
| "targetSize": 42, # The target number of running instances for this managed instance group. |
| # You can reduce this number by using the instanceGroupManager |
| # deleteInstances or abandonInstances methods. Resizing the group also |
| # changes this number. |
| "targetSizePolicy": { # The policy that specifies how the MIG creates its VMs to achieve the target |
| # size. |
| "mode": "A String", # The mode of target size policy based on which the MIG creates its VMs |
| # individually or all at once. |
| }, |
| "targetStoppedSize": 42, # The target number of stopped instances for this managed instance group. |
| # This number changes when you: |
| # |
| # - Stop instance using the stopInstances |
| # method or start instances using the startInstances |
| # method. |
| # - Manually change the targetStoppedSize using the update |
| # method. |
| "targetSuspendedSize": 42, # The target number of suspended instances for this managed instance group. |
| # This number changes when you: |
| # |
| # - Suspend instance using the suspendInstances |
| # method or resume instances using the resumeInstances |
| # method. |
| # - Manually change the targetSuspendedSize using the update |
| # method. |
| "updatePolicy": { # The update policy for this managed instance group. |
| "instanceRedistributionType": "A String", # The |
| # instance redistribution policy for regional managed instance groups. |
| # Valid values are: |
| # |
| # - PROACTIVE (default): The group attempts to maintain an |
| # even distribution of VM instances across zones in the region. |
| # - NONE: For non-autoscaled groups, proactive |
| # redistribution is disabled. |
| "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be created above the specifiedtargetSize during the update process. This value can be |
| # either a fixed number or, if the group has 10 or more instances, a |
| # percentage. If you set a percentage, the number of instances is rounded |
| # if necessary. The default value for maxSurge is a fixed |
| # value equal to the number of zones in which the managed instance group |
| # operates. |
| # |
| # At least one of either maxSurge ormaxUnavailable must be greater than 0. Learn more about maxSurge. |
| "calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the |
| # specific mode. |
| # |
| # |
| # |
| # - If the value is fixed, then the calculated |
| # value is equal to the fixed value. |
| # - If the value is a percent, then the |
| # calculated |
| # value is percent/100 * targetSize. For example, |
| # the calculated value of a 80% of a managed instance group |
| # with 150 instances would be (80/100 * 150) = 120 VM instances. If there |
| # is a remainder, the number is rounded. |
| "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. |
| "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For |
| # example, specify 80 for 80%. |
| }, |
| "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be unavailable during the update |
| # process. An instance is considered available if all of the following |
| # conditions are satisfied: |
| # |
| # |
| # |
| # - The instance's status is |
| # RUNNING. |
| # - If there is a health |
| # check on the instance group, the instance's health check status |
| # must be HEALTHY at least once. If there is no health check |
| # on the group, then the instance only needs to have a status of |
| # RUNNING to be considered available. |
| # |
| # |
| # This value can be either a fixed number or, if the group has 10 or more |
| # instances, a percentage. If you set a percentage, the number of instances |
| # is rounded if necessary. The default value formaxUnavailable is a fixed value equal to the number of zones |
| # in which the managed instance group operates. |
| # |
| # At least one of either maxSurge ormaxUnavailable must be greater than 0. Learn more about maxUnavailable. |
| "calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the |
| # specific mode. |
| # |
| # |
| # |
| # - If the value is fixed, then the calculated |
| # value is equal to the fixed value. |
| # - If the value is a percent, then the |
| # calculated |
| # value is percent/100 * targetSize. For example, |
| # the calculated value of a 80% of a managed instance group |
| # with 150 instances would be (80/100 * 150) = 120 VM instances. If there |
| # is a remainder, the number is rounded. |
| "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. |
| "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For |
| # example, specify 80 for 80%. |
| }, |
| "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance |
| # becomes available. This value must be from range [0, 3600]. |
| "minimalAction": "A String", # Minimal action to be taken on an instance. Use this option to minimize |
| # disruption as much as possible or to apply a more disruptive action than |
| # is necessary. |
| # |
| # - To limit disruption as much as possible, set the minimal action toREFRESH. If your update requires a more disruptive action, |
| # Compute Engine performs the necessary action to execute the update. |
| # - To apply a more disruptive action than is strictly necessary, set the |
| # minimal action to RESTART or REPLACE. For |
| # example, Compute Engine does not need to restart a VM to change its |
| # metadata. But if your application reads instance metadata only when a VM |
| # is restarted, you can set the minimal action to RESTART in |
| # order to pick up metadata changes. |
| "mostDisruptiveAllowedAction": "A String", # Most disruptive action that is allowed to be taken on an instance. |
| # You can specify either NONE to forbid any actions,REFRESH to avoid restarting the VM and to limit disruption |
| # as much as possible. RESTART to allow actions that can be |
| # applied without instance replacing or REPLACE to allow all |
| # possible actions. If the Updater determines that the minimal update |
| # action needed is more disruptive than most disruptive allowed action you |
| # specify it will not perform the update at all. |
| "replacementMethod": "A String", # What action should be used to replace instances. |
| # See minimal_action.REPLACE |
| "type": "A String", # The type |
| # of update process. You can specify either PROACTIVE so |
| # that the MIG automatically updates VMs to the latest configurations orOPPORTUNISTIC so that you can select the VMs that you want |
| # to update. |
| }, |
| "versions": [ # Specifies the instance templates used by this managed instance group to |
| # create instances. |
| # |
| # Each version is defined by an instanceTemplate and aname. Every version can appear at most once per instance |
| # group. This field overrides the top-level instanceTemplate |
| # field. Read more about therelationships |
| # between these fields. Exactly one version must leave thetargetSize field unset. That version will be applied to all |
| # remaining instances. For more information, read aboutcanary |
| # updates. |
| { |
| "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed |
| # instance group. The group uses this template to create new instances in |
| # the managed instance group until the `targetSize` for this version is |
| # reached. The templates for existing instances in the group do not change |
| # unless you run recreateInstances, runapplyUpdatesToInstances, or set the group'supdatePolicy.type to PROACTIVE; in those cases, |
| # existing instances are updated until the `targetSize` for this version is |
| # reached. |
| "name": "A String", # Name of the version. Unique among all versions in the scope of this |
| # managed instance group. |
| "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Specifies the intended number of instances to be created from theinstanceTemplate. The final number of instances created |
| # from the template will be equal to: |
| # |
| # |
| # - If expressed as a fixed number, the minimum of either |
| # targetSize.fixed or |
| # instanceGroupManager.targetSize is used. |
| # - if expressed as a percent, the targetSize |
| # would be (targetSize.percent/100 * |
| # InstanceGroupManager.targetSize) If there is a remainder, the |
| # number is rounded. |
| # |
| # If unset, this version will update any remaining instances not |
| # updated by another version. ReadStarting |
| # a canary update for more information. |
| "calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the |
| # specific mode. |
| # |
| # |
| # |
| # - If the value is fixed, then the calculated |
| # value is equal to the fixed value. |
| # - If the value is a percent, then the |
| # calculated |
| # value is percent/100 * targetSize. For example, |
| # the calculated value of a 80% of a managed instance group |
| # with 150 instances would be (80/100 * 150) = 120 VM instances. If there |
| # is a remainder, the number is rounded. |
| "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer. |
| "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For |
| # example, specify 80 for 80%. |
| }, |
| }, |
| ], |
| "zone": "A String", # [Output Only] The URL of azone |
| # where the managed instance group is located (for zonal resources). |
| } |
| |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so |
| that if you must retry your request, the server will know to ignore the |
| request if it has already been completed. |
| |
| For example, consider a situation where you make an initial request and |
| the request times out. If you make the request again with the same |
| request ID, the server can check if original operation with the same |
| request ID was received, and if so, will ignore the second request. This |
| prevents clients from accidentally creating duplicate commitments. |
| |
| The request ID must be |
| a valid UUID with the exception that zero UUID is not supported |
| (00000000-0000-0000-0000-000000000000). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/beta/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/beta/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # |
| # - For global operations, use the `globalOperations` |
| # resource. |
| # - For regional operations, use the |
| # `regionOperations` resource. |
| # - For zonal operations, use |
| # the `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. |
| # Not present otherwise. |
| "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| "description": "A String", # [Output Only] A textual description of the operation, which is |
| # set when the operation is created. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 |
| # text format. |
| "error": { # [Output Only] If errors are generated during processing of the operation, |
| # this field will be populated. |
| "errors": [ # [Output Only] The array of errors encountered while processing this |
| # operation. |
| { |
| "code": "A String", # [Output Only] The error type identifier for this error. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| }, |
| ], |
| }, |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error |
| # message that was returned, such as `NOT FOUND`. |
| "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. |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is |
| # defined by the server. |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. |
| # This value is inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, |
| # `update`, or `delete`, and so on. |
| "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. |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only |
| # applicable when performing regional operations. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # text format. |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the |
| # following: |
| # `PENDING`, `RUNNING`, or `DONE`. |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the |
| # operation. |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation |
| # of the target resource. |
| "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For |
| # operations related to creating a snapshot, this points to the disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `[email protected]` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the |
| # operation, this field will be populated. |
| { |
| "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. |
| "data": [ # [Output Only] Metadata about this warning in key: |
| # value format. For example: |
| # |
| # "data": [ |
| # { |
| # "key": "scope", |
| # "value": "zones/us-east1-d" |
| # } |
| { |
| "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). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| ], |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only |
| # applicable when performing per-zone operations. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="updatePerInstanceConfigs">updatePerInstanceConfigs(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code> |
| <pre>Inserts or updates per-instance configurations for the managed instance |
| group. perInstanceConfig.name serves as a key used to |
| distinguish whether to perform insert or patch. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, Name of the region scoping this request, should conform to RFC1035. (required) |
| instanceGroupManager: string, The name of the managed instance group. |
| It should conform to RFC1035. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # RegionInstanceGroupManagers.updatePerInstanceConfigs |
| "perInstanceConfigs": [ # The list of per-instance configurations to insert or patch on this managed |
| # instance group. |
| { |
| "fingerprint": "A String", # Fingerprint of this per-instance config. This field can be used in |
| # optimistic locking. It is ignored when inserting a per-instance |
| # config. An up-to-date fingerprint must be provided in order to update an |
| # existing per-instance configuration or the field needs to be unset. |
| "name": "A String", # The name of a per-instance configuration and its corresponding instance. |
| # Serves as a merge key during UpdatePerInstanceConfigs |
| # operations, that is, if a per-instance configuration with the same name |
| # exists then it will be updated, otherwise a new one will be created for the |
| # VM instance with the same name. An attempt to create a per-instance |
| # configuration for a VM instance that either doesn't exist or is not part |
| # of the group will result in an error. |
| "preservedState": { # Preserved state for a given instance. # The intended preserved state for the given instance. Does not contain |
| # preserved state generated from a stateful policy. |
| "disks": { # Preserved disks defined for this instance. |
| # This map is keyed with the device names of the disks. |
| "a_key": { |
| "autoDelete": "A String", # These stateful disks will never be deleted during autohealing, |
| # update, instance recreate operations. This flag is used to configure |
| # if the disk should be deleted after it is no longer used by the group, |
| # e.g. when the given instance or the whole MIG is deleted. |
| # Note: disks attached in READ_ONLY mode cannot be |
| # auto-deleted. |
| "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the |
| # disk in READ_WRITE mode. |
| "source": "A String", # The URL of the disk resource that is stateful and should be attached |
| # to the VM instance. |
| }, |
| }, |
| "externalIPs": { # Preserved external IPs defined for this instance. |
| # This map is keyed with the name of the network interface. |
| "a_key": { |
| "autoDelete": "A String", # These stateful IPs will never be released during autohealing, |
| # update or VM instance recreate operations. |
| # This flag is used to configure if the IP reservation should be deleted |
| # after it is no longer used by the group, e.g. when the given instance |
| # or the whole group is deleted. |
| "ipAddress": { # Ip address representation |
| "address": "A String", # The URL of the reservation for this IP address. |
| "literal": "A String", # An IPv4 internal network address to assign to the instance for this |
| # network interface. |
| }, |
| }, |
| }, |
| "internalIPs": { # Preserved internal IPs defined for this instance. |
| # This map is keyed with the name of the network interface. |
| "a_key": { |
| "autoDelete": "A String", # These stateful IPs will never be released during autohealing, |
| # update or VM instance recreate operations. |
| # This flag is used to configure if the IP reservation should be deleted |
| # after it is no longer used by the group, e.g. when the given instance |
| # or the whole group is deleted. |
| "ipAddress": { # Ip address representation |
| "address": "A String", # The URL of the reservation for this IP address. |
| "literal": "A String", # An IPv4 internal network address to assign to the instance for this |
| # network interface. |
| }, |
| }, |
| }, |
| "metadata": { # Preserved metadata defined for this instance. |
| "a_key": "A String", |
| }, |
| }, |
| "status": "A String", # The status of applying this per-instance configuration on the corresponding |
| # managed instance. |
| }, |
| ], |
| } |
| |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so |
| that if you must retry your request, the server will know to ignore the |
| request if it has already been completed. |
| |
| For example, consider a situation where you make an initial request and |
| the request times out. If you make the request again with the same |
| request ID, the server can check if original operation with the same |
| request ID was received, and if so, will ignore the second request. This |
| prevents clients from accidentally creating duplicate commitments. |
| |
| The request ID must be |
| a valid UUID with the exception that zero UUID is not supported |
| (00000000-0000-0000-0000-000000000000). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/beta/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/beta/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # |
| # - For global operations, use the `globalOperations` |
| # resource. |
| # - For regional operations, use the |
| # `regionOperations` resource. |
| # - For zonal operations, use |
| # the `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. |
| # Not present otherwise. |
| "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| "description": "A String", # [Output Only] A textual description of the operation, which is |
| # set when the operation is created. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 |
| # text format. |
| "error": { # [Output Only] If errors are generated during processing of the operation, |
| # this field will be populated. |
| "errors": [ # [Output Only] The array of errors encountered while processing this |
| # operation. |
| { |
| "code": "A String", # [Output Only] The error type identifier for this error. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| }, |
| ], |
| }, |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error |
| # message that was returned, such as `NOT FOUND`. |
| "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. |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is |
| # defined by the server. |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. |
| # This value is inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, |
| # `update`, or `delete`, and so on. |
| "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. |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only |
| # applicable when performing regional operations. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # text format. |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the |
| # following: |
| # `PENDING`, `RUNNING`, or `DONE`. |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the |
| # operation. |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation |
| # of the target resource. |
| "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For |
| # operations related to creating a snapshot, this points to the disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `[email protected]` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the |
| # operation, this field will be populated. |
| { |
| "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. |
| "data": [ # [Output Only] Metadata about this warning in key: |
| # value format. For example: |
| # |
| # "data": [ |
| # { |
| # "key": "scope", |
| # "value": "zones/us-east1-d" |
| # } |
| { |
| "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). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| ], |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only |
| # applicable when performing per-zone operations. |
| }</pre> |
| </div> |
| |
| </body></html> |
