Blame - docs/dyn/compute_beta.instanceGroupManagers.html - platform/external/python/google-api-python-client

2016-10-21 13:59:49 -0700

[diff] [blame]

80

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

81

<code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

82

<p class="firstline">Retrieves the list of managed instance groups and groups them by zone.</p>

83

84

<code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>

85

<p class="firstline">Retrieves the next page of results.</p>

86

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

87

<code><a href="#applyUpdatesToInstances">applyUpdatesToInstances(project, zone, instanceGroupManager, body=None)</a></code></p>

88

<p class="firstline">Applies changes to selected instances on the managed instance group. This method can be used to apply new overrides and/or new versions.</p>

89

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

90

<code><a href="#close">close()</a></code></p>

91

<p class="firstline">Close httplib2 connections.</p>

92

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

93

<code><a href="#createInstances">createInstances(project, zone, instanceGroupManager, body=None, requestId=None)</a></code></p>

94

<p class="firstline">Creates instances with per-instance configs in this 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 the creating or actions with the listmanagedinstances method.</p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

95

96

<code><a href="#delete">delete(project, zone, instanceGroupManager, requestId=None)</a></code></p>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

97

<p class="firstline">Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information.</p>

98

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

99

<code><a href="#deleteInstances">deleteInstances(project, zone, instanceGroupManager, body=None, requestId=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

100

<p class="firstline">Flags the specified instances in the managed instance group for immediate deletion. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.</p>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

101

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

102

<code><a href="#deletePerInstanceConfigs">deletePerInstanceConfigs(project, zone, instanceGroupManager, body=None)</a></code></p>

103

<p class="firstline">Deletes selected per-instance configs for the managed instance group.</p>

104

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

105

<code><a href="#get">get(project, zone, instanceGroupManager)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

106

<p class="firstline">Returns all of the details about the specified managed instance group. Gets a list of available managed instance groups by making a list() request.</p>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

107

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

108

<code><a href="#insert">insert(project, zone, body=None, requestId=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

109

<p class="firstline">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 the listmanagedinstances method.</p>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

110

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

111

<code><a href="#list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

112

<p class="firstline">Retrieves a list of managed instance groups that are contained within the specified project and zone.</p>

113

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

114

<code><a href="#listErrors">listErrors(project, zone, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

115

<p class="firstline">Lists all errors thrown by actions on instances for a given managed instance group. The filter and orderBy query parameters are not supported.</p>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

116

117

<code><a href="#listErrors_next">listErrors_next(previous_request, previous_response)</a></code></p>

118

<p class="firstline">Retrieves the next page of results.</p>

119

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

120

<code><a href="#listManagedInstances">listManagedInstances(project, zone, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

121

<p class="firstline">Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action. The orderBy query parameter is not supported.</p>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

122

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

123

<code><a href="#listManagedInstances_next">listManagedInstances_next(previous_request, previous_response)</a></code></p>

124

<p class="firstline">Retrieves the next page of results.</p>

125

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

126

<code><a href="#listPerInstanceConfigs">listPerInstanceConfigs(project, zone, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

127

<p class="firstline">Lists all of the per-instance configs defined for the managed instance group. The orderBy query parameter is not supported.</p>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

128

129

<code><a href="#listPerInstanceConfigs_next">listPerInstanceConfigs_next(previous_request, previous_response)</a></code></p>

130

<p class="firstline">Retrieves the next page of results.</p>

131

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

132

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

133

<p class="firstline">Retrieves the next page of results.</p>

134

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

135

<code><a href="#patch">patch(project, zone, instanceGroupManager, body=None, requestId=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

136

<p class="firstline">Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is 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 supports PATCH semantics and uses the JSON merge patch format and processing rules.</p>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

137

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

138

<code><a href="#patchPerInstanceConfigs">patchPerInstanceConfigs(project, zone, instanceGroupManager, body=None, requestId=None)</a></code></p>

139

<p class="firstline">Inserts or patches per-instance configs for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.</p>

140

141

<code><a href="#recreateInstances">recreateInstances(project, zone, instanceGroupManager, body=None, requestId=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

142

<p class="firstline">Flags the specified instances in the managed instance group to be immediately recreated. The instances are deleted and recreated using the current instance template for the managed instance group. 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 the recreating action with the listmanagedinstances method.</p>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

143

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

144

<code><a href="#resize">resize(project, zone, instanceGroupManager, size, requestId=None)</a></code></p>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

145

<p class="firstline">Resizes 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 instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.</p>

146

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

147

<code><a href="#resizeAdvanced">resizeAdvanced(project, zone, instanceGroupManager, body=None, requestId=None)</a></code></p>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

148

<p class="firstline">Resizes the managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method.</p>

149

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

150

<code><a href="#setAutoHealingPolicies">setAutoHealingPolicies(project, zone, instanceGroupManager, body=None, requestId=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

151

<p class="firstline">Modifies the autohealing policies. [Deprecated] This method is deprecated. Please use Patch instead.</p>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

152

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

153

<code><a href="#setInstanceTemplate">setInstanceTemplate(project, zone, instanceGroupManager, body=None, requestId=None)</a></code></p>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

154

<p class="firstline">Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them.</p>

155

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

156

<code><a href="#setTargetPools">setTargetPools(project, zone, instanceGroupManager, body=None, requestId=None)</a></code></p>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

157

<p class="firstline">Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group.</p>

158

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

159

<code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body=None)</a></code></p>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

160

<p class="firstline">Returns permissions that a caller has on the specified resource.</p>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

161

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

162

<code><a href="#update">update(project, zone, instanceGroupManager, body=None, requestId=None)</a></code></p>

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

163

<p class="firstline">Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listManagedInstances method.</p>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

164

165

<code><a href="#updatePerInstanceConfigs">updatePerInstanceConfigs(project, zone, instanceGroupManager, body=None, requestId=None)</a></code></p>

166

<p class="firstline">Inserts or updates per-instance configs for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.</p>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

167

<h3>Method Details</h3>

168

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

169

<code class="details" id="abandonInstances">abandonInstances(project, zone, instanceGroupManager, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

170

<pre>Flags the specified instances to be 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 the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

171

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

172

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.

173

174

You can specify a maximum of 1000 instances with this method per request.

175

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

176

Args:

177

project: string, Project ID for this request. (required)

178

zone: string, The name of the zone where the managed instance group is located. (required)

179

instanceGroupManager: string, The name of the managed instance group. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

180

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

181

The object takes the form of:

182

183

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

184

"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].

185

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

],

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

189

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.

190

191

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.

192

193

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

194

195

Returns:

196

An object of the form:

197

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

198

{ # Represents an Operation resource.

199

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

200

# Google Compute Engine has three Operation resources:

201

#

202

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

203

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

204

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

205

#

206

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

207

# - For global operations, use the `globalOperations` resource.

208

# - For regional operations, use the `regionOperations` resource.

209

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

210

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

211

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

212

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

213

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

214

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

215

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

216

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

217

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

218

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

219

"code": "A String", # [Output Only] The error type identifier for this error.

220

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

221

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

222

},

223

],

224

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

225

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

226

"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.

227

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

228

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

229

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

230

"name": "A String", # [Output Only] Name of the operation.

231

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

232

"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.

233

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

234

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

235

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

236

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

237

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

238

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

239

"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 persistent disk that the snapshot was created from.

240

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

241

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

242

{

243

"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.

244

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

245

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

246

{

247

"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).

248

"value": "A String", # [Output Only] A warning data value corresponding to the key.

249

},

250

],

251

"message": "A String", # [Output Only] A human-readable description of the warning code.

252

},

253

],

254

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

259

<code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

260

<pre>Retrieves the list of managed instance groups and groups them by zone.

261

262

Args:

263

project: string, Project ID for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

264

filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

265

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

266

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

267

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

268

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 on resource labels.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

269

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

270

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) ```

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

271

includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

272

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`)

273

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

274

275

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.

276

277

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

278

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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

279

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

280

281

Returns:

282

An object of the form:

283

284

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

285

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

286

"items": { # A list of InstanceGroupManagersScopedList resources.

287

"a_key": { # [Output Only] The name of the scope that contains this set of managed instance groups.

288

"instanceGroupManagers": [ # [Output Only] The list of managed instance groups that are contained in the specified project and zone.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

289

{ # Represents a Managed Instance Group resource.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

290

#

291

# An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups.

292

#

293

# For zonal Managed Instance Group, use the instanceGroupManagers resource.

294

#

295

# For regional Managed Instance Group, use the regionInstanceGroupManagers resource. (== resource_for {$api_version}.instanceGroupManagers ==) (== resource_for {$api_version}.regionInstanceGroupManagers ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

296

"autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

297

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

298

"healthCheck": "A String", # The URL for the health check that signals autohealing.

299

"initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

300

},

301

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

302

"baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.

303

"creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.

304

"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.

305

"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.

306

"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.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

307

#

308

# If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

309

"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.

310

"deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.

311

"none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.

312

"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.

313

"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.

314

"restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.

315

"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.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

316

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

317

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

318

"distributionPolicy": { # Policy specifying intended distribution of instances in regional managed instance group.

319

"zones": [ # Zones where the regional managed instance group will create and manage instances.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

320

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

321

"zone": "A String", # The URL of the zone. The zone must exist in the region where the managed instance group is located.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

322

},

323

],

324

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

325

"failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.

326

"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 error 412 conditionNotMet.

327

#

328

# To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.

329

"id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.

330

"instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.

331

"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.

332

"kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.

333

"name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.

334

"namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.

335

{ # The named port. For example: .

336

"name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.

337

"port": 42, # The port number, which can be a value between 1 and 65535.

338

},

339

],

340

"pendingActions": { # [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions.

341

"creating": 42, # [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The number of instances in the managed instance group that are pending to be created.

342

"deleting": 42, # [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The number of instances in the managed instance group that are pending to be deleted.

343

"recreating": 42, # [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The number of instances in the managed instance group that are pending to be recreated.

344

"restarting": 42, # [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The number of instances in the managed instance group that are pending to be restarted.

345

},

346

"region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).

347

"selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.

348

"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.

349

"statefulPolicy": { # Stateful configuration for this Instanced Group Manager

350

"preservedState": { # Configuration of preserved resources.

351

"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.

352

"a_key": {

353

"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 in READ_ONLY mode cannot be auto-deleted.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

},

},

},

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

358

"status": { # [Output Only] The status of this managed instance group.

359

"autoscaler": "A String", # [Output Only] The URL of the Autoscaler that targets this instance group manager.

360

"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.

361

"stateful": { # [Output Only] Stateful status of the given Instance Group Manager.

362

"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 config 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.

363

"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 config 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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

364

"perInstanceConfigs": { # [Output Only] Status of per-instance configs on the instance.

365

"allEffective": True or False, # A bit indicating if all of the group's per-instance configs (listed in the output of a listPerInstanceConfigs API call) have status EFFECTIVE or there are no per-instance-configs.

366

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

367

},

368

"versionTarget": { # [Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager.

369

"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 by version field on Instance Group Manager.

370

},

371

},

372

"targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.

373

"A String",

374

],

375

"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.

376

"updatePolicy": { # The update policy for this managed instance group.

377

"instanceRedistributionType": "A String", # The instance redistribution policy for regional managed instance groups. Valid values are:

378

# - PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region.

379

# - NONE: For non-autoscaled groups, proactive redistribution is disabled.

380

"maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be created above the specified targetSize during the update process. By default, a fixed value of 1 is used. This value can be either a fixed number or a percentage if the instance group has 10 or more instances. If you set a percentage, the number of instances will be rounded up if necessary.

381

#

382

# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge.

383

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

384

#

385

#

386

# - If the value is fixed, then the calculated value is equal to the fixed value.

387

# - 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 up.

388

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

389

"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

390

},

391

"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:

392

#

393

#

394

# - The instance's status is RUNNING.

395

# - If there is a health check on the instance group, the instance's liveness health check result 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. By default, a fixed value of 1 is used. This value can be either a fixed number or a percentage if the instance group has 10 or more instances. If you set a percentage, the number of instances will be rounded up if necessary.

396

#

397

# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable.

398

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

399

#

400

#

401

# - If the value is fixed, then the calculated value is equal to the fixed value.

402

# - 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 up.

403

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

404

"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

405

},

406

"minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].

407

"minimalAction": "A String", # Minimal action to be taken on an instance. You can specify either RESTART to restart existing instances or REPLACE to delete and create new instances from the target template. If you specify a RESTART, the Updater will attempt to perform that action only. However, if the Updater determines that the minimal action you specify is not enough to perform the update, it might perform a more disruptive action.

408

"replacementMethod": "A String", # What action should be used to replace instances. See minimal_action.REPLACE

409

"type": "A String", # The type of update process. You can specify either PROACTIVE so that the instance group manager proactively executes actions in order to bring instances to their target versions or OPPORTUNISTIC so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls).

410

},

411

"versions": [ # Specifies the instance templates used by this managed instance group to create instances.

412

#

413

# Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates.

414

{

415

"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.

416

"name": "A String", # Name of the version. Unique among all versions in the scope of this managed instance group.

417

"targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Specifies the intended number of instances to be created from the instanceTemplate. The final number of instances created from the template will be equal to:

418

# - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used.

419

# - if expressed as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) If there is a remainder, the number is rounded up. If unset, this version will update any remaining instances not updated by another version. Read Starting a canary update for more information.

420

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

421

#

422

#

423

# - If the value is fixed, then the calculated value is equal to the fixed value.

424

# - 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 up.

425

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

426

"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 the zone where the managed instance group is located (for zonal resources).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

431

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

432

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

433

"warning": { # [Output Only] The warning that replaces the list of managed instance groups when the list is empty.

434

"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.

435

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

436

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

437

{

438

"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).

439

"value": "A String", # [Output Only] A warning data value corresponding to the key.

440

},

441

],

442

"message": "A String", # [Output Only] A human-readable description of the warning code.

443

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

444

},

445

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

446

"kind": "compute#instanceGroupManagerAggregatedList", # [Output Only] The resource type, which is always compute#instanceGroupManagerAggregatedList for an aggregated list of managed instance groups.

447

"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 than maxResults, 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.

448

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

449

"unreachables": [ # [Output Only] Unreachable resources.

450

"A String",

451

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

452

"warning": { # [Output Only] Informational warning message.

453

"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.

454

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

455

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

456

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

457

"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).

458

"value": "A String", # [Output Only] A warning data value corresponding to the key.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

459

},

460

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

461

"message": "A String", # [Output Only] A human-readable description of the warning code.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

462

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>

468

<pre>Retrieves the next page of results.

469

470

Args:

471

previous_request: The request for the previous page. (required)

472

previous_response: The response from the request for the previous page. (required)

473

474

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

475

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

476

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

481

<code class="details" id="applyUpdatesToInstances">applyUpdatesToInstances(project, zone, instanceGroupManager, body=None)</code>

482

<pre>Applies changes to selected instances on the managed instance group. This method can be used to apply new overrides and/or new versions.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

483

484

Args:

485

project: string, Project ID for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

486

zone: string, The name of the zone where the managed instance group is located. Should conform to RFC1035. (required)

487

instanceGroupManager: string, The name of the managed instance group, should conform to RFC1035. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

488

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

489

The object takes the form of:

490

491

{ # InstanceGroupManagers.applyUpdatesToInstances

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

492

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

493

"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 as zones/[ZONE]/instances/[INSTANCE_NAME].

494

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

495

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

496

"minimalAction": "A String", # The minimal action that you want to perform on each instance during the update:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

497

# - REPLACE: At minimum, delete the instance and create it again.

498

# - RESTART: Stop the instance and start it again.

499

# - REFRESH: Do not stop the instance.

500

# - 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

501

"mostDisruptiveAllowedAction": "A String", # The most disruptive action that you want to perform on each instance during the update:

502

# - REPLACE: Delete the instance and create it again.

503

# - RESTART: Stop the instance and start it again.

504

# - REFRESH: Do not stop the instance.

505

# - 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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

506

}

507

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

508

509

Returns:

510

An object of the form:

511

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

512

{ # Represents an Operation resource.

513

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

514

# Google Compute Engine has three Operation resources:

515

#

516

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

517

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

518

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

519

#

520

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

521

# - For global operations, use the `globalOperations` resource.

522

# - For regional operations, use the `regionOperations` resource.

523

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

524

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

525

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

526

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

527

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

528

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

529

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

530

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

531

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

532

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

533

"code": "A String", # [Output Only] The error type identifier for this error.

534

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

535

"message": "A String", # [Output Only] An optional, human-readable error message.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

536

},

537

],

538

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

539

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

540

"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.

541

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

542

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

543

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

544

"name": "A String", # [Output Only] Name of the operation.

545

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

546

"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.

547

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

548

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

549

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

550

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

551

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

552

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

553

"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 persistent disk that the snapshot was created from.

554

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

555

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

556

{

557

"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.

558

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

559

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

560

{

561

"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).

562

"value": "A String", # [Output Only] A warning data value corresponding to the key.

563

},

564

],

565

"message": "A String", # [Output Only] A human-readable description of the warning code.

566

},

567

],

568

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

573

<code class="details" id="close">close()</code>

574

<pre>Close httplib2 connections.</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

578

<code class="details" id="createInstances">createInstances(project, zone, instanceGroupManager, body=None, requestId=None)</code>

579

<pre>Creates instances with per-instance configs in this 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 the creating or actions with the listmanagedinstances method.

580

581

Args:

582

project: string, Project ID for this request. (required)

583

zone: string, The name of the zone where the managed instance group is located. It should conform to RFC1035. (required)

584

instanceGroupManager: string, The name of the managed instance group. It should conform to RFC1035. (required)

585

body: object, The request body.

586

The object takes the form of:

587

588

{ # InstanceGroupManagers.createInstances

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

589

"instances": [ # [Required] List of specifications of per-instance configs.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

590

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

591

"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 config or the field needs to be unset.

592

"name": "A String", # The name of a per-instance config and its corresponding instance. Serves as a merge key during UpdatePerInstanceConfigs operations, that is, if a per-instance config 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 config for a VM instance that either doesn't exist or is not part of the group will result in an error.

593

"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.

594

"disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks.

595

"a_key": {

596

"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.

597

"mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.

598

"source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

599

},

600

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

601

"metadata": { # Preserved metadata defined for this instance.

602

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

603

},

604

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

605

"status": "A String", # The status of applying this per-instance config on the corresponding managed instance.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

},

],

}

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.

