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

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

[diff] [blame]

80

Dan O'Meara

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

[diff] [blame]

81

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

Bu Sun Kim

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

[diff] [blame]

82

<p class="firstline">Apply updates to selected instances the managed instance group.</p>

83

Dmitry Frenkel

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

[diff] [blame]

84

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

85

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

86

Dan O'Meara

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

[diff] [blame]

87

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

88

<p class="firstline">Creates instances with per-instance configs in this regional managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method.</p>

89

Bu Sun Kim

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

[diff] [blame]

90

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

Sai Cheemalapati

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

[diff] [blame]

91

<p class="firstline">Deletes the specified managed instance group and all of the instances in that group.</p>

92

Dan O'Meara

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

[diff] [blame]

93

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

Bu Sun Kim

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

[diff] [blame]

94

<p class="firstline">Flags the specified instances in the managed instance group to be immediately deleted. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. You must separately verify the status of the deleting action with the listmanagedinstances method.</p>

Sai Cheemalapati

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

[diff] [blame]

95

Dan O'Meara

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

[diff] [blame]

96

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

97

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

98

Sai Cheemalapati

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

[diff] [blame]

99

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

100

<p class="firstline">Returns all of the details about the specified managed instance group.</p>

101

Dan O'Meara

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

[diff] [blame]

102

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

Bu Sun Kim

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

[diff] [blame]

103

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

104

Dmitry Frenkel

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

[diff] [blame]

105

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

Sai Cheemalapati

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

[diff] [blame]

106

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

107

Dmitry Frenkel

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

[diff] [blame]

108

<code><a href="#listErrors">listErrors(project, region, 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]

109

<p class="firstline">Lists all errors thrown by actions on instances for a given regional 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]

110

111

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

112

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

113

Dmitry Frenkel

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

[diff] [blame]

114

<code><a href="#listManagedInstances">listManagedInstances(project, region, 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 the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. The orderBy query parameter is not supported.</p>

Sai Cheemalapati

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

[diff] [blame]

116

Sai Cheemalapati

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

[diff] [blame]

117

<code><a href="#listManagedInstances_next">listManagedInstances_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="#listPerInstanceConfigs">listPerInstanceConfigs(project, region, 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 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]

122

123

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

124

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

125

Sai Cheemalapati

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

[diff] [blame]

126

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

127

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

128

Dan O'Meara

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

[diff] [blame]

129

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

Bu Sun Kim

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

[diff] [blame]

130

<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

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

[diff] [blame]

131

Dan O'Meara

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

[diff] [blame]

132

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

133

<p class="firstline">Insert or patch (for the ones that already exist) per-instance configs for the managed instance group. perInstanceConfig.instance serves as a key used to distinguish whether to perform insert or patch.</p>

134

135

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

Bu Sun Kim

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

[diff] [blame]

136

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

137

Bu Sun Kim

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

[diff] [blame]

138

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

139

<p class="firstline">Changes the intended size of the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances.</p>

Sai Cheemalapati

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

[diff] [blame]

140

Dan O'Meara

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

[diff] [blame]

141

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

Bu Sun Kim

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

[diff] [blame]

142

<p class="firstline">Modifies the autohealing policy for the instances in this managed instance group. [Deprecated] This method is deprecated. Please use Patch instead.</p>

Sai Cheemalapati

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

[diff] [blame]

143

Dan O'Meara

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

[diff] [blame]

144

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

Sai Cheemalapati

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

[diff] [blame]

145

<p class="firstline">Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected.</p>

146

Dan O'Meara

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

[diff] [blame]

147

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

Sai Cheemalapati

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

[diff] [blame]

148

<p class="firstline">Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.</p>

149

Dan O'Meara

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

[diff] [blame]

150

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

Sai Cheemalapati

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

[diff] [blame]

151

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

152

Dan O'Meara

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

[diff] [blame]

153

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

Sai Cheemalapati

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

[diff] [blame]

154

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

155

156

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

157

<p class="firstline">Insert or update (for the ones that already exist) per-instance configs for the managed instance group. perInstanceConfig.instance 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]

158

<h3>Method Details</h3>

159

Dan O'Meara

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

[diff] [blame]

160

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

Bu Sun Kim

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

[diff] [blame]

161

<pre>Flags the specified instances to be immediately removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces 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]

162

Sai Cheemalapati

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

[diff] [blame]

163

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.

164

165

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

166

Sai Cheemalapati

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

[diff] [blame]

167

Args:

168

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

169

region: string, Name of the region scoping this request. (required)

170

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

Dan O'Meara

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

[diff] [blame]

171

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

172

The object takes the form of:

173

174

{

Bu Sun Kim

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

[diff] [blame]

175

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

176

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

180

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.

181

182

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.

183

184

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]

185

186

Returns:

187

An object of the form:

188

Bu Sun Kim

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

[diff] [blame]

189

{ # Represents an Operation resource.

190

#

Dan O'Meara

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

[diff] [blame]

191

# Google Compute Engine has three Operation resources:

192

#

193

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

194

#

Bu Sun Kim

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

[diff] [blame]

195

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

196

#

197

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

198

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

199

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

200

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

Bu Sun Kim

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

[diff] [blame]

201

#

Dan O'Meara

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

[diff] [blame]

202

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

203

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

204

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

205

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

206

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

207

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

208

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

Sai Cheemalapati

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

[diff] [blame]

209

{

Bu Sun Kim

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

[diff] [blame]

210

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

211

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

212

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

Sai Cheemalapati

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

[diff] [blame]

213

},

214

],

215

},

Bu Sun Kim

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

[diff] [blame]

216

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

217

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

218

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

219

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

220

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

221

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

222

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

223

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

224

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

225

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

226

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

227

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

228

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

229

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

230

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

231

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

232

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

233

{

234

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

235

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

236

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

237

{

238

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

239

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

240

},

241

],

242

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

243

},

244

],

245

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

250

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

Bu Sun Kim

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

[diff] [blame]

251

<pre>Apply updates to selected instances the managed instance group.

252

253

Args:

254

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

255

region: string, Name of the region scoping this request, should conform to RFC1035. (required)

256

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]

257

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

258

The object takes the form of:

259

Dmitry Frenkel

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

[diff] [blame]

260

{ # RegionInstanceGroupManagers.applyUpdatesToInstances

261

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

262

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

263

"A String",

Bu Sun Kim

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

[diff] [blame]

264

],

Bu Sun Kim

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

[diff] [blame]

265

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

266

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

267

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

268

# - REFRESH: Do not stop the instance.

269

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

270

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

271

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

272

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

273

# - REFRESH: Do not stop the instance.

274

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

}

Returns:

An object of the form:

280

281

{ # Represents an Operation resource.

282

#

Dan O'Meara

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

[diff] [blame]

283

# Google Compute Engine has three Operation resources:

284

#

285

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

286

#

Bu Sun Kim

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

[diff] [blame]

287

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

288

#

289

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

290

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

291

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

292

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

Bu Sun Kim

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

[diff] [blame]

293

#

Dan O'Meara

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

[diff] [blame]

294

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

295

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

296

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

297

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

298

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

299

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

300

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

Dan O'Meara

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

[diff] [blame]

301

{

Bu Sun Kim

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

[diff] [blame]

302

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

303

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

304

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

Dan O'Meara

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

[diff] [blame]

305

},

306

],

307

},

Bu Sun Kim

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

[diff] [blame]

308

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

309

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

310

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

311

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

312

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

313

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

314

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

315

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

316

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

317

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

318

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

319

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

320

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

321

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

322

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

323

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

324

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

325

{

326

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

327

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

328

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

329

{

330

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

331

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

332

},

333

],

334

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

335

},

336

],

337

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

342

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

343

<pre>Close httplib2 connections.</pre>

</div>

Dan O'Meara

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

[diff] [blame]

347

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

348

<pre>Creates instances with per-instance configs in this regional managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method.

349

350

Args:

351

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

352

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

353

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

354

body: object, The request body.

355

The object takes the form of:

356

357

{ # RegionInstanceGroupManagers.createInstances

Bu Sun Kim

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

[diff] [blame]

358

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

Dan O'Meara

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

[diff] [blame]

359

{

Bu Sun Kim

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

[diff] [blame]

360

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

361

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

362

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

363

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

364

"a_key": {

365

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

366

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

367

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

368

},

369

},

Bu Sun Kim

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

[diff] [blame]

370

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

371

"a_key": "A String",

Dan O'Meara

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

[diff] [blame]

372

},

373

},

Bu Sun Kim

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

[diff] [blame]

374

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

380

381

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.

382

383

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

384

385

Returns:

386

An object of the form:

387

388

{ # Represents an Operation resource.

389

#

390

# Google Compute Engine has three Operation resources:

391

#

392

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

393

#

394

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

395

#

396

# Operations can be global, regional or zonal.

397

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

398

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

399

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

400

#

401

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

402

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

403

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

404

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

405

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

406

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

407

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

Bu Sun Kim

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

[diff] [blame]

408

{

Bu Sun Kim

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

[diff] [blame]

409

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

410

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

411

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

Bu Sun Kim

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

[diff] [blame]

412

},

413

],

414

},

Bu Sun Kim

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

[diff] [blame]

415

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

416

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

417

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

418

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

419

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

420

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

421

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

422

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

423

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

424

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

425

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

426

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

427

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

428

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

429

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

430

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

431

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

432

{

433

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

434

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

435

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

436

{

437

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

438

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

439

},

440

],

441

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

442

},

443

],

444

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

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

Sai Cheemalapati

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

[diff] [blame]

450

<pre>Deletes the specified managed instance group and all of the instances in that group.

451

452

Args:

453

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

454

region: string, Name of the region scoping this request. (required)

455

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

Bu Sun Kim

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

[diff] [blame]

456

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.

457

458

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.

459

460

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]

461

462

Returns:

463

An object of the form:

464

Bu Sun Kim

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

[diff] [blame]

465

{ # Represents an Operation resource.

466

#

Dan O'Meara

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

[diff] [blame]

467

# Google Compute Engine has three Operation resources:

468

#

469

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

470

#

Bu Sun Kim

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

[diff] [blame]

471

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

472

#

473

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

474

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

475

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

476

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

Bu Sun Kim

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

[diff] [blame]

477

#

Dan O'Meara

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

[diff] [blame]

478

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

479

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

480

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

481

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

482

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

483

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

484

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

Sai Cheemalapati

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

[diff] [blame]

485

{

Bu Sun Kim

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

[diff] [blame]

486

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

487

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

488

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

Sai Cheemalapati

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

[diff] [blame]

489

},

490

],

491

},

Bu Sun Kim

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

[diff] [blame]

492

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

493

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

494

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

495

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

496

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

497

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

498

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

499

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

500

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

501

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

502

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

503

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

504

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

505

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

506

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

507

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

508

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

509

{

510

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

511

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

512

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

513

{

514

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

515

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

516

},

517

],

518

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

519

},

520

],

521

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

526

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

Bu Sun Kim

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

[diff] [blame]

527

<pre>Flags the specified instances in the managed instance group to be immediately deleted. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. You must separately verify the status of the deleting action with the listmanagedinstances method.

Sai Cheemalapati

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

[diff] [blame]

528

Sai Cheemalapati

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

[diff] [blame]

529

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.

530

531

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

532

Sai Cheemalapati

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

[diff] [blame]

533

Args:

534

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

535

region: string, Name of the region scoping this request. (required)

536

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

Dan O'Meara

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

[diff] [blame]

537

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

538

The object takes the form of:

539

540

{

Bu Sun Kim

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

[diff] [blame]

541

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

542

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

546

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.

547

548

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.

549

550

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]

551

552

Returns:

553

An object of the form:

554

Bu Sun Kim

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

[diff] [blame]

555

{ # Represents an Operation resource.

556

#

Dan O'Meara

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

[diff] [blame]

557

# Google Compute Engine has three Operation resources:

558

#

559

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

560

#

Bu Sun Kim

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

[diff] [blame]

561

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

562

#

563

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

564

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

565

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

566

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

Bu Sun Kim

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

[diff] [blame]

567

#

Dan O'Meara

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

[diff] [blame]

568

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

569

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

570

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

571

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

572

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

573

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

574

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

Dan O'Meara

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

[diff] [blame]

575

{

Bu Sun Kim

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

[diff] [blame]

576

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

577

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

578

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

Dan O'Meara

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

[diff] [blame]

579

},

580

],

581

},

Bu Sun Kim

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

[diff] [blame]

582

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

583

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

584

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

585

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

586

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

587

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

588

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

589

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

590

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

591

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

592

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

593

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

594

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

595

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

596

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

597

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

598

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

599

{

600

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

601

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

602

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

603

{

604

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

605

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

606

},

607

],

608

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

609

},

610

],

611

"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, region, instanceGroupManager, body=None)</code>

617

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

618

619

Args:

620

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

621

region: string, Name of the region scoping this request, should conform to RFC1035. (required)

622

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

623

body: object, The request body.

624

The object takes the form of:

625

626

{ # RegionInstanceGroupManagers.deletePerInstanceConfigs

Bu Sun Kim

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

[diff] [blame]

627

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

628

"A String",

Dan O'Meara

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

[diff] [blame]

],

}

Returns:

An object of the form:

635

636

{ # Represents an Operation resource.

637

#

638

# Google Compute Engine has three Operation resources:

639

#

640

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

641

#

642

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

643

#

644

# Operations can be global, regional or zonal.

645

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

646

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

647

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

648

#

649

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

650

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

651

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

652

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

653

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

654

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

655

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

Sai Cheemalapati

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

[diff] [blame]

656

{

Bu Sun Kim

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

[diff] [blame]

657

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

658

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

659

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

Sai Cheemalapati

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

[diff] [blame]

660

},

661

],

662

},

Bu Sun Kim

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

[diff] [blame]

663

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

664

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

665

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

666

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

667

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

668

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

669

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

670

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

671

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

672

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

673

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

674

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

675

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

676

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

677

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

678

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

679

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

680

{

681

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

682

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

683

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

684

{

685

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

686

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

687

},

688

],