611

612

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.

613

614

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

615

616

Returns:

617

An object of the form:

618

619

{ # Represents an Operation resource.

620

#

621

# Google Compute Engine has three Operation resources:

622

#

623

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

624

#

625

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

626

#

627

# Operations can be global, regional or zonal.

628

# - For global operations, use the `globalOperations` resource.

629

# - For regional operations, use the `regionOperations` resource.

630

# - For zonal operations, use the `zonalOperations` resource.

631

#

632

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

633

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

634

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

635

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

636

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

637

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

638

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

639

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

640

"code": "A String", # [Output Only] The error type identifier for this error.

641

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

642

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

643

},

644

],

645

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

646

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

647

"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.

648

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

649

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

650

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

651

"name": "A String", # [Output Only] Name of the operation.

652

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

653

"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.

654

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

655

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

656

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

657

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

658

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

659

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

660

"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 persistent disk that the snapshot was created from.

661

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

662

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

663

{

664

"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.

665

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

666

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

667

{

668

"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).

669

"value": "A String", # [Output Only] A warning data value corresponding to the key.

670

},

671

],

672

"message": "A String", # [Output Only] A human-readable description of the warning code.

673

},

674

],

675

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

680

<code class="details" id="delete">delete(project, zone, instanceGroupManager, requestId=None)</code>

681

<pre>Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information.

682

683

Args:

684

project: string, Project ID for this request. (required)

685

zone: string, The name of the zone where the managed instance group is located. (required)

686

instanceGroupManager: string, The name of the managed instance group to delete. (required)

687

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.

688

689

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.

690

691

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

692

693

Returns:

694

An object of the form:

695

696

{ # Represents an Operation resource.

697

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

698

# Google Compute Engine has three Operation resources:

699

#

700

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

701

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

702

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

703

#

704

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

705

# - For global operations, use the `globalOperations` resource.

706

# - For regional operations, use the `regionOperations` resource.

707

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

708

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

709

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

710

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

711

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

712

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

713

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

714

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

715

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

716

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

717

"code": "A String", # [Output Only] The error type identifier for this error.

718

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

719

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

720

},

721

],

722

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

723

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

724

"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.

725

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

726

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

727

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

728

"name": "A String", # [Output Only] Name of the operation.

729

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

730