689

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

690

},

691

],

692

"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, region, instanceGroupManager)</code>

698

<pre>Returns all of the details about the specified managed instance group.

699

700

Args:

701

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

702

region: string, Name of the region scoping this request. (required)

703

instanceGroupManager: string, Name of the managed instance group to return. (required)

704

705

Returns:

706

An object of the form:

707

Bu Sun Kim

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

[diff] [blame]

708

{ # Represents a Managed Instance Group resource.

Dan O'Meara

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

[diff] [blame]

709

#

Bu Sun Kim

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

[diff] [blame]

710

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

711

#

Bu Sun Kim

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

[diff] [blame]

712

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

Dan O'Meara

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

[diff] [blame]

713

#

714

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

715

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

716

{

Bu Sun Kim

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

[diff] [blame]

717

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

718

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

719

},

720

],

Bu Sun Kim

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

[diff] [blame]

721

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

722

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

723

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

724

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

725

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

726

#

727

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

728

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

729

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

730

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

731

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

732

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

733

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

734

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

735

},

Bu Sun Kim

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

[diff] [blame]

736

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

737

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

738

"targetShape": "A String", # The shape to which the group converges either proactively or on resize events (depending on the value set in updatePolicy.instanceRedistributionType). The possible values are EVEN and ANY. For EVEN the group attempts to preserve a balanced number of instances across zones. For ANY the group creates new instances where resources are available to fulfill the request; as a result, instances may be distributed unevenly across zones in this mode. The default value is EVEN.

739

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

Bu Sun Kim

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

[diff] [blame]

740

{

Bu Sun Kim

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

[diff] [blame]

741

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

742

},

743

],

744

},

Bu Sun Kim

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

[diff] [blame]

745

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

746

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

747

#

748

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

749

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

750

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

751

"instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.

Bu Sun Kim

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

[diff] [blame]

752

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

753

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

754

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

755

{ # The named port. For example: .

756

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

757

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

758

},

759

],

760

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

761

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

762

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

763

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

764

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

765

},

766

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

767

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

768

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

769

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

770

"preservedState": { # Configuration of preserved resources.

771

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

772

"a_key": {

773

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

778

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

779

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

780

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

781

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

782

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

783

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

784

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

785

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

786

},

Bu Sun Kim

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

[diff] [blame]

787

},

788

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

789

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

790

},

791

},

792

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

793

"A String",

794

],

795

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

796

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

797

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

798

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

799

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

800

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

801

#

802

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

803

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

804

#

805

#

806

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

807

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

808

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

809

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

810

},

811

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

812

#

813

#

814

# - The instance's status is RUNNING.

815

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

816

#

817

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

818

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

819

#

820

#

821

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

822

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

823

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

824

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

825

},

826

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

827

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

828

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

829

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

830

},

831

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

832

#

833

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

834

{

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

835

"instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create new instances in the managed instance group until the `targetSize` for this version is reached. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE; in those cases, existing instances are updated until the `targetSize` for this version is reached.

Bu Sun Kim

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

[diff] [blame]

836

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

837

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

838

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

839

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

840

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

841

#

842

#

843

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

844

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

845

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

846

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

847

},

848

},

849

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

850

"zone": "A String", # [Output Only] The URL of a 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, region, body=None, requestId=None)</code>

856

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

857

858

A regional managed instance group can contain up to 2000 instances.

859

860

Args:

861

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

862

region: string, Name of the region scoping this request. (required)

863

body: object, The request body.

864

The object takes the form of:

865

866

{ # Represents a Managed Instance Group resource.

867

#

868

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

869

#

870

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

871

#

872

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

873

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

874

{

Bu Sun Kim

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

[diff] [blame]

875

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

876

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

877

},

878

],

Bu Sun Kim

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

[diff] [blame]

879

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

880

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

881

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

882

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

883

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

884

#

885

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

886

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

887

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

888

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

889

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

890

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

891

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

892

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

893

},

Bu Sun Kim

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

[diff] [blame]

894

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

895

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

896

"targetShape": "A String", # The shape to which the group converges either proactively or on resize events (depending on the value set in updatePolicy.instanceRedistributionType). The possible values are EVEN and ANY. For EVEN the group attempts to preserve a balanced number of instances across zones. For ANY the group creates new instances where resources are available to fulfill the request; as a result, instances may be distributed unevenly across zones in this mode. The default value is EVEN.

897

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

Dan O'Meara

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

[diff] [blame]

898

{

Bu Sun Kim

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

[diff] [blame]

899

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

900

},

901

],

902

},

Bu Sun Kim

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

[diff] [blame]

903

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

904

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

905

#

906

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

907

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

908

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

909

"instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.

Bu Sun Kim

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

[diff] [blame]

910

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

911

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

912

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

913

{ # The named port. For example: .

914

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

915

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

916

},

917

],

918

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

919

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

920

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

921

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

922

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

923

},

924

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

925

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

926

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

927

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

928

"preservedState": { # Configuration of preserved resources.

929

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

930

"a_key": {

931

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

936

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

937

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

938

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

939

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

940

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

941

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

942

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

943

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

944

},

Bu Sun Kim

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

[diff] [blame]

945

},

946

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

947

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

948

},

949

},

950

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

951

"A String",

952

],

953

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

954

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

955

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

956

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

957

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

958

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

959

#

960

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

961

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

962

#

963

#

964

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

965

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

966

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

967

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

968

},

969

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

970

#

971

#

972

# - The instance's status is RUNNING.

973

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

974

#

975

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

976

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

977

#

978

#

979

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

980

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

981

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

982

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

983

},

984

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

985

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

986

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

987

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

988

},

989

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

990

#

991

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

992

{

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

993

"instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create new instances in the managed instance group until the `targetSize` for this version is reached. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE; in those cases, existing instances are updated until the `targetSize` for this version is reached.

Bu Sun Kim

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

[diff] [blame]

994

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

995

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

996

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

997

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

998

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

999

#

1000

#

1001

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

1002

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

1003

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

1004

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

1005

},

1006

},

1007

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1008

"zone": "A String", # [Output Only] The URL of a zone where the managed instance group is located (for zonal resources).

Dan O'Meara

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

[diff] [blame]

1009

}

Sai Cheemalapati

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

[diff] [blame]

1010

Bu Sun Kim

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

[diff] [blame]

1011

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.

1012

1013

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.

1014

1015

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]

1016

1017

Returns:

1018

An object of the form:

1019

Bu Sun Kim

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

[diff] [blame]

1020

{ # Represents an Operation resource.

1021

#

Dan O'Meara

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

[diff] [blame]

1022

# Google Compute Engine has three Operation resources:

1023

#

1024

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

1025

#

Bu Sun Kim

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

[diff] [blame]

1026

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

1027

#

1028

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

1029

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

1030

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

1031

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

Bu Sun Kim

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

[diff] [blame]

1032

#

Dan O'Meara

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

[diff] [blame]

1033

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

1034

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

1035

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

1036

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

1037

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

1038

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

1039

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

Sai Cheemalapati

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

[diff] [blame]

1040

{

Bu Sun Kim

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

[diff] [blame]

1041

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

1042

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

1043

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

Sai Cheemalapati

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

[diff] [blame]

1044

},

1045

],