"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.

731

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

732

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

733

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

734

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

735

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

736

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

737

"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 persistent disk that the snapshot was created from.

738

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

739

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

740

{

741

"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.

742

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

743

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

744

{

745

"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).

746

"value": "A String", # [Output Only] A warning data value corresponding to the key.

747

},

748

],

749

"message": "A String", # [Output Only] A human-readable description of the warning code.

750

},

751

],

752

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

757

<code class="details" id="deleteInstances">deleteInstances(project, zone, instanceGroupManager, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

758

<pre>Flags the specified instances in the managed instance group for immediate deletion. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

759

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

760

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.

761

762

You can specify a maximum of 1000 instances with this method per request.

763

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

764

Args:

765

project: string, Project ID for this request. (required)

766

zone: string, The name of the zone where the managed instance group is located. (required)

767

instanceGroupManager: string, The name of the managed instance group. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

768

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

769

The object takes the form of:

770

771

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

772

"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].

773

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

],

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

777

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.

778

779

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.

780

781

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

782

783

Returns:

784

An object of the form:

785

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

786

{ # Represents an Operation resource.

787

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

788

# Google Compute Engine has three Operation resources:

789

#

790

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

791

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

792

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

793

#

794

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

795

# - For global operations, use the `globalOperations` resource.

796

# - For regional operations, use the `regionOperations` resource.

797

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

798

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

799

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

800

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

801

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

802

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

803

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

804

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

805

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

806

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

807

"code": "A String", # [Output Only] The error type identifier for this error.

808

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

809

"message": "A String", # [Output Only] An optional, human-readable error message.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

810

},

811

],

812

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

813

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

814

"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.

815

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

816

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

817

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

818

"name": "A String", # [Output Only] Name of the operation.

819

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

820

"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.

821

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

822

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

823

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

824

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

825

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

826

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

827

"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 persistent disk that the snapshot was created from.

828

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

829

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

830

{

831

"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.

832

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

833

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

834

{

835

"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).

836

"value": "A String", # [Output Only] A warning data value corresponding to the key.

837

},

838

],

839

"message": "A String", # [Output Only] A human-readable description of the warning code.

840

},

841

],

842

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="deletePerInstanceConfigs">deletePerInstanceConfigs(project, zone, instanceGroupManager, body=None)</code>

848

<pre>Deletes selected per-instance configs for the managed instance group.

849

850

Args:

851

project: string, Project ID for this request. (required)

852

zone: string, The name of the zone where the managed instance group is located. It should conform to RFC1035. (required)

853

instanceGroupManager: string, The name of the managed instance group. It should conform to RFC1035. (required)

854

body: object, The request body.

855

The object takes the form of:

856

857

{ # InstanceGroupManagers.deletePerInstanceConfigs

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

858

"names": [ # The list of instance names for which we want to delete per-instance configs on this managed instance group.

859

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

],

}

Returns:

An object of the form:

866

867

{ # Represents an Operation resource.

868

#

869

# Google Compute Engine has three Operation resources:

870

#

871

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

872

#

873

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

874

#

875

# Operations can be global, regional or zonal.

876

# - For global operations, use the `globalOperations` resource.

877

# - For regional operations, use the `regionOperations` resource.

878

# - For zonal operations, use the `zonalOperations` resource.

879

#

880

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

881

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

882

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

883

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

884

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

885

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

886

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

887

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

888

"code": "A String", # [Output Only] The error type identifier for this error.

889

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

890

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

891

},

892

],

893

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

894

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

895

"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.

896

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

897

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

898

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

899

"name": "A String", # [Output Only] Name of the operation.

900

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

901

"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.

902

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

903

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

904

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

905

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

906

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

907

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

908

"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 persistent disk that the snapshot was created from.

909

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

910

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

911

{

912

"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.

913

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

914

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

915

{

916

"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).

917

"value": "A String", # [Output Only] A warning data value corresponding to the key.

918

},

919

],

920

"message": "A String", # [Output Only] A human-readable description of the warning code.

921

},

922

],

923

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="get">get(project, zone, instanceGroupManager)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

929

<pre>Returns all of the details about the specified managed instance group. Gets a list of available managed instance groups by making a list() request.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

930

931

Args:

932

project: string, Project ID for this request. (required)

933

zone: string, The name of the zone where the managed instance group is located. (required)

934

instanceGroupManager: string, The name of the managed instance group. (required)

935

936

Returns:

937

An object of the form:

938

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

939

{ # Represents a Managed Instance Group resource.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

940

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

941

# An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

942

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

943

# For zonal Managed Instance Group, use the instanceGroupManagers resource.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

944

#

945

# For regional Managed Instance Group, use the regionInstanceGroupManagers resource. (== resource_for {$api_version}.instanceGroupManagers ==) (== resource_for {$api_version}.regionInstanceGroupManagers ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

946

"autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

947

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

948

"healthCheck": "A String", # The URL for the health check that signals autohealing.

949

"initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

950

},

951

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

952

"baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.

953

"creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.

954

"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.

955

"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.

956

"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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

957

#

958

# If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

959

"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.

960

"deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.

961

"none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.

962

"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.

963

"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.

964

"restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.

965

"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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

966

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

967

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

968

"distributionPolicy": { # Policy specifying intended distribution of instances in regional managed instance group.

969

"zones": [ # Zones where the regional managed instance group will create and manage instances.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

970

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

971

"zone": "A String", # The URL of the zone. The zone must exist in the region where the managed instance group is located.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

972

},

973

],

974

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

975

"failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.

976

"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 error 412 conditionNotMet.

977

#

978

# To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.

979

"id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.

980

"instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.

981

"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.

982

"kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.

983

"name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.

984

"namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.

985

{ # The named port. For example: .

986

"name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.

987

"port": 42, # The port number, which can be a value between 1 and 65535.

988

},

989

],

990

"pendingActions": { # [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions.

991

"creating": 42, # [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The number of instances in the managed instance group that are pending to be created.

992

"deleting": 42, # [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The number of instances in the managed instance group that are pending to be deleted.

993

"recreating": 42, # [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The number of instances in the managed instance group that are pending to be recreated.

994

"restarting": 42, # [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The number of instances in the managed instance group that are pending to be restarted.

995

},

996

"region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).

997

"selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.

998

"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.

999

"statefulPolicy": { # Stateful configuration for this Instanced Group Manager

1000

"preservedState": { # Configuration of preserved resources.

1001

"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.

1002

"a_key": {

1003

"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 in READ_ONLY mode cannot be auto-deleted.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

},

},

},

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1008

"status": { # [Output Only] The status of this managed instance group.

1009

"autoscaler": "A String", # [Output Only] The URL of the Autoscaler that targets this instance group manager.

1010

"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.

1011

"stateful": { # [Output Only] Stateful status of the given Instance Group Manager.

1012

"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 config 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.

1013

"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 config 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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1014

"perInstanceConfigs": { # [Output Only] Status of per-instance configs on the instance.

1015

"allEffective": True or False, # A bit indicating if all of the group's per-instance configs (listed in the output of a listPerInstanceConfigs API call) have status EFFECTIVE or there are no per-instance-configs.

1016

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1017

},

1018

"versionTarget": { # [Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager.

1019

"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 by version field on Instance Group Manager.

1020

},

1021

},

1022

"targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.

1023

"A String",

1024

],

1025

"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.

1026

"updatePolicy": { # The update policy for this managed instance group.

1027

"instanceRedistributionType": "A String", # The instance redistribution policy for regional managed instance groups. Valid values are:

1028

# - PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region.

1029

# - NONE: For non-autoscaled groups, proactive redistribution is disabled.

1030

"maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be created above the specified targetSize during the update process. By default, a fixed value of 1 is used. This value can be either a fixed number or a percentage if the instance group has 10 or more instances. If you set a percentage, the number of instances will be rounded up if necessary.

1031

#

1032

# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge.

1033

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

1034

#

1035

#

1036

# - If the value is fixed, then the calculated value is equal to the fixed value.

1037

# - 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 up.

1038

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

1039

"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

1040

},

1041

"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:

1042

#

1043

#

1044

# - The instance's status is RUNNING.

1045

# - If there is a health check on the instance group, the instance's liveness health check result 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. By default, a fixed value of 1 is used. This value can be either a fixed number or a percentage if the instance group has 10 or more instances. If you set a percentage, the number of instances will be rounded up if necessary.

1046

#

1047

# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable.

1048

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

1049

#

1050

#

1051

# - If the value is fixed, then the calculated value is equal to the fixed value.

1052

# - 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 up.

1053

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

1054

"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

1055

},

1056

"minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].

1057

"minimalAction": "A String", # Minimal action to be taken on an instance. You can specify either RESTART to restart existing instances or REPLACE to delete and create new instances from the target template. If you specify a RESTART, the Updater will attempt to perform that action only. However, if the Updater determines that the minimal action you specify is not enough to perform the update, it might perform a more disruptive action.

1058

"replacementMethod": "A String", # What action should be used to replace instances. See minimal_action.REPLACE

1059

"type": "A String", # The type of update process. You can specify either PROACTIVE so that the instance group manager proactively executes actions in order to bring instances to their target versions or OPPORTUNISTIC so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls).

1060

},

1061