1046

},

Bu Sun Kim

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

[diff] [blame]

1047

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

1048

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

1049

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

1050

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

1051

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

1052

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

1053

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

1054

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

1055

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

1056

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

1057

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

1058

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

1059

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

1060

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

1061

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

1062

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

1063

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

1064

{

1065

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

1066

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

1067

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

1068

{

1069

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

1070

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

1071

},

1072

],

1073

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

1074

},

1075

],

1076

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

1081

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

Sai Cheemalapati

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

[diff] [blame]

1082

<pre>Retrieves the list of managed instance groups that are contained within the specified region.

1083

1084

Args:

1085

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

1086

region: string, Name of the region scoping this request. (required)

Dan O'Meara

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

[diff] [blame]

1087

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]

1088

Dan O'Meara

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

[diff] [blame]

1089

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]

1090

Dan O'Meara

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

[diff] [blame]

1091

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]

1092

Bu Sun Kim

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

[diff] [blame]

1093

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

1094

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

1095

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

1096

1097

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.

1098

1099

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

1100

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]

1101

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]

1102

1103

Returns:

1104

An object of the form:

1105

1106

{ # Contains a list of managed instance groups.

Bu Sun Kim

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

[diff] [blame]

1107

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

1108

"items": [ # A list of InstanceGroupManager resources.

Bu Sun Kim

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

[diff] [blame]

1109

{ # Represents a Managed Instance Group resource.

Dan O'Meara

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

[diff] [blame]

1110

#

1111

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

1112

#

1113

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

1114

#

1115

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

1116

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

1117

{

Bu Sun Kim

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

[diff] [blame]

1118

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

1119

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

1120

},

1121

],

Bu Sun Kim

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

[diff] [blame]

1122

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

1123

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

1124

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

1125

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

1126

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

1127

#

1128

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

1129

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

1130

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

1131

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

1132

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

1133

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

1134

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

1135

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

1136

},

Bu Sun Kim

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

[diff] [blame]

1137

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1138

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

1139

"targetShape": "A String", # The shape to which the group converges either proactively or on resize events (depending on the value set in updatePolicy.instanceRedistributionType). The possible values are EVEN and ANY. For EVEN the group attempts to preserve a balanced number of instances across zones. For ANY the group creates new instances where resources are available to fulfill the request; as a result, instances may be distributed unevenly across zones in this mode. The default value is EVEN.

1140

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

Dan O'Meara

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

[diff] [blame]

1141

{

Bu Sun Kim

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

[diff] [blame]

1142

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

1143

},

1144

],

1145

},

Bu Sun Kim

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

[diff] [blame]

1146

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

1147

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

1148

#

1149

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

1150

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

1151

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1152

"instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.

Bu Sun Kim

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

[diff] [blame]

1153

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

1154

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

1155

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

1156

{ # The named port. For example: .

1157

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

1158

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

1159

},

1160

],

1161

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

1162

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

1163

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

1164

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

1165

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

1166

},

1167

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

1168

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

1169

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

1170

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

1171

"preservedState": { # Configuration of preserved resources.

1172

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

1173

"a_key": {

1174

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

1179

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

1180

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

1181

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

1182

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

1183

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

1184

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

1185

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

1186

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

1187

},

Bu Sun Kim

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

[diff] [blame]

1188

},

1189

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

1190

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

1191

},

1192

},

1193

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

1194

"A String",

1195

],

1196

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

1197

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

1198

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

1199

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

1200

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

1201

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

1202

#

1203

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

1204

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

1205

#

1206

#

1207

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

1208

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

1209

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

1210

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

1211

},

1212

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

1213

#

1214

#

1215

# - The instance's status is RUNNING.

1216

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

1217

#

1218

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

1219

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

1220

#

1221

#

1222

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

1223

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

1224

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

1225

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

1226

},

1227

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

1228

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

1229

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

1230

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

1231

},

1232

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

1233

#

1234

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

1235

{

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1236

"instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create new instances in the managed instance group until the `targetSize` for this version is reached. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE; in those cases, existing instances are updated until the `targetSize` for this version is reached.

Bu Sun Kim

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

[diff] [blame]

1237

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

1238

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

1239

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

1240

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

1241

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

1242

#

1243

#

1244

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

1245

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

1246

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

1247

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

1248

},

1249

},

1250

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1251

"zone": "A String", # [Output Only] The URL of a zone where the managed instance group is located (for zonal resources).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1252

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1253

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1254

"kind": "compute#regionInstanceGroupManagerList", # [Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups that exist in th regional scope.

1255

"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.

1256

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

1257

"warning": { # [Output Only] Informational warning message.

1258

"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.

1259

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1260

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1261

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1262

"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).

1263

"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]

1264

},

1265

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1266

"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]

1267

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1272

<code class="details" id="listErrors">listErrors(project, region, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1273

<pre>Lists all errors thrown by actions on instances for a given regional managed instance group. The filter and orderBy query parameters are not supported.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1274

1275

Args:

1276

project: string, Project ID for this request. (required)

1277

region: string, Name of the region scoping this request. This should conform to RFC1035. (required)

1278

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]

1279

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 `<`.

1280

1281

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

1282

1283

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.

1284

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1285

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) ```

1286

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`)

1287

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

1288

1289

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.

1290

1291

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

1292

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]

1293

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]

1294

1295

Returns:

1296

An object of the form:

1297

1298

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1299

"items": [ # [Output Only] The list of errors of the managed instance group.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1300

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1301

"error": { # [Output Only] Contents of the error.

1302

"code": "A String", # [Output Only] Error code.

1303

"message": "A String", # [Output Only] Error message.

1304

},

1305

"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.

1306

"action": "A String", # [Output Only] Action that managed instance group was executing on the instance when the error occurred. Possible values:

1307

"instance": "A String", # [Output Only] The URL of the instance. The URL can be set even if the instance has not yet been created.

1308

"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.

1309

"instanceTemplate": "A String", # [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }.

1310

"name": "A String", # [Output Only] Name of the version.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1311

},

1312

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1313

"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]

1314

},

1315

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1316

"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>

1322

<pre>Retrieves the next page of results.

1323

1324

Args:

1325

previous_request: The request for the previous page. (required)

1326

previous_response: The response from the request for the previous page. (required)

1327

1328

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1329

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]

1330

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]

1335

<code class="details" id="listManagedInstances">listManagedInstances(project, region, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1336

<pre>Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. The orderBy query parameter is not supported.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1337

1338

Args:

1339

project: string, Project ID for this request. (required)

1340

region: string, Name of the region scoping this request. (required)

1341

instanceGroupManager: string, The name of the managed instance group. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1342

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]

1343

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1344

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]

1345

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1346

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]

1347

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1348

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) ```

1349

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`)

1350

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

1351

1352

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.

1353

1354

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

1355

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]

1356

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]

1357

1358

Returns:

1359

An object of the form:

1360

1361

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1362