"versions": [ # Specifies the instance templates used by this managed instance group to create instances.

1062

#

1063

# Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates.

1064

{

1065

"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.

1066

"name": "A String", # Name of the version. Unique among all versions in the scope of this managed instance group.

1067

"targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Specifies the intended number of instances to be created from the instanceTemplate. The final number of instances created from the template will be equal to:

1068

# - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used.

1069

# - if expressed as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) If there is a remainder, the number is rounded up. If unset, this version will update any remaining instances not updated by another version. Read Starting a canary update for more information.

1070

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

1071

#

1072

#

1073

# - If the value is fixed, then the calculated value is equal to the fixed value.

1074

# - 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 up.

1075

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

1076

"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 the zone where the managed instance group is located (for zonal resources).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="insert">insert(project, zone, body=None, requestId=None)</code>

1086

<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 the listmanagedinstances method.

1087

1088

A managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit.

1089

1090

Args:

1091

project: string, Project ID for this request. (required)

1092

zone: string, The name of the zone where you want to create the managed instance group. (required)

1093

body: object, The request body.

1094

The object takes the form of:

1095

1096

{ # Represents a Managed Instance Group resource.

1097

#

1098

# An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups.

1099

#

1100

# For zonal Managed Instance Group, use the instanceGroupManagers resource.

1101

#

1102

# For regional Managed Instance Group, use the regionInstanceGroupManagers resource. (== resource_for {$api_version}.instanceGroupManagers ==) (== resource_for {$api_version}.regionInstanceGroupManagers ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1103

"autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1104

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1105

"healthCheck": "A String", # The URL for the health check that signals autohealing.

1106

"initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1107

},

1108

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1109

"baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.

1110

"creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.

1111

"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.

1112

"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.

1113

"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.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1114

#

1115

# If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1116

"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.

1117

"deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.

1118

"none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.

1119

"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.

1120

"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.

1121

"restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.

1122

"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.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1123

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1124

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

1125

"distributionPolicy": { # Policy specifying intended distribution of instances in regional managed instance group.

1126

"zones": [ # Zones where the regional managed instance group will create and manage instances.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1127

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1128

"zone": "A String", # The URL of the zone. The zone must exist in the region where the managed instance group is located.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1129

},

1130

],

1131

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1132

"failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.

1133

"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 error 412 conditionNotMet.

1134

#

1135

# To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.

1136

"id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.

1137

"instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.

1138

"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.

1139

"kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.

1140

"name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.

1141

"namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.

1142

{ # The named port. For example: .

1143

"name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.

1144

"port": 42, # The port number, which can be a value between 1 and 65535.

1145

},

1146

],

1147

"pendingActions": { # [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions.

1148

"creating": 42, # [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The number of instances in the managed instance group that are pending to be created.

1149

"deleting": 42, # [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The number of instances in the managed instance group that are pending to be deleted.

1150

"recreating": 42, # [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The number of instances in the managed instance group that are pending to be recreated.

1151

"restarting": 42, # [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The number of instances in the managed instance group that are pending to be restarted.

1152

},

1153

"region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).

1154

"selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.

1155

"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.

1156

"statefulPolicy": { # Stateful configuration for this Instanced Group Manager

1157

"preservedState": { # Configuration of preserved resources.

1158

"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.

1159

"a_key": {

1160

"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 in READ_ONLY mode cannot be auto-deleted.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

},

},

},

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1165

"status": { # [Output Only] The status of this managed instance group.

1166

"autoscaler": "A String", # [Output Only] The URL of the Autoscaler that targets this instance group manager.

1167

"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.

1168

"stateful": { # [Output Only] Stateful status of the given Instance Group Manager.

1169

"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 config 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.

1170

"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 config 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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1171

"perInstanceConfigs": { # [Output Only] Status of per-instance configs on the instance.

1172

"allEffective": True or False, # A bit indicating if all of the group's per-instance configs (listed in the output of a listPerInstanceConfigs API call) have status EFFECTIVE or there are no per-instance-configs.

1173

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1174

},

1175

"versionTarget": { # [Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager.

1176

"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 by version field on Instance Group Manager.

1177

},

1178

},

1179

"targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.

1180

"A String",

1181

],

1182

"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.

1183

"updatePolicy": { # The update policy for this managed instance group.

1184

"instanceRedistributionType": "A String", # The instance redistribution policy for regional managed instance groups. Valid values are:

1185

# - PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region.

1186

# - NONE: For non-autoscaled groups, proactive redistribution is disabled.

1187

"maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be created above the specified targetSize during the update process. By default, a fixed value of 1 is used. This value can be either a fixed number or a percentage if the instance group has 10 or more instances. If you set a percentage, the number of instances will be rounded up if necessary.

1188

#

1189

# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge.

1190

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

1191

#

1192

#

1193

# - If the value is fixed, then the calculated value is equal to the fixed value.

1194

# - 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 up.

1195

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

1196

"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

1197

},

1198

"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:

1199

#

1200

#

1201

# - The instance's status is RUNNING.

1202

# - If there is a health check on the instance group, the instance's liveness health check result 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. By default, a fixed value of 1 is used. This value can be either a fixed number or a percentage if the instance group has 10 or more instances. If you set a percentage, the number of instances will be rounded up if necessary.

1203

#

1204

# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable.

1205

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

1206

#

1207

#

1208

# - If the value is fixed, then the calculated value is equal to the fixed value.

1209

# - 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 up.

1210

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

1211

"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

1212

},

1213

"minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].

1214

"minimalAction": "A String", # Minimal action to be taken on an instance. You can specify either RESTART to restart existing instances or REPLACE to delete and create new instances from the target template. If you specify a RESTART, the Updater will attempt to perform that action only. However, if the Updater determines that the minimal action you specify is not enough to perform the update, it might perform a more disruptive action.

1215

"replacementMethod": "A String", # What action should be used to replace instances. See minimal_action.REPLACE

1216

"type": "A String", # The type of update process. You can specify either PROACTIVE so that the instance group manager proactively executes actions in order to bring instances to their target versions or OPPORTUNISTIC so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls).

1217

},

1218

"versions": [ # Specifies the instance templates used by this managed instance group to create instances.

1219

#

1220

# Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates.

1221

{

1222

"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.

1223

"name": "A String", # Name of the version. Unique among all versions in the scope of this managed instance group.

1224

"targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Specifies the intended number of instances to be created from the instanceTemplate. The final number of instances created from the template will be equal to:

1225

# - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used.

1226

# - if expressed as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) If there is a remainder, the number is rounded up. If unset, this version will update any remaining instances not updated by another version. Read Starting a canary update for more information.

1227

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

1228

#

1229

#

1230

# - If the value is fixed, then the calculated value is equal to the fixed value.

1231

# - 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 up.

1232

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

1233

"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 the zone where the managed instance group is located (for zonal resources).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1238

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1239

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1240

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.

1241

1242

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.

1243

1244

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1245

1246

Returns:

1247

An object of the form:

1248

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1249

{ # Represents an Operation resource.

1250

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1251

# Google Compute Engine has three Operation resources:

1252

#

1253

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

1254

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1255

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

1256

#

1257

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1258

# - For global operations, use the `globalOperations` resource.

1259

# - For regional operations, use the `regionOperations` resource.

1260

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1261

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1262

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1263

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1264

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1265

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1266

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1267

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1268

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1269

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1270

"code": "A String", # [Output Only] The error type identifier for this error.

1271

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1272

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1273

},

1274

],

1275

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1276

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1277

"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.

1278

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

1279

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1280

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1281

"name": "A String", # [Output Only] Name of the operation.

1282

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1283

"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.

1284

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

1285

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1286

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1287

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

1288

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1289

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1290

"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 persistent disk that the snapshot was created from.

1291

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1292

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1293

{

1294

"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.

1295

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1296

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

1297

{

1298

"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).

1299

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1300

},

1301

],

1302

"message": "A String", # [Output Only] A human-readable description of the warning code.

1303

},

1304

],

1305

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1310

<code class="details" id="list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1311

<pre>Retrieves a list of managed instance groups that are contained within the specified project and zone.

1312

1313

Args:

1314

project: string, Project ID for this request. (required)

1315

zone: string, The name of the zone where the managed instance group is located. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1316

filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1317

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1318

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1319

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1320

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 on resource labels.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1321

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1322

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) ```

1323

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`)

1324

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

1325

1326

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.

1327

1328

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

1329

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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1330

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1331

1332

Returns:

1333

An object of the form:

1334

1335

{ # [Output Only] A list of managed instance groups.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1336

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

1337

"items": [ # A list of InstanceGroupManager resources.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1338

{ # Represents a Managed Instance Group resource.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1339

#

1340

# An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups.

1341

#

1342

# For zonal Managed Instance Group, use the instanceGroupManagers resource.

1343

#

1344

# For regional Managed Instance Group, use the regionInstanceGroupManagers resource. (== resource_for {$api_version}.instanceGroupManagers ==) (== resource_for {$api_version}.regionInstanceGroupManagers ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1345

"autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1346

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1347

"healthCheck": "A String", # The URL for the health check that signals autohealing.

1348

"initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1349

},

1350

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1351

"baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.

1352

"creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.

1353

"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.

1354

"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.

1355

"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.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1356

#

1357

# If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1358

"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.

1359

"deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.

1360

"none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.

1361

"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.

1362

"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.

1363

"restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.

1364

"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.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1365

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1366

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

1367

"distributionPolicy": { # Policy specifying intended distribution of instances in regional managed instance group.

1368

"zones": [ # Zones where the regional managed instance group will create and manage instances.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1369

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1370

"zone": "A String", # The URL of the zone. The zone must exist in the region where the managed instance group is located.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1371

},

1372

],

1373

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1374

"failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.

1375

"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 error 412 conditionNotMet.

1376

#

1377

# To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.

1378

"id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.

1379

"instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.

1380

"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.

1381

"kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.

1382

"name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.

1383

"namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.

1384

{ # The named port. For example: .

1385

"name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.

1386

"port": 42, # The port number, which can be a value between 1 and 65535.

1387

},

1388

],

1389

"pendingActions": { # [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions.

1390

"creating": 42, # [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The number of instances in the managed instance group that are pending to be created.

1391

"deleting": 42, # [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The number of instances in the managed instance group that are pending to be deleted.

1392

"recreating": 42, # [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The number of instances in the managed instance group that are pending to be recreated.

1393

"restarting": 42, # [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The number of instances in the managed instance group that are pending to be restarted.

1394

},

1395

"region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).

1396

"selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.

1397

"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.

1398

"statefulPolicy": { # Stateful configuration for this Instanced Group Manager

1399

"preservedState": { # Configuration of preserved resources.

1400

"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.

1401

"a_key": {

1402

"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 in READ_ONLY mode cannot be auto-deleted.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

},

},

},

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1407

"status": { # [Output Only] The status of this managed instance group.

1408

"autoscaler": "A String", # [Output Only] The URL of the Autoscaler that targets this instance group manager.

1409

"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.

1410

"stateful": { # [Output Only] Stateful status of the given Instance Group Manager.

1411

"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 config 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.

1412

"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 config 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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1413

"perInstanceConfigs": { # [Output Only] Status of per-instance configs on the instance.

1414

"allEffective": True or False, # A bit indicating if all of the group's per-instance configs (listed in the output of a listPerInstanceConfigs API call) have status EFFECTIVE or there are no per-instance-configs.

1415

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1416

},

1417

"versionTarget": { # [Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager.

1418

"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 by version field on Instance Group Manager.

1419

},

1420

},

1421

"targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.

1422

"A String",

1423

],

1424

"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.

1425

"updatePolicy": { # The update policy for this managed instance group.

1426

"instanceRedistributionType": "A String", # The instance redistribution policy for regional managed instance groups. Valid values are:

1427

# - PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region.

1428

# - NONE: For non-autoscaled groups, proactive redistribution is disabled.

1429

"maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be created above the specified targetSize during the update process. By default, a fixed value of 1 is used. This value can be either a fixed number or a percentage if the instance group has 10 or more instances. If you set a percentage, the number of instances will be rounded up if necessary.

1430

#

1431

# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge.

1432

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

1433

#

1434

#

1435

# - If the value is fixed, then the calculated value is equal to the fixed value.

1436

# - 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 up.

1437

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

1438

"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

1439

},

1440

"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:

1441

#

1442

#

1443

# - The instance's status is RUNNING.

1444

# - If there is a health check on the instance group, the instance's liveness health check result 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. By default, a fixed value of 1 is used. This value can be either a fixed number or a percentage if the instance group has 10 or more instances. If you set a percentage, the number of instances will be rounded up if necessary.

1445

#

1446

# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable.

1447

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

1448

#

1449

#

1450

# - If the value is fixed, then the calculated value is equal to the fixed value.

1451

# - 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 up.

1452

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

1453

"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

1454

},

1455

"minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].

1456

"minimalAction": "A String", # Minimal action to be taken on an instance. You can specify either RESTART to restart existing instances or REPLACE to delete and create new instances from the target template. If you specify a RESTART, the Updater will attempt to perform that action only. However, if the Updater determines that the minimal action you specify is not enough to perform the update, it might perform a more disruptive action.

1457

"replacementMethod": "A String", # What action should be used to replace instances. See minimal_action.REPLACE

1458

"type": "A String", # The type of update process. You can specify either PROACTIVE so that the instance group manager proactively executes actions in order to bring instances to their target versions or OPPORTUNISTIC so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls).

1459

},

1460

"versions": [ # Specifies the instance templates used by this managed instance group to create instances.

1461

#

1462

# Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates.

1463

{

1464

"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.

1465

"name": "A String", # Name of the version. Unique among all versions in the scope of this managed instance group.

1466

"targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Specifies the intended number of instances to be created from the instanceTemplate. The final number of instances created from the template will be equal to:

1467

# - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used.

1468

# - if expressed as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) If there is a remainder, the number is rounded up. If unset, this version will update any remaining instances not updated by another version. Read Starting a canary update for more information.

1469

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

1470

#

1471

#

1472

# - If the value is fixed, then the calculated value is equal to the fixed value.

1473

# - 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 up.

1474

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

1475

"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 the zone where the managed instance group is located (for zonal resources).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1480

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1481

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1482

"kind": "compute#instanceGroupManagerList", # [Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups.

1483

"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 than maxResults, 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.

1484

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

1485

"warning": { # [Output Only] Informational warning message.

1486

"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.

1487

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1488

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1489

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1490

"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).

1491

"value": "A String", # [Output Only] A warning data value corresponding to the key.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1492

},

1493

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1494

"message": "A String", # [Output Only] A human-readable description of the warning code.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1495

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1500

<code class="details" id="listErrors">listErrors(project, zone, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1501

<pre>Lists all errors thrown by actions on instances for a given managed instance group. The filter and orderBy query parameters are not supported.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1502

1503

Args:

1504

project: string, Project ID for this request. (required)

1505

zone: string, The name of the zone where the managed instance group is located. It should conform to RFC1035. (required)

1506

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-9]{0,19}. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1507

filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.

1508

1509

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

1510

1511

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 on resource labels.

1512

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1513

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) ```

1514

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`)

1515

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

1516

1517

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.

1518

1519

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

1520

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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1521

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1522

1523

Returns:

1524

An object of the form:

1525

1526

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1527

"items": [ # [Output Only] The list of errors of the managed instance group.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1528

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1529

"error": { # [Output Only] Contents of the error.

1530

"code": "A String", # [Output Only] Error code.

1531

"message": "A String", # [Output Only] Error message.

1532

},

1533

"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.

1534

"action": "A String", # [Output Only] Action that managed instance group was executing on the instance when the error occurred. Possible values:

1535

"instance": "A String", # [Output Only] The URL of the instance. The URL can be set even if the instance has not yet been created.

1536

"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.

1537

"instanceTemplate": "A String", # [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }.

1538

"name": "A String", # [Output Only] Name of the version.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1539

},

1540

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1541

"timestamp": "A String", # [Output Only] The time that this error occurred. This value is in RFC3339 text format.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1542

},

1543

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1544

"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 than maxResults, 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.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="listErrors_next">listErrors_next(previous_request, previous_response)</code>

1550

<pre>Retrieves the next page of results.

1551

1552

Args:

1553

previous_request: The request for the previous page. (required)

1554

previous_response: The response from the request for the previous page. (required)

1555

1556

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1557

A request object that you can call 'execute()' on to request the next

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1558

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1563

<code class="details" id="listManagedInstances">listManagedInstances(project, zone, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1564

<pre>Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action. The orderBy query parameter is not supported.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1565

1566

Args:

1567

project: string, Project ID for this request. (required)

1568

zone: string, The name of the zone where the managed instance group is located. (required)

1569

instanceGroupManager: string, The name of the managed instance group. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1570

filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1571

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1572

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1573

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1574

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 on resource labels.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1575

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1576

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) ```

1577

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`)

1578

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

1579

1580

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.

1581

1582

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

1583

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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1584

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1585

1586

Returns:

1587

An object of the form:

1588

1589

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1590

"managedInstances": [ # [Output Only] The list of instances in the managed instance group.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1591

{ # A Managed Instance resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1592

"currentAction": "A String", # [Output Only] The current action that the managed instance group has scheduled for the instance. Possible values:

Sai Cheemalapati

e833b79

2017-03-24 15:06:46 -0700

[diff] [blame]

1593

# - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance.

1594

# - 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1595

# - CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased instead.

Sai Cheemalapati

e833b79

2017-03-24 15:06:46 -0700

[diff] [blame]

1596

# - RECREATING The managed instance group is recreating this instance.

1597

# - DELETING The managed instance group is permanently deleting this instance.

1598

# - 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.

1599

# - RESTARTING The managed instance group is restarting the instance.

1600

# - 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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1601

# - VERIFYING The managed instance group has created the instance and it is in the process of being verified.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1602

"id": "A String", # [Output only] The unique identifier for this resource. This field is empty when instance does not exist.

1603

"instance": "A String", # [Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created.

1604

"instanceHealth": [ # [Output Only] Health state of the instance per health-check.

1605

{

1606

"detailedHealthState": "A String", # [Output Only] The current detailed instance health state.

1607

"healthCheck": "A String", # [Output Only] The URL for the health check that verifies whether the instance is healthy.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1608

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1609

],

1610

"instanceStatus": "A String", # [Output Only] The status of the instance. This field is empty when the instance does not exist.

1611

"lastAttempt": { # [Output Only] Information about the last attempt to create or delete the instance.

1612

"errors": { # [Output Only] Encountered errors during the last attempt to create or delete the instance.

1613

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

1614

{

1615

"code": "A String", # [Output Only] The error type identifier for this error.

1616

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1617

"message": "A String", # [Output Only] An optional, human-readable error message.

1618

},

1619

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1620

},

1621

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1622

"preservedStateFromConfig": { # Preserved state for a given instance. # [Output Only] Preserved state applied from per-instance config for this instance.

1623

"disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks.

1624

"a_key": {

1625

"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.

1626

"mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.

1627

"source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance.

1628

},

1629

},

1630

"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.

1635

"disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks.

1636

"a_key": {

1637

"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.

1638

"mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.

1639

"source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance.

1640

},

1641

},

1642

"metadata": { # Preserved metadata defined for this instance.

"a_key": "A String",

},

},

"version": { # [Output Only] Intended version of this instance.

1647

"instanceTemplate": "A String", # [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }.

1648

"name": "A String", # [Output Only] Name of the version.

1649

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1650

},

1651

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1652

"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 than maxResults, 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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1657

<code class="details" id="listManagedInstances_next">listManagedInstances_next(previous_request, previous_response)</code>

1658

<pre>Retrieves the next page of results.

1659

1660

Args:

1661

previous_request: The request for the previous page. (required)

1662

previous_response: The response from the request for the previous page. (required)

1663

1664

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1665

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1666

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1671

<code class="details" id="listPerInstanceConfigs">listPerInstanceConfigs(project, zone, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1672

<pre>Lists all of the per-instance configs defined for the managed instance group. The orderBy query parameter is not supported.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1673

1674

Args:

1675

project: string, Project ID for this request. (required)

1676

zone: string, The name of the zone where the managed instance group is located. It should conform to RFC1035. (required)

1677

instanceGroupManager: string, The name of the managed instance group. It should conform to RFC1035. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1678

filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.

1679

1680

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

1681

1682

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 on resource labels.

1683

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1684

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) ```

1685

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`)

1686

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

1687

1688

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.

1689

1690

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

1691

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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1692

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1693

1694

Returns:

1695

An object of the form:

1696

1697

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1698

"items": [ # [Output Only] The list of PerInstanceConfig.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1699

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1700

"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 config or the field needs to be unset.

1701

"name": "A String", # The name of a per-instance config and its corresponding instance. Serves as a merge key during UpdatePerInstanceConfigs operations, that is, if a per-instance config 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 config for a VM instance that either doesn't exist or is not part of the group will result in an error.

1702

"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.

1703

"disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks.

1704

"a_key": {

1705

"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.

1706

"mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.

1707

"source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1708

},

1709

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1710

"metadata": { # Preserved metadata defined for this instance.

1711

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1712

},

1713

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1714

"status": "A String", # The status of applying this per-instance config on the corresponding managed instance.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1715

},

1716

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1717

"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 than maxResults, 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.

1718

"warning": { # [Output Only] Informational warning message.

1719

"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.

1720

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1721

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1722

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1723

"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).

1724

"value": "A String", # [Output Only] A warning data value corresponding to the key.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1725

},

1726

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1727

"message": "A String", # [Output Only] A human-readable description of the warning code.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

},

}</pre>

</div>

<code class="details" id="listPerInstanceConfigs_next">listPerInstanceConfigs_next(previous_request, previous_response)</code>

1734

<pre>Retrieves the next page of results.