"managedInstances": [ # A list of managed instances.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1363

{ # A Managed Instance resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1364

"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]

1365

# - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance.

1366

# - 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]

1367

# - 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]

1368

# - RECREATING The managed instance group is recreating this instance.

1369

# - DELETING The managed instance group is permanently deleting this instance.

1370

# - 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.

1371

# - RESTARTING The managed instance group is restarting the instance.

1372

# - 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]

1373

# - 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]

1374

"id": "A String", # [Output only] The unique identifier for this resource. This field is empty when instance does not exist.

1375

"instance": "A String", # [Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created.

1376

"instanceHealth": [ # [Output Only] Health state of the instance per health-check.

1377

{

1378

"detailedHealthState": "A String", # [Output Only] The current detailed instance health state.

1379

"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]

1380

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1381

],

1382

"instanceStatus": "A String", # [Output Only] The status of the instance. This field is empty when the instance does not exist.

1383

"lastAttempt": { # [Output Only] Information about the last attempt to create or delete the instance.

1384

"errors": { # [Output Only] Encountered errors during the last attempt to create or delete the instance.

1385

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

1386

{

1387

"code": "A String", # [Output Only] The error type identifier for this error.

1388

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1389

"message": "A String", # [Output Only] An optional, human-readable error message.

1390

},

1391

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1392

},

1393

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1394

"preservedStateFromConfig": { # Preserved state for a given instance. # [Output Only] Preserved state applied from per-instance config for this instance.

1395

"disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks.

1396

"a_key": {

1397

"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.

1398

"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.

1399

"source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance.

1400

},

1401

},

1402

"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.

1407

"disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks.

1408

"a_key": {

1409

"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.

1410

"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.

1411

"source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance.

1412

},

1413

},

1414

"metadata": { # Preserved metadata defined for this instance.

"a_key": "A String",

},

},

"version": { # [Output Only] Intended version of this instance.

1419

"instanceTemplate": "A String", # [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }.

1420

"name": "A String", # [Output Only] Name of the version.

1421

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1422

},

1423

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1424

"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]

1429

<code class="details" id="listManagedInstances_next">listManagedInstances_next(previous_request, previous_response)</code>

1430

<pre>Retrieves the next page of results.

1431

1432

Args:

1433

previous_request: The request for the previous page. (required)

1434

previous_response: The response from the request for the previous page. (required)

1435

1436

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1437

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1438

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]

1443

<code class="details" id="listPerInstanceConfigs">listPerInstanceConfigs(project, region, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1444

<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]

1445

1446

Args:

1447

project: string, Project ID for this request. (required)

1448

region: string, Name of the region scoping this request, should conform to RFC1035. (required)

1449

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]

1450

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 `<`.

1451

1452

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

1453

1454

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.

1455

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1456

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) ```

1457

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`)

1458

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

1459

1460

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.

1461

1462

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

1463

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]

1464

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]

1465

1466

Returns:

1467

An object of the form:

1468

1469

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1470

"items": [ # [Output Only] The list of PerInstanceConfig.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1471

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1472

"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.

1473

"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.

1474

"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.

1475

"disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks.

1476

"a_key": {

1477

"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.

1478

"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.

1479

"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]

1480

},

1481

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1482

"metadata": { # Preserved metadata defined for this instance.

1483

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1484

},

1485

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1486

"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]

1487

},

1488

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1489

"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.

1490

"warning": { # [Output Only] Informational warning message.

1491

"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.

1492

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1493

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1494

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1495

"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).

1496

"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]

1497

},

1498

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1499

"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>

1506

<pre>Retrieves the next page of results.

1507

1508

Args:

1509

previous_request: The request for the previous page. (required)

1510

previous_response: The response from the request for the previous page. (required)

1511

1512

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1513

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]

1514

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]

1519

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

1520

<pre>Retrieves the next page of results.

1521

1522

Args:

1523

previous_request: The request for the previous page. (required)

1524

previous_response: The response from the request for the previous page. (required)

1525

1526

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1527

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1528

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]

1533

<code class="details" id="patch">patch(project, region, instanceGroupManager, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1534

<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

2016-10-21 13:59:49 -0700

[diff] [blame]

1535

1536

Args:

1537

project: string, Project ID for this request. (required)

1538

region: string, Name of the region scoping this request. (required)

1539

instanceGroupManager: string, The name of the instance group manager. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1540

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1541

The object takes the form of:

1542

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1543

{ # Represents a Managed Instance Group resource.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1544

#

1545

# An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups.

1546

#

1547

# For zonal Managed Instance Group, use the instanceGroupManagers resource.

1548

#

1549

# 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]

1550

"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]

1551

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1552

"healthCheck": "A String", # The URL for the health check that signals autohealing.

1553

"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]

1554

},

1555

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1556

"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.

1557

"creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.

1558

"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.

1559

"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.

1560

"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]

1561

#

1562

# 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]

1563

"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.

1564

"deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.

1565

"none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.

1566

"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.

1567

"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.

1568

"restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.

1569

"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]

1570

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1571

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1572

"distributionPolicy": { # Policy specifying the intended distribution of managed instances across zones in a regional managed instance group.

1573

"targetShape": "A String", # The shape to which the group converges either proactively or on resize events (depending on the value set in updatePolicy.instanceRedistributionType). The possible values are EVEN and ANY. For EVEN the group attempts to preserve a balanced number of instances across zones. For ANY the group creates new instances where resources are available to fulfill the request; as a result, instances may be distributed unevenly across zones in this mode. The default value is EVEN.

1574

"zones": [ # Zones where the regional managed instance group will create and manage its instances.

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

"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]

1577

},

1578

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1579

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1580

"failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.

1581

"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.

1582

#

1583

# To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.

1584

"id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.

1585

"instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1586

"instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1587

"kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.

1588

"name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.

1589

"namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.

1590

{ # The named port. For example: .

1591

"name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.

1592

"port": 42, # The port number, which can be a value between 1 and 65535.

1593

},

1594

],

1595

"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.

1596

"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.

1597

"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.

1598

"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.

1599

"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.

1600

},

1601

"region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).

1602

"selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.

1603

"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.

1604