1735

1736

Args:

1737

previous_request: The request for the previous page. (required)

1738

previous_response: The response from the request for the previous page. (required)

1739

1740

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1741

A request object that you can call 'execute()' on to request the next

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1742

page. Returns None if there are no more items in the collection.

</pre>

</div>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1747

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

1748

<pre>Retrieves the next page of results.

1749

1750

Args:

1751

previous_request: The request for the previous page. (required)

1752

previous_response: The response from the request for the previous page. (required)

1753

1754

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1755

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1756

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1761

<code class="details" id="patch">patch(project, zone, instanceGroupManager, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1762

<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 supports PATCH semantics and uses the JSON merge patch format and processing rules.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1763

1764

Args:

1765

project: string, Project ID for this request. (required)

1766

zone: string, The name of the zone where you want to create the managed instance group. (required)

1767

instanceGroupManager: string, The name of the instance group manager. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1768

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1769

The object takes the form of:

1770

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1771

{ # Represents a Managed Instance Group resource.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1772

#

1773

# An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups.

1774

#

1775

# For zonal Managed Instance Group, use the instanceGroupManagers resource.

1776

#

1777

# For regional Managed Instance Group, use the regionInstanceGroupManagers resource. (== resource_for {$api_version}.instanceGroupManagers ==) (== resource_for {$api_version}.regionInstanceGroupManagers ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1778

"autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1779

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1780

"healthCheck": "A String", # The URL for the health check that signals autohealing.

1781

"initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1782

},

1783

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1784

"baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.

1785

"creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.

1786

"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.

1787

"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.

1788

"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.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1789

#

1790

# If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1791

"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.

1792

"deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.

1793

"none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.

1794

"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.

1795

"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.

1796

"restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.

1797

"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.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1798

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1799

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

1800

"distributionPolicy": { # Policy specifying intended distribution of instances in regional managed instance group.

1801

"zones": [ # Zones where the regional managed instance group will create and manage instances.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1802

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1803

"zone": "A String", # The URL of the zone. The zone must exist in the region where the managed instance group is located.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1804

},

1805

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1806

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1807

"failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.

1808

"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 error 412 conditionNotMet.

1809

#

1810

# To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.

1811

"id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.

1812

"instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.

1813

"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.

1814

"kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.

1815

"name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.

1816

"namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.

1817

{ # The named port. For example: .

1818

"name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.

1819

"port": 42, # The port number, which can be a value between 1 and 65535.

1820

},

1821

],

1822

"pendingActions": { # [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions.

1823

"creating": 42, # [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The number of instances in the managed instance group that are pending to be created.

1824

"deleting": 42, # [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The number of instances in the managed instance group that are pending to be deleted.

1825

"recreating": 42, # [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The number of instances in the managed instance group that are pending to be recreated.

1826

"restarting": 42, # [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The number of instances in the managed instance group that are pending to be restarted.

1827

},

1828

"region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).

1829

"selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.

1830

"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.

1831

"statefulPolicy": { # Stateful configuration for this Instanced Group Manager

1832

"preservedState": { # Configuration of preserved resources.

1833

"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.

1834

"a_key": {

1835

"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 in READ_ONLY mode cannot be auto-deleted.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1836

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1837

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1838

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1839

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1840

"status": { # [Output Only] The status of this managed instance group.

1841

"autoscaler": "A String", # [Output Only] The URL of the Autoscaler that targets this instance group manager.

1842

"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.

1843

"stateful": { # [Output Only] Stateful status of the given Instance Group Manager.

1844

"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 config 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.

1845

"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 config 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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1846

"perInstanceConfigs": { # [Output Only] Status of per-instance configs on the instance.

1847

"allEffective": True or False, # A bit indicating if all of the group's per-instance configs (listed in the output of a listPerInstanceConfigs API call) have status EFFECTIVE or there are no per-instance-configs.

1848

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1849

},

1850

"versionTarget": { # [Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager.

1851

"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 by version field on Instance Group Manager.

1852

},

1853

},

1854

"targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.

1855

"A String",

1856

],

1857

"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.

1858

"updatePolicy": { # The update policy for this managed instance group.

1859

"instanceRedistributionType": "A String", # The instance redistribution policy for regional managed instance groups. Valid values are:

1860

# - PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region.

1861

# - NONE: For non-autoscaled groups, proactive redistribution is disabled.

1862

"maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be created above the specified targetSize during the update process. By default, a fixed value of 1 is used. This value can be either a fixed number or a percentage if the instance group has 10 or more instances. If you set a percentage, the number of instances will be rounded up if necessary.

1863

#

1864

# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge.

1865

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

1866

#

1867

#

1868

# - If the value is fixed, then the calculated value is equal to the fixed value.

1869

# - 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 up.

1870

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

1871

"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

1872

},

1873

"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:

1874

#

1875

#

1876

# - The instance's status is RUNNING.

1877

# - If there is a health check on the instance group, the instance's liveness health check result 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. By default, a fixed value of 1 is used. This value can be either a fixed number or a percentage if the instance group has 10 or more instances. If you set a percentage, the number of instances will be rounded up if necessary.

1878

#

1879

# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable.

1880

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

1881

#

1882

#

1883

# - If the value is fixed, then the calculated value is equal to the fixed value.

1884

# - 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 up.

1885

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

1886

"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

1887

},

1888

"minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].

1889

"minimalAction": "A String", # Minimal action to be taken on an instance. You can specify either RESTART to restart existing instances or REPLACE to delete and create new instances from the target template. If you specify a RESTART, the Updater will attempt to perform that action only. However, if the Updater determines that the minimal action you specify is not enough to perform the update, it might perform a more disruptive action.

1890

"replacementMethod": "A String", # What action should be used to replace instances. See minimal_action.REPLACE

1891

"type": "A String", # The type of update process. You can specify either PROACTIVE so that the instance group manager proactively executes actions in order to bring instances to their target versions or OPPORTUNISTIC so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls).

1892

},

1893

"versions": [ # Specifies the instance templates used by this managed instance group to create instances.

1894

#

1895

# Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates.

1896

{

1897

"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.

1898

"name": "A String", # Name of the version. Unique among all versions in the scope of this managed instance group.

1899

"targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Specifies the intended number of instances to be created from the instanceTemplate. The final number of instances created from the template will be equal to:

1900

# - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used.

1901

# - if expressed as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) If there is a remainder, the number is rounded up. If unset, this version will update any remaining instances not updated by another version. Read Starting a canary update for more information.

1902

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

1903

#

1904

#

1905

# - If the value is fixed, then the calculated value is equal to the fixed value.

1906

# - 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 up.

1907

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

1908

"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 the zone where the managed instance group is located (for zonal resources).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1913

}

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1914

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1915

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.

1916

1917

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.

1918

1919

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1920

1921

Returns:

1922

An object of the form:

1923

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1924

{ # Represents an Operation resource.

1925

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1926

# Google Compute Engine has three Operation resources:

1927

#

1928

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

1929

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1930

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

1931

#

1932

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1933

# - For global operations, use the `globalOperations` resource.

1934

# - For regional operations, use the `regionOperations` resource.

1935

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1936

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1937

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1938

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1939

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1940

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1941

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1942

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1943

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1944

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1945

"code": "A String", # [Output Only] The error type identifier for this error.

1946

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1947

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1948

},

1949

],

1950

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1951

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1952

"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.

1953

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

1954

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1955

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1956

"name": "A String", # [Output Only] Name of the operation.

1957

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1958

"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.

1959

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

1960

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1961

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1962

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

1963

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1964

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1965

"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 persistent disk that the snapshot was created from.

1966

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1967

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1968

{

1969

"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.

1970

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1971

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

1972

{

1973

"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).

1974

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1975

},

1976

],

1977

"message": "A String", # [Output Only] A human-readable description of the warning code.

1978

},

1979

],

1980

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1985

<code class="details" id="patchPerInstanceConfigs">patchPerInstanceConfigs(project, zone, instanceGroupManager, body=None, requestId=None)</code>

1986

<pre>Inserts or patches per-instance configs for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.

1987

1988

Args:

1989

project: string, Project ID for this request. (required)

1990

zone: string, The name of the zone where the managed instance group is located. It should conform to RFC1035. (required)

1991

instanceGroupManager: string, The name of the managed instance group. It should conform to RFC1035. (required)

1992

body: object, The request body.

1993

The object takes the form of:

1994

1995

{ # InstanceGroupManagers.patchPerInstanceConfigs

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1996

"perInstanceConfigs": [ # The list of per-instance configs to insert or patch on this managed instance group.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1997

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1998

"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 config or the field needs to be unset.

1999

"name": "A String", # The name of a per-instance config and its corresponding instance. Serves as a merge key during UpdatePerInstanceConfigs operations, that is, if a per-instance config 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 config for a VM instance that either doesn't exist or is not part of the group will result in an error.

2000

"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.

2001

"disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks.

2002

"a_key": {

2003

"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.

2004

"mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.

2005

"source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2006

},

2007

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2008

"metadata": { # Preserved metadata defined for this instance.

2009

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2010

},

2011

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2012

"status": "A String", # The status of applying this per-instance config on the corresponding managed instance.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

},

],

}

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.

2018

2019

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.

2020

2021

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

2022

2023

Returns:

2024

An object of the form:

2025

2026

{ # Represents an Operation resource.

2027

#

2028

# Google Compute Engine has three Operation resources:

2029

#

2030

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2031

#

2032

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2033

#

2034

# Operations can be global, regional or zonal.

2035

# - For global operations, use the `globalOperations` resource.

2036

# - For regional operations, use the `regionOperations` resource.

2037

# - For zonal operations, use the `zonalOperations` resource.

2038

#

2039

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2040

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2041

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2042

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2043

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2044

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2045

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2046

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2047

"code": "A String", # [Output Only] The error type identifier for this error.

2048

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2049

"message": "A String", # [Output Only] An optional, human-readable error message.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2050

},

2051

],

2052

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2053

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2054

"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.

2055

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2056

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2057

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2058

"name": "A String", # [Output Only] Name of the operation.

2059

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2060

"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.

2061

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2062

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2063

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2064

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2065

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2066

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2067

"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 persistent disk that the snapshot was created from.

2068

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2069

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2070

{

2071

"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.

2072

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2073

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2074

{

2075

"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).

2076

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2077

},

2078

],

2079

"message": "A String", # [Output Only] A human-readable description of the warning code.