"statefulPolicy": { # Stateful configuration for this Instanced Group Manager

1605

"preservedState": { # Configuration of preserved resources.

1606

"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.

1607

"a_key": {

1608

"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]

1609

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1610

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1611

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1612

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1613

"status": { # [Output Only] The status of this managed instance group.

1614

"autoscaler": "A String", # [Output Only] The URL of the Autoscaler that targets this instance group manager.

1615

"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.

1616

"stateful": { # [Output Only] Stateful status of the given Instance Group Manager.

1617

"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.

1618

"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]

1619

"perInstanceConfigs": { # [Output Only] Status of per-instance configs on the instance.

1620

"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.

1621

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1622

},

1623

"versionTarget": { # [Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager.

1624

"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.

1625

},

1626

},

1627

"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.

1628

"A String",

1629

],

1630

"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.

1631

"updatePolicy": { # The update policy for this managed instance group.

1632

"instanceRedistributionType": "A String", # The instance redistribution policy for regional managed instance groups. Valid values are:

1633

# - PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region.

1634

# - NONE: For non-autoscaled groups, proactive redistribution is disabled.

1635

"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.

1636

#

1637

# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge.

1638

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

1639

#

1640

#

1641

# - If the value is fixed, then the calculated value is equal to the fixed value.

1642

# - 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.

1643

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

1644

"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

1645

},

1646

"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:

1647

#

1648

#

1649

# - The instance's status is RUNNING.

1650

# - 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.

1651

#

1652

# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable.

1653

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

1654

#

1655

#

1656

# - If the value is fixed, then the calculated value is equal to the fixed value.

1657

# - 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.

1658

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

1659

"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

1660

},

1661

"minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].

1662

"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.

1663

"replacementMethod": "A String", # What action should be used to replace instances. See minimal_action.REPLACE

1664

"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).

1665

},

1666

"versions": [ # Specifies the instance templates used by this managed instance group to create instances.

1667

#

1668

# 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.

1669

{

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1670

"instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create new instances in the managed instance group until the `targetSize` for this version is reached. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE; in those cases, existing instances are updated until the `targetSize` for this version is reached.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1671

"name": "A String", # Name of the version. Unique among all versions in the scope of this managed instance group.

1672

"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:

1673

# - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used.

1674

# - 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.

1675

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

1676

#

1677

#

1678

# - If the value is fixed, then the calculated value is equal to the fixed value.

1679

# - 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.

1680

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

1681

"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

1682

},

1683

},

1684

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1685

"zone": "A String", # [Output Only] The URL of a zone where the managed instance group is located (for zonal resources).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1686

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1687

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1688

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.

1689

1690

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.

1691

1692

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]

1693

1694

Returns:

1695

An object of the form:

1696

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1697

{ # Represents an Operation resource.

1698

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1699

# Google Compute Engine has three Operation resources:

1700

#

1701

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

1702

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1703

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

1704

#

1705

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1706

# - For global operations, use the `globalOperations` resource.

1707

# - For regional operations, use the `regionOperations` resource.

1708

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1709

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1710

# 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]

1711

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1712

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1713

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1714

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1715

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1716

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1717

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1718

"code": "A String", # [Output Only] The error type identifier for this error.

1719

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1720

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1721

},

1722

],

1723

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1724

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1725

"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.

1726

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

1727

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1728

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1729

"name": "A String", # [Output Only] Name of the operation.

1730

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1731

"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.

1732

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

1733

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1734

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1735

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

1736

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1737

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1738

"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.

1739

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1740

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1741

{

1742

"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.

1743

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1744

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

1745

{

1746

"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).

1747

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1748

},

1749

],

1750

"message": "A String", # [Output Only] A human-readable description of the warning code.

1751

},

1752

],

1753

"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]

1758

<code class="details" id="patchPerInstanceConfigs">patchPerInstanceConfigs(project, region, instanceGroupManager, body=None, requestId=None)</code>

1759

<pre>Insert or patch (for the ones that already exist) per-instance configs for the managed instance group. perInstanceConfig.instance serves as a key used to distinguish whether to perform insert or patch.

1760

1761

Args:

1762

project: string, Project ID for this request. (required)

1763

region: string, Name of the region scoping this request, should conform to RFC1035. (required)

1764

instanceGroupManager: string, The name of the managed instance group. It should conform to RFC1035. (required)

1765

body: object, The request body.

1766

The object takes the form of:

1767

1768

{ # RegionInstanceGroupManagers.patchPerInstanceConfigs

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1769

"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]

1770

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1771

"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.

1772

"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.

1773

"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.

1774

"disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks.

1775

"a_key": {

1776

"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.

1777

"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.

1778

"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]

1779

},

1780

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1781

"metadata": { # Preserved metadata defined for this instance.

1782

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1783

},

1784

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1785

"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.

1791

1792

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.

1793

1794

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

1795

1796

Returns:

1797

An object of the form:

1798

1799

{ # Represents an Operation resource.

1800

#

1801

# Google Compute Engine has three Operation resources:

1802

#

1803

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

1804

#

1805

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

1806

#

1807

# Operations can be global, regional or zonal.

1808

# - For global operations, use the `globalOperations` resource.

1809

# - For regional operations, use the `regionOperations` resource.

1810

# - For zonal operations, use the `zonalOperations` resource.

1811

#

1812

# 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]

1813

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1814

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1815

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1816

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1817

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1818

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1819

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1820

"code": "A String", # [Output Only] The error type identifier for this error.

1821

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1822

"message": "A String", # [Output Only] An optional, human-readable error message.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1823

},

1824

],

1825

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1826

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1827

"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.

1828

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

1829

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1830

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1831

"name": "A String", # [Output Only] Name of the operation.

1832

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1833

"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.

1834

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

1835

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1836

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1837

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

1838

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1839

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1840

"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.

1841

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1842

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1843

{

1844

"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.

1845

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1846

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

1847

{

1848

"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).

1849

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1850

},

1851

],

1852

"message": "A String", # [Output Only] A human-readable description of the warning code.

1853

},

1854

],

1855

"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, region, instanceGroupManager, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1861

<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]

1862

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1863

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.

1864

1865

You can specify a maximum of 1000 instances with this method per request.

1866

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1867

Args:

1868

project: string, Project ID for this request. (required)

1869

region: string, Name of the region scoping this request. (required)

1870

instanceGroupManager: string, Name of the managed instance group. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1871

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1872

The object takes the form of:

1873

1874

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1875

"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].

1876

"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]

1880

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.

1881

1882

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.

1883

1884

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]

1885

1886

Returns:

1887

An object of the form:

1888

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1889

{ # Represents an Operation resource.

1890

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1891

# Google Compute Engine has three Operation resources:

1892

#

1893

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

1894

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1895

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

1896

#

1897

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1898

# - For global operations, use the `globalOperations` resource.

1899

# - For regional operations, use the `regionOperations` resource.

1900

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1901

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1902

# 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]

1903

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1904

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1905

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1906

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1907

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1908

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1909

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1910

"code": "A String", # [Output Only] The error type identifier for this error.

1911

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1912

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1913

},

1914

],

1915

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1916

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1917

"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.

1918

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

1919

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1920

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1921

"name": "A String", # [Output Only] Name of the operation.

1922

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1923

"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.

1924

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

1925

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1926

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1927

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

1928

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1929

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1930

"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.

1931

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1932

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1933

{

1934

"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.

1935

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1936

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

1937

{

1938

"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).

1939

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1940

},

1941

],

1942

"message": "A String", # [Output Only] A human-readable description of the warning code.

1943

},

1944

],

1945

"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]

1950

<code class="details" id="resize">resize(project, region, instanceGroupManager, size, requestId=None)</code>

1951

<pre>Changes the intended size of the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances.

1952

1953

The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1954

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1955

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.

1956

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1957

Args:

1958

project: string, Project ID for this request. (required)

1959

region: string, Name of the region scoping this request. (required)

1960

instanceGroupManager: string, Name of the managed instance group. (required)

1961

size: integer, Number of instances that should exist in this instance group manager. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1962

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.

1963

1964

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.

1965

1966

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]

1967

1968

Returns:

1969

An object of the form:

1970

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1971

{ # Represents an Operation resource.

1972

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1973

# Google Compute Engine has three Operation resources:

1974

#

1975

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

1976

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1977

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

1978

#

1979

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1980

# - For global operations, use the `globalOperations` resource.

1981

# - For regional operations, use the `regionOperations` resource.

1982

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1983

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1984

# 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]

1985

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1986

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1987

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1988

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1989

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1990

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1991

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1992

"code": "A String", # [Output Only] The error type identifier for this error.

1993

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1994

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1995

},

1996

],

1997

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1998

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1999

"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.

2000

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2001

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2002

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2003

"name": "A String", # [Output Only] Name of the operation.

2004

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2005

"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.

2006

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2007

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2008

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2009

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2010

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2011

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2012

"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.

2013

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2014

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2015

{

2016

"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.

2017

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2018

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2019

{

2020

"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).

2021

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2022

},

2023

],

2024

"message": "A String", # [Output Only] A human-readable description of the warning code.

2025

},

2026

],

2027

"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]

2032

<code class="details" id="setAutoHealingPolicies">setAutoHealingPolicies(project, region, instanceGroupManager, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2033

<pre>Modifies the autohealing policy for the instances in this managed instance group. [Deprecated] This method is deprecated. Please use Patch instead.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2034

2035

Args:

2036

project: string, Project ID for this request. (required)

2037

region: string, Name of the region scoping this request. (required)

2038

instanceGroupManager: string, Name of the managed instance group. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2039

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2040

The object takes the form of:

2041

2042

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2043

"autoHealingPolicies": [

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2044

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2045

"healthCheck": "A String", # The URL for the health check that signals autohealing.

2046

"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]

2051

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.

2052

2053

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.

2054

2055

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]

2056

2057

Returns:

2058

An object of the form:

2059

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2060

{ # Represents an Operation resource.

2061

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2062

# Google Compute Engine has three Operation resources:

2063

#

2064

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2065

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2066

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2067

#

2068

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2069

# - For global operations, use the `globalOperations` resource.

2070

# - For regional operations, use the `regionOperations` resource.

2071

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2072

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2073

# 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]

2074

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2075

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2076

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2077

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2078

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2079

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2080

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2081

"code": "A String", # [Output Only] The error type identifier for this error.

2082

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2083

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2084

},

2085

],

2086

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2087

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2088

"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.

2089

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2090

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2091

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2092

"name": "A String", # [Output Only] Name of the operation.

2093

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2094

"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.

2095

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2096

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2097

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2098

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2099

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2100

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2101

"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.

2102

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2103

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2104

{

2105

"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.

2106

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2107

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2108

{

2109

"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).

2110

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2111

},

2112

],

2113

"message": "A String", # [Output Only] A human-readable description of the warning code.

2114

},

2115

],

2116

"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]

2121

<code class="details" id="setInstanceTemplate">setInstanceTemplate(project, region, instanceGroupManager, body=None, requestId=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2122

<pre>Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected.

2123

2124

Args:

2125

project: string, Project ID for this request. (required)

2126

region: string, Name of the region scoping this request. (required)

2127

instanceGroupManager: string, The name of the managed instance group. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2128

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2129

The object takes the form of:

2130

2131

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2132

"instanceTemplate": "A String", # URL of the InstanceTemplate resource from which all new instances will be created.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2133

}

2134

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2135

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.

2136

2137

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.

2138

2139

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]

2140

2141

Returns:

2142

An object of the form:

2143

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2144

{ # Represents an Operation resource.

2145

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2146

# Google Compute Engine has three Operation resources:

2147

#

2148

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2149

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2150

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2151

#

2152

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2153

# - For global operations, use the `globalOperations` resource.

2154

# - For regional operations, use the `regionOperations` resource.

2155

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2156

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2157

# 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]

2158

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2159

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2160

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2161

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2162

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2163

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2164

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2165

"code": "A String", # [Output Only] The error type identifier for this error.

2166

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2167

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2168

},

2169

],

2170

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2171

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2172

"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.

2173

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2174

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2175

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2176

"name": "A String", # [Output Only] Name of the operation.

2177

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2178

"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.

2179

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2180

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2181

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2182

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2183

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2184

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2185

"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.

2186

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2187

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2188

{

2189

"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.

2190

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2191

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2192

{

2193

"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).

2194

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2195

},

2196

],

2197

"message": "A String", # [Output Only] A human-readable description of the warning code.

2198

},

2199

],

2200

"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]

2205

<code class="details" id="setTargetPools">setTargetPools(project, region, instanceGroupManager, body=None, requestId=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2206

<pre>Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.

2207

2208

Args:

2209

project: string, Project ID for this request. (required)

2210

region: string, Name of the region scoping this request. (required)

2211

instanceGroupManager: string, Name of the managed instance group. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2212

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2213

The object takes the form of:

2214

2215

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2216

"fingerprint": "A String", # Fingerprint of the target pools information, which is a hash of the contents. This field is used for optimistic locking when you update the target pool entries. This field is optional.

2217

"targetPools": [ # The URL of all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.

2218

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2219

],

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2220

}

2221

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2222

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.

2223

2224

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.

2225

2226

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]

2227

2228

Returns:

2229

An object of the form:

2230

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2231

{ # Represents an Operation resource.

2232

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2233

# Google Compute Engine has three Operation resources:

2234

#

2235

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2236

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2237

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2238

#

2239

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2240

# - For global operations, use the `globalOperations` resource.

2241

# - For regional operations, use the `regionOperations` resource.

2242

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2243

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2244

# 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]

2245

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2246

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2247

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2248

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2249

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2250

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2251

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2252

"code": "A String", # [Output Only] The error type identifier for this error.

2253

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2254

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2255

},

2256

],

2257

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2258

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2259

"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.

2260

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2261

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2262

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2263

"name": "A String", # [Output Only] Name of the operation.

2264

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2265

"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.

2266

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2267

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2268

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2269

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2270

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2271

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2272

"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.

2273

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2274

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2275

{

2276

"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.

2277

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2278

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2279

{

2280

"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).

2281

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2282

},

2283

],

2284

"message": "A String", # [Output Only] A human-readable description of the warning code.

2285

},

2286

],

2287

"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]

2292

<code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2293

<pre>Returns permissions that a caller has on the specified resource.

2294

2295

Args:

2296

project: string, Project ID for this request. (required)

2297

region: string, The name of the region for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2298

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2299

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2300

The object takes the form of:

2301

2302

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2303

"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.

2304

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

],

}

Returns:

An object of the form:

2311

2312

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2313

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.

2314

"A String",

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]

2320