2080

},

2081

],

2082

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="recreateInstances">recreateInstances(project, zone, instanceGroupManager, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2088

<pre>Flags the specified instances in the managed instance group to be immediately recreated. The instances are deleted and recreated using the current instance template for the managed instance group. 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 the recreating action with the listmanagedinstances method.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2089

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2090

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.

2091

2092

You can specify a maximum of 1000 instances with this method per request.

2093

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2094

Args:

2095

project: string, Project ID for this request. (required)

2096

zone: string, The name of the zone where the managed instance group is located. (required)

2097

instanceGroupManager: string, The name of the managed instance group. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2098

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2099

The object takes the form of:

2100

2101

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2102

"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].

2103

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

],

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2107

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.

2108

2109

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.

2110

2111

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2112

2113

Returns:

2114

An object of the form:

2115

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2116

{ # Represents an Operation resource.

2117

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2118

# Google Compute Engine has three Operation resources:

2119

#

2120

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2121

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2122

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2123

#

2124

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2125

# - For global operations, use the `globalOperations` resource.

2126

# - For regional operations, use the `regionOperations` resource.

2127

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2128

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2129

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2130

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2131

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2132

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2133

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2134

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2135

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2136

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2137

"code": "A String", # [Output Only] The error type identifier for this error.

2138

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2139

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2140

},

2141

],

2142

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2143

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2144

"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.

2145

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2146

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2147

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2148

"name": "A String", # [Output Only] Name of the operation.

2149

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2150

"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.

2151

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2152

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2153

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2154

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2155

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2156

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2157

"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 persistent disk that the snapshot was created from.

2158

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2159

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2160

{

2161

"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.

2162

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2163

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2164

{

2165

"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).

2166

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2167

},

2168

],

2169

"message": "A String", # [Output Only] A human-readable description of the warning code.

2170

},

2171

],

2172

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2177

<code class="details" id="resize">resize(project, zone, instanceGroupManager, size, requestId=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2178

<pre>Resizes 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 instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.

2179

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2180

When resizing down, the instance group arbitrarily chooses the order in which VMs are deleted. The group takes into account some VM attributes when making the selection including:

2181

2182

+ The status of the VM instance. + The health of the VM instance. + The instance template version the VM is based on. + For regional managed instance groups, the location of the VM instance.

2183

2184

This list is subject to change.

2185

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2186

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.

2187

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2188

Args:

2189

project: string, Project ID for this request. (required)

2190

zone: string, The name of the zone where the managed instance group is located. (required)

2191

instanceGroupManager: string, The name of the managed instance group. (required)

2192

size: integer, 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. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2193

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.

2194

2195

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.

2196

2197

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2198

2199

Returns:

2200

An object of the form:

2201

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2202

{ # Represents an Operation resource.

2203

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2204

# Google Compute Engine has three Operation resources:

2205

#

2206

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2207

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2208

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2209

#

2210

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2211

# - For global operations, use the `globalOperations` resource.

2212

# - For regional operations, use the `regionOperations` resource.

2213

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2214

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2215

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2216

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2217

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2218

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2219

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2220

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2221

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2222

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2223

"code": "A String", # [Output Only] The error type identifier for this error.

2224

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2225

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2226

},

2227

],

2228

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2229

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2230

"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.

2231

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2232

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2233

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2234

"name": "A String", # [Output Only] Name of the operation.

2235

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2236

"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.

2237

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2238

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2239

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2240

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2241

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2242

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2243

"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 persistent disk that the snapshot was created from.

2244

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2245

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2246

{

2247

"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.

2248

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2249

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2250

{

2251

"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).

2252

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2253

},

2254

],

2255

"message": "A String", # [Output Only] A human-readable description of the warning code.

2256

},

2257

],

2258

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2263

<code class="details" id="resizeAdvanced">resizeAdvanced(project, zone, instanceGroupManager, body=None, requestId=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2264

<pre>Resizes the managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method.

2265

2266

If you increase the size of the instance group, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating, creatingWithoutRetries, or deleting actions with the get or listmanagedinstances method.

2267

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2268

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.

2269

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2270

Args:

2271

project: string, Project ID for this request. (required)

2272

zone: string, The name of the zone where the managed instance group is located. (required)

2273

instanceGroupManager: string, The name of the managed instance group. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2274

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2275

The object takes the form of:

2276

2277

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2278

"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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2279

#

2280

# 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.

2281

#

2282

# This flag is applicable only to the current resize request. It does not influence other resize requests in any way.

2283

#

2284

# You can see which instances is being creating in which mode by calling the get or listManagedInstances API.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2285

"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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2286

}

2287

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2288

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.

2289

2290

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.

2291

2292

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2293

2294

Returns:

2295

An object of the form:

2296

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2297

{ # Represents an Operation resource.

2298

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2299

# Google Compute Engine has three Operation resources:

2300

#

2301

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2302

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2303

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2304

#

2305

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2306

# - For global operations, use the `globalOperations` resource.

2307

# - For regional operations, use the `regionOperations` resource.

2308

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2309

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2310

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2311

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2312

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2313

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2314

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2315

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2316

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2317

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2318

"code": "A String", # [Output Only] The error type identifier for this error.

2319

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2320

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2321

},

2322

],

2323

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2324

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2325

"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.

2326

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2327

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2328

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2329

"name": "A String", # [Output Only] Name of the operation.

2330

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2331

"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.

2332

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2333

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2334

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2335

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2336

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2337

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2338

"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 persistent disk that the snapshot was created from.

2339

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2340

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2341

{

2342

"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.

2343

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2344

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2345

{

2346

"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).

2347

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2348

},

2349

],

2350

"message": "A String", # [Output Only] A human-readable description of the warning code.

2351

},

2352

],

2353

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2358

<code class="details" id="setAutoHealingPolicies">setAutoHealingPolicies(project, zone, instanceGroupManager, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2359

<pre>Modifies the autohealing policies. [Deprecated] This method is deprecated. Please use Patch instead.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2360

2361

Args:

2362

project: string, Project ID for this request. (required)

2363

zone: string, The name of the zone where the managed instance group is located. (required)

2364

instanceGroupManager: string, The name of the instance group manager. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2365

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2366

The object takes the form of:

2367

2368

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2369

"autoHealingPolicies": [

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2370

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2371

"healthCheck": "A String", # The URL for the health check that signals autohealing.

2372

"initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

},

],

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2377

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.

2378

2379

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.

2380

2381

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2382

2383

Returns:

2384

An object of the form:

2385

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2386

{ # Represents an Operation resource.

2387

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2388

# Google Compute Engine has three Operation resources:

2389

#

2390

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2391

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2392

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2393

#

2394

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2395

# - For global operations, use the `globalOperations` resource.

2396

# - For regional operations, use the `regionOperations` resource.

2397

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2398

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2399

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2400

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2401

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2402

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2403

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2404

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2405

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2406

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2407

"code": "A String", # [Output Only] The error type identifier for this error.

2408

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2409

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2410

},

2411

],

2412

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2413

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2414

"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.

2415

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2416

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2417

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2418

"name": "A String", # [Output Only] Name of the operation.

2419

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2420

"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.

2421

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2422

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2423

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2424

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2425

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2426

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2427

"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 persistent disk that the snapshot was created from.

2428

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2429

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2430

{

2431

"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.

2432

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2433

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2434

{

2435

"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).

2436

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2437

},

2438

],

2439

"message": "A String", # [Output Only] A human-readable description of the warning code.

2440

},

2441

],

2442

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2447

<code class="details" id="setInstanceTemplate">setInstanceTemplate(project, zone, instanceGroupManager, body=None, requestId=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2448

<pre>Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them.

2449

2450

Args:

2451

project: string, Project ID for this request. (required)

2452

zone: string, The name of the zone where the managed instance group is located. (required)

2453

instanceGroupManager: string, The name of the managed instance group. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2454

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2455

The object takes the form of:

2456

2457

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2458

"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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2459

}

2460

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2461

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.

2462

2463

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.

2464

2465

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2466

2467

Returns:

2468

An object of the form:

2469

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2470

{ # Represents an Operation resource.

2471

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2472

# Google Compute Engine has three Operation resources:

2473

#

2474

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2475

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2476

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2477

#

2478

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2479

# - For global operations, use the `globalOperations` resource.

2480

# - For regional operations, use the `regionOperations` resource.

2481

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2482

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2483

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2484

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2485

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2486

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2487

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2488

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2489

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2490

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2491

"code": "A String", # [Output Only] The error type identifier for this error.

2492

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2493

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2494

},

2495

],

2496

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2497

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2498

"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.

2499

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2500

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2501

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2502

"name": "A String", # [Output Only] Name of the operation.

2503

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2504

"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.

2505

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2506

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2507

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2508

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2509

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2510

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2511

"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 persistent disk that the snapshot was created from.

2512

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2513

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2514

{

2515

"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.

2516

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2517

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2518

{

2519

"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).

2520

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2521

},

2522

],

2523

"message": "A String", # [Output Only] A human-readable description of the warning code.

2524

},

2525

],

2526

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2531

<code class="details" id="setTargetPools">setTargetPools(project, zone, instanceGroupManager, body=None, requestId=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2532

<pre>Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group.

2533

2534

Args:

2535

project: string, Project ID for this request. (required)

2536

zone: string, The name of the zone where the managed instance group is located. (required)

2537

instanceGroupManager: string, The name of the managed instance group. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2538

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2539

The object takes the form of:

2540

2541

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2542

"fingerprint": "A String", # The fingerprint of the target pools information. Use this optional property to prevent conflicts when multiple users change the target pools settings concurrently. Obtain the fingerprint with the instanceGroupManagers.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request.

2543

"targetPools": [ # The list of target pool URLs that instances in this managed instance group belong to. The managed instance group applies these target pools to all of the instances in the group. Existing instances and new instances in the group all receive these target pool settings.

2544

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2545

],

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2546

}

2547

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2548

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.

2549

2550

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.

2551

2552

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2553

2554

Returns:

2555

An object of the form:

2556

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2557

{ # Represents an Operation resource.

2558

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2559

# Google Compute Engine has three Operation resources:

2560

#

2561

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2562

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2563

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2564

#

2565

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2566

# - For global operations, use the `globalOperations` resource.

2567

# - For regional operations, use the `regionOperations` resource.

2568

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2569

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2570

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2571

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2572

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2573

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2574

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2575

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2576

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2577

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2578

"code": "A String", # [Output Only] The error type identifier for this error.

2579

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2580

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2581

},

2582

],

2583

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2584

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2585

"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.

2586

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2587

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2588

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2589

"name": "A String", # [Output Only] Name of the operation.

2590

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2591

"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.

2592

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2593

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2594

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2595

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2596

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2597

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2598

"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 persistent disk that the snapshot was created from.

2599

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2600

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2601

{

2602

"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.

2603

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2604

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2605

{

2606

"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).

2607

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2608

},

2609

],

2610

"message": "A String", # [Output Only] A human-readable description of the warning code.

2611

},

2612

],

2613

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2618

<code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2619

<pre>Returns permissions that a caller has on the specified resource.

2620

2621

Args:

2622

project: string, Project ID for this request. (required)

2623

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2624

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2625

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2626

The object takes the form of:

2627

2628

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2629

"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.

2630

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

],

}

Returns:

An object of the form:

2637

2638

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2639

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.

2640

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

],

}</pre>

</div>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

2645

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2646

<code class="details" id="update">update(project, zone, instanceGroupManager, body=None, requestId=None)</code>

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2647

<pre>Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listManagedInstances method.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

2648

2649

Args:

2650

project: string, Project ID for this request. (required)

2651

zone: string, The name of the zone where you want to create the managed instance group. (required)

2652

instanceGroupManager: string, The name of the instance group manager. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2653

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

2654

The object takes the form of:

2655

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2656

{ # Represents a Managed Instance Group resource.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2657

#

2658

# An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups.

2659

#

2660

# For zonal Managed Instance Group, use the instanceGroupManagers resource.

2661

#

2662

# For regional Managed Instance Group, use the regionInstanceGroupManagers resource. (== resource_for {$api_version}.instanceGroupManagers ==) (== resource_for {$api_version}.regionInstanceGroupManagers ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2663

"autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2664

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2665

"healthCheck": "A String", # The URL for the health check that signals autohealing.

2666

"initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2667

},

2668

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2669

"baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.

2670

"creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.

2671

"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.

2672

"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.

2673

"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.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2674

#

2675

# If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2676

"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.

2677

"deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.

2678

"none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.

2679

"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.

2680

"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.

2681

"restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.

2682

"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.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2683

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2684

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2685

"distributionPolicy": { # Policy specifying intended distribution of instances in regional managed instance group.

2686

"zones": [ # Zones where the regional managed instance group will create and manage instances.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2687

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2688

"zone": "A String", # The URL of the zone. The zone must exist in the region where the managed instance group is located.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2689

},

2690

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2691

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2692

"failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.

2693

"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 error 412 conditionNotMet.

2694

#

2695

# To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.

2696

"id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.

2697

"instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.

2698

"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.

2699

"kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.

2700

"name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.

2701

"namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.

2702

{ # The named port. For example: .

2703

"name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.

2704

"port": 42, # The port number, which can be a value between 1 and 65535.

2705

},

2706

],

2707

"pendingActions": { # [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions.

2708

"creating": 42, # [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The number of instances in the managed instance group that are pending to be created.

2709

"deleting": 42, # [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The number of instances in the managed instance group that are pending to be deleted.

2710

"recreating": 42, # [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The number of instances in the managed instance group that are pending to be recreated.

2711

"restarting": 42, # [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The number of instances in the managed instance group that are pending to be restarted.

2712

},

2713

"region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).

2714

"selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.

2715

"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.

2716

"statefulPolicy": { # Stateful configuration for this Instanced Group Manager

2717

"preservedState": { # Configuration of preserved resources.

2718

"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.

2719

"a_key": {

2720

"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 in READ_ONLY mode cannot be auto-deleted.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2721

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2722

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2723

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2724

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2725

"status": { # [Output Only] The status of this managed instance group.

2726

"autoscaler": "A String", # [Output Only] The URL of the Autoscaler that targets this instance group manager.

2727

"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.

2728

"stateful": { # [Output Only] Stateful status of the given Instance Group Manager.

2729

"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 config 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.

2730

"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 config 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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2731

"perInstanceConfigs": { # [Output Only] Status of per-instance configs on the instance.

2732

"allEffective": True or False, # A bit indicating if all of the group's per-instance configs (listed in the output of a listPerInstanceConfigs API call) have status EFFECTIVE or there are no per-instance-configs.

2733

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2734

},

2735

"versionTarget": { # [Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager.

2736

"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 by version field on Instance Group Manager.

2737

},

2738

},

2739

"targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.

2740

"A String",

2741

],

2742

"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.

2743

"updatePolicy": { # The update policy for this managed instance group.

2744

"instanceRedistributionType": "A String", # The instance redistribution policy for regional managed instance groups. Valid values are:

2745

# - PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region.

2746

# - NONE: For non-autoscaled groups, proactive redistribution is disabled.

2747

"maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be created above the specified targetSize during the update process. By default, a fixed value of 1 is used. This value can be either a fixed number or a percentage if the instance group has 10 or more instances. If you set a percentage, the number of instances will be rounded up if necessary.

2748

#

2749

# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge.

2750

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

2751

#

2752

#

2753

# - If the value is fixed, then the calculated value is equal to the fixed value.

2754

# - 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 up.

2755

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

2756

"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

2757

},

2758

"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:

2759

#

2760

#

2761

# - The instance's status is RUNNING.

2762

# - If there is a health check on the instance group, the instance's liveness health check result 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. By default, a fixed value of 1 is used. This value can be either a fixed number or a percentage if the instance group has 10 or more instances. If you set a percentage, the number of instances will be rounded up if necessary.

2763

#

2764

# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable.

2765

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

2766

#

2767

#

2768

# - If the value is fixed, then the calculated value is equal to the fixed value.

2769

# - 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 up.

2770

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

2771

"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

2772

},

2773

"minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].

2774

"minimalAction": "A String", # Minimal action to be taken on an instance. You can specify either RESTART to restart existing instances or REPLACE to delete and create new instances from the target template. If you specify a RESTART, the Updater will attempt to perform that action only. However, if the Updater determines that the minimal action you specify is not enough to perform the update, it might perform a more disruptive action.

2775

"replacementMethod": "A String", # What action should be used to replace instances. See minimal_action.REPLACE

2776

"type": "A String", # The type of update process. You can specify either PROACTIVE so that the instance group manager proactively executes actions in order to bring instances to their target versions or OPPORTUNISTIC so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls).

2777

},

2778

"versions": [ # Specifies the instance templates used by this managed instance group to create instances.

2779

#

2780

# Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates.

2781

{

2782

"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.

2783

"name": "A String", # Name of the version. Unique among all versions in the scope of this managed instance group.

2784

"targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Specifies the intended number of instances to be created from the instanceTemplate. The final number of instances created from the template will be equal to:

2785

# - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used.

2786

# - if expressed as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) If there is a remainder, the number is rounded up. If unset, this version will update any remaining instances not updated by another version. Read Starting a canary update for more information.

2787

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

2788

#

2789

#

2790

# - If the value is fixed, then the calculated value is equal to the fixed value.

2791

# - 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 up.

2792

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

2793

"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 the zone where the managed instance group is located (for zonal resources).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2798

}

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

2799

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2800

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.

2801

2802

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.

2803

2804

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

2805

2806

Returns:

2807

An object of the form:

2808

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2809

{ # Represents an Operation resource.

2810

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2811

# Google Compute Engine has three Operation resources:

2812

#

2813

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2814

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2815

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2816

#

2817

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2818

# - For global operations, use the `globalOperations` resource.

2819

# - For regional operations, use the `regionOperations` resource.

2820

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2821

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2822

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2823

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2824

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2825

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2826

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2827

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2828

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2829

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2830

"code": "A String", # [Output Only] The error type identifier for this error.

2831

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2832

"message": "A String", # [Output Only] An optional, human-readable error message.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2833

},

2834

],

2835

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2836

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2837

"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.

2838

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2839

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2840

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2841

"name": "A String", # [Output Only] Name of the operation.

2842

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2843

"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.

2844

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2845

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2846

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2847

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2848

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2849

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2850

"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 persistent disk that the snapshot was created from.

2851

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2852

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2853

{

2854

"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.

2855

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2856

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2857

{

2858

"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).

2859

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2860

},

2861

],

2862

"message": "A String", # [Output Only] A human-readable description of the warning code.

2863

},

2864

],

2865

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="updatePerInstanceConfigs">updatePerInstanceConfigs(project, zone, instanceGroupManager, body=None, requestId=None)</code>

2871

<pre>Inserts or updates per-instance configs for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.

2872

2873

Args:

2874

project: string, Project ID for this request. (required)

2875

zone: string, The name of the zone where the managed instance group is located. It should conform to RFC1035. (required)

2876

instanceGroupManager: string, The name of the managed instance group. It should conform to RFC1035. (required)

2877

body: object, The request body.

2878

The object takes the form of:

2879

2880

{ # InstanceGroupManagers.updatePerInstanceConfigs

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2881

"perInstanceConfigs": [ # The list of per-instance configs to insert or patch on this managed instance group.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2882

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2883

"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 config or the field needs to be unset.

2884

"name": "A String", # The name of a per-instance config and its corresponding instance. Serves as a merge key during UpdatePerInstanceConfigs operations, that is, if a per-instance config 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 config for a VM instance that either doesn't exist or is not part of the group will result in an error.

2885

"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.

2886

"disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks.

2887

"a_key": {

2888

"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.

2889

"mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.

2890

"source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2891

},

2892

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2893

"metadata": { # Preserved metadata defined for this instance.

2894

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2895

},

2896

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2897

"status": "A String", # The status of applying this per-instance config on the corresponding managed instance.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

},

],

}

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.

2903

2904

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.

2905

2906

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

2907

2908

Returns:

2909

An object of the form:

2910

2911

{ # Represents an Operation resource.

2912

#

2913

# Google Compute Engine has three Operation resources:

2914

#

2915

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2916

#

2917

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2918

#

2919

# Operations can be global, regional or zonal.

2920

# - For global operations, use the `globalOperations` resource.

2921

# - For regional operations, use the `regionOperations` resource.

2922

# - For zonal operations, use the `zonalOperations` resource.

2923

#

2924

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2925

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2926

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2927

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2928

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2929

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2930

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

2931

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2932

"code": "A String", # [Output Only] The error type identifier for this error.

2933

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2934

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

2935

},

2936

],

2937

},

Bu Sun Kim