<code class="details" id="update">update(project, region, instanceGroupManager, body=None, requestId=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2321

<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.

2322

2323

Args:

2324

project: string, Project ID for this request. (required)

2325

region: string, Name of the region scoping this request. (required)

2326

instanceGroupManager: string, The name of the instance group manager. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2327

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2328

The object takes the form of:

2329

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2330

{ # Represents a Managed Instance Group resource.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2331

#

2332

# An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups.

2333

#

2334

# For zonal Managed Instance Group, use the instanceGroupManagers resource.

2335

#

2336

# 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]

2337

"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]

2338

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2339

"healthCheck": "A String", # The URL for the health check that signals autohealing.

2340

"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]

2341

},

2342

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2343

"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.

2344

"creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.

2345

"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.

2346

"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.

2347

"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]

2348

#

2349

# 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]

2350

"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.

2351

"deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.

2352

"none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.

2353

"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.

2354

"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.

2355

"restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.

2356

"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]

2357

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2358

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

2359

"distributionPolicy": { # Policy specifying the intended distribution of managed instances across zones in a regional managed instance group.

2360

"targetShape": "A String", # The shape to which the group converges either proactively or on resize events (depending on the value set in updatePolicy.instanceRedistributionType). The possible values are EVEN and ANY. For EVEN the group attempts to preserve a balanced number of instances across zones. For ANY the group creates new instances where resources are available to fulfill the request; as a result, instances may be distributed unevenly across zones in this mode. The default value is EVEN.

2361

"zones": [ # Zones where the regional managed instance group will create and manage its instances.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2362

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2363

"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]

2364

},

2365

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2366

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2367

"failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.

2368

"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.

2369

#

2370

# To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.

2371

"id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.

2372

"instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

2373

"instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2374

"kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.

2375

"name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.

2376

"namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.

2377

{ # The named port. For example: .

2378

"name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.

2379

"port": 42, # The port number, which can be a value between 1 and 65535.

2380

},

2381

],

2382

"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.

2383

"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.

2384

"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.

2385

"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.

2386

"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.

2387

},

2388

"region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).

2389

"selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.

2390

"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.

2391

"statefulPolicy": { # Stateful configuration for this Instanced Group Manager

2392

"preservedState": { # Configuration of preserved resources.

2393

"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.

2394

"a_key": {

2395

"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]

2396

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2397

},

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

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2400

"status": { # [Output Only] The status of this managed instance group.

2401

"autoscaler": "A String", # [Output Only] The URL of the Autoscaler that targets this instance group manager.

2402

"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.

2403

"stateful": { # [Output Only] Stateful status of the given Instance Group Manager.

2404

"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.

2405

"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]

2406

"perInstanceConfigs": { # [Output Only] Status of per-instance configs on the instance.

2407

"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.

2408

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2409

},

2410

"versionTarget": { # [Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager.

2411

"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.

2412

},

2413

},

2414

"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.

2415

"A String",

2416

],

2417

"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.

2418

"updatePolicy": { # The update policy for this managed instance group.

2419

"instanceRedistributionType": "A String", # The instance redistribution policy for regional managed instance groups. Valid values are:

2420

# - PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region.

2421

# - NONE: For non-autoscaled groups, proactive redistribution is disabled.

2422

"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.

2423

#

2424

# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge.

2425

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

2426

#

2427

#

2428

# - If the value is fixed, then the calculated value is equal to the fixed value.

2429

# - 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.

2430

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

2431

"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

2432

},

2433

"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:

2434

#

2435

#

2436

# - The instance's status is RUNNING.

2437

# - 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.

2438

#

2439

# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable.

2440

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

2441

#

2442

#

2443

# - If the value is fixed, then the calculated value is equal to the fixed value.

2444

# - 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.

2445

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

2446

"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

2447

},

2448

"minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].

2449

"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.

2450

"replacementMethod": "A String", # What action should be used to replace instances. See minimal_action.REPLACE

2451

"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).

2452

},

2453

"versions": [ # Specifies the instance templates used by this managed instance group to create instances.

2454

#

2455

# 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.

2456

{

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

2457

"instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create new instances in the managed instance group until the `targetSize` for this version is reached. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE; in those cases, existing instances are updated until the `targetSize` for this version is reached.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2458

"name": "A String", # Name of the version. Unique among all versions in the scope of this managed instance group.

2459

"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:

2460

# - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used.

2461

# - 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.

2462

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

2463

#

2464

#

2465

# - If the value is fixed, then the calculated value is equal to the fixed value.

2466

# - 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.

2467

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

2468

"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

2469

},

2470

},

2471

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

2472

"zone": "A String", # [Output Only] The URL of a zone where the managed instance group is located (for zonal resources).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2473

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2474

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2475

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.

2476

2477

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.

2478

2479

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]

2480

2481

Returns:

2482

An object of the form:

2483

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2484

{ # Represents an Operation resource.

2485

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2486

# Google Compute Engine has three Operation resources:

2487

#

2488

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2489

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2490

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2491

#

2492

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2493

# - For global operations, use the `globalOperations` resource.

2494

# - For regional operations, use the `regionOperations` resource.

2495

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2496

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2497

# 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]

2498

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2499

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2500

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2501

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2502

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2503

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2504

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2505

"code": "A String", # [Output Only] The error type identifier for this error.

2506

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2507

"message": "A String", # [Output Only] An optional, human-readable error message.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2508

},

2509

],

2510

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2511

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2512

"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.

2513

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2514

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2515

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2516

"name": "A String", # [Output Only] Name of the operation.

2517

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2518

"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.

2519

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2520

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2521

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2522

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2523

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2524

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2525

"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.

2526

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2527

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2528

{

2529

"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.

2530

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2531

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2532

{

2533

"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).

2534

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2535

},

2536

],

2537

"message": "A String", # [Output Only] A human-readable description of the warning code.

2538

},

2539

],

2540

"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, region, instanceGroupManager, body=None, requestId=None)</code>

2546

<pre>Insert or update (for the ones that already exist) per-instance configs for the managed instance group. perInstanceConfig.instance serves as a key used to distinguish whether to perform insert or patch.

2547

2548

Args:

2549

project: string, Project ID for this request. (required)

2550

region: string, Name of the region scoping this request, should conform to RFC1035. (required)

2551

instanceGroupManager: string, The name of the managed instance group. It should conform to RFC1035. (required)

2552

body: object, The request body.

2553

The object takes the form of:

2554

2555

{ # RegionInstanceGroupManagers.updatePerInstanceConfigs

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2556

"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]

2557

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2558

"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.

2559

"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.

2560

"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.

2561

"disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks.

2562

"a_key": {

2563

"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.

2564

"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.

2565

"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]

2566

},

2567

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2568

"metadata": { # Preserved metadata defined for this instance.

2569

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2570

},

2571

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2572

"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.

2578

2579

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.

2580

2581

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

2582

2583

Returns:

2584

An object of the form:

2585

2586

{ # Represents an Operation resource.

2587

#

2588

# Google Compute Engine has three Operation resources:

2589

#

2590

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2591

#

2592

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2593

#

2594

# Operations can be global, regional or zonal.

2595

# - For global operations, use the `globalOperations` resource.

2596

# - For regional operations, use the `regionOperations` resource.

2597

# - For zonal operations, use the `zonalOperations` resource.

2598

#

2599

# 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]

2600

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2601

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2602

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2603

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2604

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2605

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2606

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2607

"code": "A String", # [Output Only] The error type identifier for this error.

2608

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2609

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2610

},

2611

],

2612

},

Bu Sun Kim