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

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

[diff] [blame]

78

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

Bu Sun Kim

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

[diff] [blame]

79

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

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

Dan O'Meara

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

[diff] [blame]

84

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

Bu Sun Kim

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

[diff] [blame]

85

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

Sai Cheemalapati

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

[diff] [blame]

86

Sai Cheemalapati

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

[diff] [blame]

87

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

Sai Cheemalapati

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

[diff] [blame]

88

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

89

Dan O'Meara

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

[diff] [blame]

90

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

91

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

92

Dan O'Meara

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

[diff] [blame]

93

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

Bu Sun Kim

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

[diff] [blame]

94

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

Sai Cheemalapati

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

[diff] [blame]

95

96

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

97

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

98

Dan O'Meara

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

[diff] [blame]

99

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

100

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

101

Bu Sun Kim

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

[diff] [blame]

102

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

103

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

104

Bu Sun Kim

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

[diff] [blame]

105

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

106

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

Bu Sun Kim

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

[diff] [blame]

107

108

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

109

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

110

Bu Sun Kim

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

[diff] [blame]

111

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

112

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

113

Sai Cheemalapati

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

[diff] [blame]

114

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

115

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

116

Bu Sun Kim

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

[diff] [blame]

117

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

118

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

Bu Sun Kim

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

[diff] [blame]

119

120

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

121

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

122

Sai Cheemalapati

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

[diff] [blame]

123

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

124

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

125

Dan O'Meara

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

[diff] [blame]

126

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

127

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

128

Dan O'Meara

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

[diff] [blame]

129

<code><a href="#patchPerInstanceConfigs">patchPerInstanceConfigs(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">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>

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="#recreateInstances">recreateInstances(project, region, instanceGroupManager, body=None, requestId=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

133

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

134

Sai Cheemalapati

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

[diff] [blame]

135

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

Bu Sun Kim

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

[diff] [blame]

136

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

137

Dan O'Meara

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

[diff] [blame]

138

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

139

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

140

Dan O'Meara

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

[diff] [blame]

141

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

142

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

143

Dan O'Meara

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

[diff] [blame]

144

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

145

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

146

Dan O'Meara

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

[diff] [blame]

147

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

Sai Cheemalapati

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

[diff] [blame]

148

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

149

Dan O'Meara

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

[diff] [blame]

150

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

151

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

Bu Sun Kim

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

[diff] [blame]

152

Dan O'Meara

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

[diff] [blame]

153

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

Bu Sun Kim

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

[diff] [blame]

154

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

155

<h3>Method Details</h3>

156

Dan O'Meara

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

[diff] [blame]

157

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

158

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

159

Sai Cheemalapati

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

[diff] [blame]

160

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.

161

162

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

163

Sai Cheemalapati

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

[diff] [blame]

164

Args:

165

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

166

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

167

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

Dan O'Meara

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

[diff] [blame]

168

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

169

The object takes the form of:

170

171

{

Bu Sun Kim

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

[diff] [blame]

172

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

173

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

177

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.

178

179

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.

180

181

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]

182

183

Returns:

184

An object of the form:

185

Bu Sun Kim

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

[diff] [blame]

186

{ # Represents an Operation resource.

187

#

Dan O'Meara

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

[diff] [blame]

188

# Google Compute Engine has three Operation resources:

189

#

190

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

191

#

Bu Sun Kim

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

[diff] [blame]

192

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

193

#

194

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

195

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

196

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

197

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

Bu Sun Kim

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

[diff] [blame]

198

#

Dan O'Meara

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

[diff] [blame]

199

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

200

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

201

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

202

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

203

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

204

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

205

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

Bu Sun Kim

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

[diff] [blame]

206

{

Bu Sun Kim

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

[diff] [blame]

207

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

208

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

209

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

Bu Sun Kim

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

[diff] [blame]

210

},

211

],

212

},

Bu Sun Kim

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

[diff] [blame]

213

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

214

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

215

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

216

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

217

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

218

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

219

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

220

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

221

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

222

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

223

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

224

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

225

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

226

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

227

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

228

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

229

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

230

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

231

{

232

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

233

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

234

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

235

{

236

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

237

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

238

},

239

],

240

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

241

},

242

],

243

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

248

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

Bu Sun Kim

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

[diff] [blame]

249

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

250

251

Args:

252

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

253

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

254

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]

255

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

256

The object takes the form of:

257

258

{ # InstanceGroupManagers.applyUpdatesToInstances

Bu Sun Kim

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

[diff] [blame]

259

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

260

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

261

"A String",

Bu Sun Kim

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

[diff] [blame]

262

],

Bu Sun Kim

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

[diff] [blame]

263

"maximalAction": "A String", # The maximal action that should be performed on the instances. By default REPLACE. This field is deprecated, please use most_disruptive_allowed_action.

264

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

265

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

266

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

267

# - REFRESH: Do not stop the instance.

268

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

269

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

270

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

271

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

272

# - REFRESH: Do not stop the instance.

273

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

279

280

{ # Represents an Operation resource.

281

#

Dan O'Meara

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

[diff] [blame]

282

# Google Compute Engine has three Operation resources:

283

#

284

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

285

#

Bu Sun Kim

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

[diff] [blame]

286

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

287

#

288

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

289

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

290

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

291

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

Bu Sun Kim

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

[diff] [blame]

292

#

Dan O'Meara

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

[diff] [blame]

293

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

294

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

295

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

296

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

297

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

298

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

299

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

Bu Sun Kim

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

[diff] [blame]

300

{

Bu Sun Kim

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

[diff] [blame]

301

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

302

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

303

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

Bu Sun Kim

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

[diff] [blame]

304

},

305

],

306

},

Bu Sun Kim

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

[diff] [blame]

307

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

308

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

309

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

310

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

311

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

312

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

313

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

314

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

315

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

316

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

317

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

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.

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

342

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

Bu Sun Kim

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

[diff] [blame]

343

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

344

345

Args:

346

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

347

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

348

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]

349

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

350

The object takes the form of:

351

352

{ # RegionInstanceGroupManagers.createInstances

Bu Sun Kim

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

[diff] [blame]

353

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

Bu Sun Kim

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

[diff] [blame]

354

{

Bu Sun Kim

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

[diff] [blame]

355

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

356

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

357

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

358

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

359

"a_key": {

360

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

361

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

362

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

Bu Sun Kim

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

[diff] [blame]

363

},

364

},

Bu Sun Kim

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

[diff] [blame]

365

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

366

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

367

},

368

},

Bu Sun Kim

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

[diff] [blame]

369

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

Bu Sun Kim

2019-06-14 16:50:42 -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.

375

376

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.

377

378

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

379

380

Returns:

381

An object of the form:

382

383

{ # Represents an Operation resource.

384

#

Dan O'Meara

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

[diff] [blame]

385

# Google Compute Engine has three Operation resources:

386

#

387

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

388

#

Bu Sun Kim

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

[diff] [blame]

389

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

390

#

391

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

392

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

393

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

394

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

Bu Sun Kim

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

[diff] [blame]

395

#

Dan O'Meara

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

[diff] [blame]

396

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

397

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

398

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

399

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

400

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

401

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

402

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

Sai Cheemalapati

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

[diff] [blame]

403

{

Bu Sun Kim

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

[diff] [blame]

404

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

405

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

406

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

Sai Cheemalapati

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

[diff] [blame]

407

},

408

],

409

},

Bu Sun Kim

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

[diff] [blame]

410

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

411

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

412

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

413

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

414

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

415

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

416

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

417

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

418

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

419

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

420

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

421

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

422

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

423

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

424

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

425

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

426

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

427

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

428

{

429

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

430

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

431

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

432

{

433

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

434

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

435

},

436

],

437

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

438

},

439

],

440

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

Sai Cheemalapati

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

[diff] [blame]

445

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

Sai Cheemalapati

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

[diff] [blame]

446

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

447

448

Args:

449

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

450

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

451

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

Bu Sun Kim

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

[diff] [blame]

452

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.

453

454

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.

455

456

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]

457

458

Returns:

459

An object of the form:

460

Bu Sun Kim

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

[diff] [blame]

461

{ # Represents an Operation resource.

462

#

Dan O'Meara

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

[diff] [blame]

463

# Google Compute Engine has three Operation resources:

464

#

465

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

466

#

Bu Sun Kim

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

[diff] [blame]

467

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

468

#

469

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

470

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

471

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

472

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

Bu Sun Kim

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

[diff] [blame]

473

#

Dan O'Meara

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

[diff] [blame]

474

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

475

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

476

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

477

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

478

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

479

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

480

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

Sai Cheemalapati

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

[diff] [blame]

481

{

Bu Sun Kim

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

[diff] [blame]

482

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

483

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

484

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

Sai Cheemalapati

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

[diff] [blame]

485

},

486

],

487

},

Bu Sun Kim

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

[diff] [blame]

488

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

489

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

490

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

491

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

492

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

493

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

494

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

495

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

496

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

497

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

498

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

499

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

500

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

501

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

502

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

503

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

504

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

505

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

506

{

507

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

508

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

509

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

510

{

511

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

512

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

513

},

514

],

515

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

516

},

517

],

518

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

523

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

524

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

525

Sai Cheemalapati

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

[diff] [blame]

526

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.

527

528

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

529

Sai Cheemalapati

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

[diff] [blame]

530

Args:

531

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

532

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

533

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

Dan O'Meara

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

[diff] [blame]

534

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

535

The object takes the form of:

536

537

{

Bu Sun Kim

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

[diff] [blame]

538

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

539

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

543

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.

544

545

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.

546

547

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]

548

549

Returns:

550

An object of the form:

551

Bu Sun Kim

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

[diff] [blame]

552

{ # Represents an Operation resource.

553

#

Dan O'Meara

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

[diff] [blame]

554

# Google Compute Engine has three Operation resources:

555

#

556

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

557

#

Bu Sun Kim

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

[diff] [blame]

558

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

559

#

560

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

561

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

562

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

563

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

Bu Sun Kim

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

[diff] [blame]

564

#

Dan O'Meara

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

[diff] [blame]

565

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

566

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

567

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

568

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

569

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

570

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

571

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

Bu Sun Kim

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

[diff] [blame]

572

{

Bu Sun Kim

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

[diff] [blame]

573

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

574

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

575

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

Bu Sun Kim

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

[diff] [blame]

576

},

577

],

578

},

Bu Sun Kim

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

[diff] [blame]

579

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

580

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

581

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

582

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

583

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

584

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

585

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

586

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

587

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

588

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

589

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

590

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

591

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

592

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

593

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

594

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

595

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

596

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

597

{

598

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

599

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

600

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

601

{

602

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

603

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

604

},

605

],

606

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

607

},

608

],

609

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

614

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

Bu Sun Kim

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

[diff] [blame]

615

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

616

617

Args:

618

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

619

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

620

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]

621

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

622

The object takes the form of:

623

624

{ # RegionInstanceGroupManagers.deletePerInstanceConfigs

Bu Sun Kim

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

[diff] [blame]

625

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

626

"A String",

Bu Sun Kim

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

[diff] [blame]

],

}

Returns:

An object of the form:

633

634

{ # Represents an Operation resource.

635

#

Dan O'Meara

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

[diff] [blame]

636

# Google Compute Engine has three Operation resources:

637

#

638

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

639

#

Bu Sun Kim

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

[diff] [blame]

640

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

641

#

642

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

643

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

644

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

645

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

Bu Sun Kim

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

[diff] [blame]

646

#

Dan O'Meara

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

[diff] [blame]

647

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

648

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

649

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

650

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

651

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

652

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

653

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

Sai Cheemalapati

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

[diff] [blame]

654

{

Bu Sun Kim

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

[diff] [blame]

655

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

656

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

657

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

Sai Cheemalapati

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

[diff] [blame]

658

},

659

],

660

},

Bu Sun Kim

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

[diff] [blame]

661

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

662

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

663

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

664

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

665

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

666

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

667

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

668

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

669

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

670

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

671

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

672

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

673

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

674

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

675

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

676

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

677

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

678

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

679

{

680

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

681

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

682

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

683

{

684

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

685

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

686

},

687

],

688

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

689

},

690

],

691

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

697

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

698

699

Args:

700

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

701

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

702

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

703

704

Returns:

705

An object of the form:

706

Bu Sun Kim

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

[diff] [blame]

707

{ # Represents a Managed Instance Group resource.

708

#

709

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

710

#

711

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

712

#

Dan O'Meara

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

[diff] [blame]

713

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

714

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

715

{

Bu Sun Kim

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

[diff] [blame]

716

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

717

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

718

"maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when autohealing. When 'percent' is used, the value is rounded UP. The instance is considered available if all of the following conditions are satisfied: 1. Instance's status is RUNNING. 2. Instance's currentAction is NONE (in particular its liveness health check result was observed to be HEALTHY at least once as it passed VERIFYING). 3. There is no outgoing action on an instance triggered by IGM.

Bu Sun Kim

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

[diff] [blame]

719

#

720

# By default, number of concurrently autohealed instances is smaller than the managed instance group target size. However, if a zonal managed instance group has only one instance, or a regional managed instance group has only one instance per zone, autohealing will recreate these instances when they become unhealthy.

Bu Sun Kim

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

[diff] [blame]

721

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

Bu Sun Kim

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

[diff] [blame]

722

#

723

#

724

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

725

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

Bu Sun Kim

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

[diff] [blame]

726

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

727

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

728

},

729

},

730

],

Bu Sun Kim

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

[diff] [blame]

731

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

732

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

733

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

734

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

735

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

736

#

737

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

738

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

739

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

740

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

741

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

742

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

743

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

744

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

745

},

Bu Sun Kim

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

[diff] [blame]

746

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

747

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

748

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

749

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

Sai Cheemalapati

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

[diff] [blame]

750

{

Bu Sun Kim

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

[diff] [blame]

751

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

Sai Cheemalapati

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

[diff] [blame]

752

},

753

],

754

},

Bu Sun Kim

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

[diff] [blame]

755

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

756

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

757

#

758

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

759

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

760

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

761

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

762

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

763

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

764

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

765

{ # The named port. For example: .

766

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

767

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

768

},

769

],

770

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

771

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

772

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

773

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

774

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

775

},

776

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

777

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

778

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

779

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

780

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

781

"preservedState": { # Configuration of preserved resources.

782

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

783

"a_key": {

784

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

},

},

},

},

Bu Sun Kim

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

[diff] [blame]

789

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

790

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

791

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

792

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

793

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

794

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

795

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

796

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

797

},

Bu Sun Kim

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

[diff] [blame]

798

},

799

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

800

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

801

},

802

},

803

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

804

"A String",

805

],

806

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

807

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

808

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

809

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

810

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

811

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

812

#

813

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

814

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

815

#

816

#

817

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

818

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

819

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

820

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

821

},

822

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

823

#

824

#

825

# - The instance's status is RUNNING.

826

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

827

#

828

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

829

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

830

#

831

#

832

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

833

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

834

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

835

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

836

},

837

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

838

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

839

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

840

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

841

},

842

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

843

#

844

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

845

{

846

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

847

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

848

"tag": "A String", # Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged. Deprecated in favor of 'name'.

849

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

850

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

851

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

852

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

853

#

854

#

855

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

856

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

857

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

858

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

},

},

],

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

867

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

Bu Sun Kim

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

[diff] [blame]

868

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

869

870

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

871

872

Args:

873

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

874

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

Dan O'Meara

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

[diff] [blame]

875

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

876

The object takes the form of:

877

878

{ # Represents a Managed Instance Group resource.

879

#

880

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

881

#

882

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

883

#

Dan O'Meara

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

[diff] [blame]

884

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

885

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

886

{

Bu Sun Kim

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

[diff] [blame]

887

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

888

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

889

"maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when autohealing. When 'percent' is used, the value is rounded UP. The instance is considered available if all of the following conditions are satisfied: 1. Instance's status is RUNNING. 2. Instance's currentAction is NONE (in particular its liveness health check result was observed to be HEALTHY at least once as it passed VERIFYING). 3. There is no outgoing action on an instance triggered by IGM.

Bu Sun Kim

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

[diff] [blame]

890

#

891

# By default, number of concurrently autohealed instances is smaller than the managed instance group target size. However, if a zonal managed instance group has only one instance, or a regional managed instance group has only one instance per zone, autohealing will recreate these instances when they become unhealthy.

Bu Sun Kim

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

[diff] [blame]

892

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

Bu Sun Kim

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

[diff] [blame]

893

#

894

#

895

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

896

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

Bu Sun Kim

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

[diff] [blame]

897

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

898

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

Bu Sun Kim

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

[diff] [blame]

899

},

900

},

901

],

Bu Sun Kim

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

[diff] [blame]

902

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

903

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

904

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

905

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

906

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

907

#

908

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

909

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

910

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

911

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

912

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

913

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

914

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

915

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

916

},

Bu Sun Kim

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

[diff] [blame]

917

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

918

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

919

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

920

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

Bu Sun Kim

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

[diff] [blame]

921

{

Bu Sun Kim

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

[diff] [blame]

922

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

923

},

924

],

925

},

Bu Sun Kim

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

[diff] [blame]

926

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

927

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

928

#

929

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

930

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

931

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

932

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

933

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

934

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

935

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

936

{ # The named port. For example: .

937

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

938

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

939

},

940

],

941

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

942

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

943

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

944

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

945

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

946

},

947

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

948

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

949

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

950

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

951

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

952

"preservedState": { # Configuration of preserved resources.

953

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

954

"a_key": {

955

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

},

},

},

},

Bu Sun Kim

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

[diff] [blame]

960

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

961

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

962

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

963

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

964

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

965

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

966

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

967

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

968

},

Bu Sun Kim

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

[diff] [blame]

969

},

970

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

971

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

972

},

973

},

974

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

975

"A String",

976

],

977

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

978

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

979

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

980

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

981

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

982

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

983

#

984

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

985

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

986

#

987

#

988

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

989

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

990

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

991

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

992

},

993

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

994

#

995

#

996

# - The instance's status is RUNNING.

997

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

998

#

999

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

1000

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

1001

#

1002

#

1003

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

1004

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

1005

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

1006

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

1007

},

1008

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

1009

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

1010

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

1011

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

1012

},

1013

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

1014

#

1015

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

1016

{

1017

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

1018

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

1019

"tag": "A String", # Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged. Deprecated in favor of 'name'.

1020

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

1021

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

1022

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

1023

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

1024

#

1025

#

1026

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

1027

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

1028

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

1029

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

},

},

],

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

Bu Sun Kim

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

[diff] [blame]

1034

}

Sai Cheemalapati

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

[diff] [blame]

1035

Bu Sun Kim

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

[diff] [blame]

1036

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.

1037

1038

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.

1039

1040

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]

1041

1042

Returns:

1043

An object of the form:

1044

Bu Sun Kim

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

[diff] [blame]

1045

{ # Represents an Operation resource.

1046

#

Dan O'Meara

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

[diff] [blame]

1047

# Google Compute Engine has three Operation resources:

1048

#

1049

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

1050

#

Bu Sun Kim

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

[diff] [blame]

1051

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

1052

#

1053

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

1054

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

1055

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

1056

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

Bu Sun Kim

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

[diff] [blame]

1057

#

Dan O'Meara

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

[diff] [blame]

1058

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

1059

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

1060

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

1061

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

1062

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

1063

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

1064

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

Sai Cheemalapati

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

[diff] [blame]

1065

{

Bu Sun Kim

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

[diff] [blame]

1066

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

1067

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

1068

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

Sai Cheemalapati

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

[diff] [blame]

1069

},

1070

],

1071

},

Bu Sun Kim

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

[diff] [blame]

1072

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

1073

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

1074

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

1075

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

1076

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

1077

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

1078

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

1079

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

1080

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

1081

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

1082

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1083

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

1084

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

1085

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

1086

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

1087

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

1088

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

1089

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

1090

{

1091

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

1092

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

1093

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

1094

{

1095

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

1096

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

1097

},

1098

],

1099

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

1100

},

1101

],

1102

"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

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

[diff] [blame]

1107

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

1108

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

1109

1110

Args:

1111

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

1112

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

Dan O'Meara

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

[diff] [blame]

1113

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]

1114

Dan O'Meara

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

[diff] [blame]

1115

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]

1116

Dan O'Meara

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

[diff] [blame]

1117

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]

1118

Bu Sun Kim

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

[diff] [blame]

1119

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

1120

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

1121

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

1122

1123

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.

1124

1125

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

1126

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.

1127

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]

1128

1129

Returns:

1130

An object of the form:

1131

1132

{ # Contains a list of managed instance groups.

Bu Sun Kim

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

[diff] [blame]

1133

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

1134

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

Bu Sun Kim

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

[diff] [blame]

1135

{ # Represents a Managed Instance Group resource.

1136

#

1137

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

1138

#

1139

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

1140

#

Dan O'Meara

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

[diff] [blame]

1141

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

1142

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

1143

{

Bu Sun Kim

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

[diff] [blame]

1144

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

1145

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

1146

"maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when autohealing. When 'percent' is used, the value is rounded UP. The instance is considered available if all of the following conditions are satisfied: 1. Instance's status is RUNNING. 2. Instance's currentAction is NONE (in particular its liveness health check result was observed to be HEALTHY at least once as it passed VERIFYING). 3. There is no outgoing action on an instance triggered by IGM.

Bu Sun Kim

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

[diff] [blame]

1147

#

1148

# By default, number of concurrently autohealed instances is smaller than the managed instance group target size. However, if a zonal managed instance group has only one instance, or a regional managed instance group has only one instance per zone, autohealing will recreate these instances when they become unhealthy.

Bu Sun Kim

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

[diff] [blame]

1149

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

Bu Sun Kim

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

[diff] [blame]

1150

#

1151

#

1152

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

1153

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

Bu Sun Kim

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

[diff] [blame]

1154

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

1155

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

Bu Sun Kim

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

[diff] [blame]

1156

},

1157

},

1158

],

Bu Sun Kim

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

[diff] [blame]

1159

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

1160

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

1161

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

1162

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

1163

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

1164

#

1165

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

1166

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

1167

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

1168

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

1169

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

1170

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

1171

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

1172

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

1173

},

Bu Sun Kim

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

[diff] [blame]

1174

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

1175

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

1176

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

1177

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1178

{

Bu Sun Kim

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

[diff] [blame]

1179

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1180

},

1181

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1182

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1183

"failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.

1184

"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.

1185

#

1186

# To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.

1187

"id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.

1188

"instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.

1189

"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.

1190

"kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.

1191

"name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.

1192

"namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.

1193

{ # The named port. For example: .

1194

"name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.

1195

"port": 42, # The port number, which can be a value between 1 and 65535.

1196

},

1197

],

1198

"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.

1199

"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.

1200

"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.

1201

"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.

1202

"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.

1203

},

1204

"region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).

1205

"selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.

1206

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1207

"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.

1208

"statefulPolicy": { # Stateful configuration for this Instanced Group Manager

1209

"preservedState": { # Configuration of preserved resources.

1210

"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.

1211

"a_key": {

1212

"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]

1213

},

1214

},

1215

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1216

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1217

"status": { # [Output Only] The status of this managed instance group.

1218

"autoscaler": "A String", # [Output Only] The URL of the Autoscaler that targets this instance group manager.

1219

"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.

1220

"stateful": { # [Output Only] Stateful status of the given Instance Group Manager.

1221

"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.

1222

"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]

1223

"perInstanceConfigs": { # [Output Only] Status of per-instance configs on the instance.

1224

"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.

1225

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1226

},

1227

"versionTarget": { # [Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager.

1228

"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.

1229

},

1230

},

1231

"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.

1232

"A String",

1233

],

1234

"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.

1235

"updatePolicy": { # The update policy for this managed instance group.

1236

"instanceRedistributionType": "A String", # The instance redistribution policy for regional managed instance groups. Valid values are:

1237

# - PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region.

1238

# - NONE: For non-autoscaled groups, proactive redistribution is disabled.

1239

"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.

1240

#

1241

# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge.

1242

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

1243

#

1244

#

1245

# - If the value is fixed, then the calculated value is equal to the fixed value.

1246

# - 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.

1247

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

1248

"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

1249

},

1250

"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:

1251

#

1252

#

1253

# - The instance's status is RUNNING.

1254

# - 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.

1255

#

1256

# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable.

1257

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

1258

#

1259

#

1260

# - If the value is fixed, then the calculated value is equal to the fixed value.

1261

# - 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.

1262

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

1263

"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

1264

},

1265

"minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].

1266

"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.

1267

"replacementMethod": "A String", # What action should be used to replace instances. See minimal_action.REPLACE

1268

"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).

1269

},

1270

"versions": [ # Specifies the instance templates used by this managed instance group to create instances.

1271

#

1272

# 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.

1273

{

1274

"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.

1275

"name": "A String", # Name of the version. Unique among all versions in the scope of this managed instance group.

1276

"tag": "A String", # Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged. Deprecated in favor of 'name'.

1277

"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:

1278

# - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used.

1279

# - 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.

1280

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

1281

#

1282

#

1283

# - If the value is fixed, then the calculated value is equal to the fixed value.

1284

# - 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.

1285

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

1286

"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

},

},

],

"zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1291

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1292

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1293

"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.

1294

"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.

1295

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

1296

"warning": { # [Output Only] Informational warning message.

1297

"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.

1298

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1299

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1300

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1301

"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).

1302

"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]

1303

},

1304

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1305

"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]

1306

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1311

<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]

1312

<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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1313

1314

Args:

1315

project: string, Project ID for this request. (required)

1316

region: string, Name of the region scoping this request. This should conform to RFC1035. (required)

1317

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]

1318

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]

1319

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1320

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]

1321

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1322

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]

1323

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1324

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) ```

1325

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`)

1326

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

1327

1328

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.

1329

1330

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

1331

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.

1332

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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1333

1334

Returns:

1335

An object of the form:

1336

1337

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1338

"items": [ # [Output Only] The list of errors of the managed instance group.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1339

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1340

"error": { # [Output Only] Contents of the error.

1341

"code": "A String", # [Output Only] Error code.

1342

"message": "A String", # [Output Only] Error message.

1343

},

1344

"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.

1345

"action": "A String", # [Output Only] Action that managed instance group was executing on the instance when the error occurred. Possible values:

1346

"instance": "A String", # [Output Only] The URL of the instance. The URL can be set even if the instance has not yet been created.

1347

"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.

1348

"instanceTemplate": "A String", # [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }.

1349

"name": "A String", # [Output Only] Name of the version.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1350

},

1351

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1352

"timestamp": "A String", # [Output Only] The time that this error occurred. This value is in RFC3339 text format.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1353

},

1354

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1355

"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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="listErrors_next">listErrors_next(previous_request, previous_response)</code>

1361

<pre>Retrieves the next page of results.

1362

1363

Args:

1364

previous_request: The request for the previous page. (required)

1365

previous_response: The response from the request for the previous page. (required)

1366

1367

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1368

A request object that you can call 'execute()' on to request the next

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1369

page. Returns None if there are no more items in the collection.

</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1374

<code class="details" id="listManagedInstances">listManagedInstances(project, region, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>

1375

<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]

1376

1377

Args:

1378

project: string, Project ID for this request. (required)

1379

region: string, Name of the region scoping this request. (required)

1380

instanceGroupManager: string, The name of the managed instance group. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1381

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]

1382

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1383

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]

1384

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1385

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]

1386

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1387

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) ```

1388

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`)

1389

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

1390

1391

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.

1392

1393

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

1394

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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1395

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]

1396

1397

Returns:

1398

An object of the form:

1399

1400

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1401

"managedInstances": [ # A list of managed instances.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1402

{ # A Managed Instance resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1403

"currentAction": "A String", # [Output Only] The current action that the managed instance group has scheduled for the instance. Possible values:

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1404

# - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance.

1405

# - 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]

1406

# - 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

2016-10-21 13:59:49 -0700

[diff] [blame]

1407

# - RECREATING The managed instance group is recreating this instance.

1408

# - DELETING The managed instance group is permanently deleting this instance.

1409

# - 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.

1410

# - RESTARTING The managed instance group is restarting the instance.

1411

# - 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]

1412

# - 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]

1413

"id": "A String", # [Output only] The unique identifier for this resource. This field is empty when instance does not exist.

1414

"instance": "A String", # [Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created.

1415

"instanceHealth": [ # [Output Only] Health state of the instance per health-check.

1416

{

1417

"detailedHealthState": "A String", # [Output Only] The current detailed instance health state.

1418

"healthCheck": "A String", # [Output Only] The URL for the health check that verifies whether the instance is healthy.

1419

"healthState": "A String", # [Output Only] The current instance health state. This field will not get promoted to beta/GA and might be removed from alpha APIs after 01/12/2019. Please use detailed_health_state field instead.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1420

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1421

],

1422

"instanceStatus": "A String", # [Output Only] The status of the instance. This field is empty when the instance does not exist.

1423

"instanceTemplate": "A String", # [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }.

1424

"lastAttempt": { # [Output Only] Information about the last attempt to create or delete the instance.

1425

"errors": { # [Output Only] Encountered errors during the last attempt to create or delete the instance.

1426

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

1427

{

1428

"code": "A String", # [Output Only] The error type identifier for this error.

1429

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1430

"message": "A String", # [Output Only] An optional, human-readable error message.

1431

},

1432

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1433

},

1434

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1435

"preservedStateFromConfig": { # Preserved state for a given instance. # [Output Only] Preserved state applied from per-instance config for this instance.

1436

"disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks.

1437

"a_key": {

1438

"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.

1439

"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.

1440

"source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance.

1441

},

1442

},

1443

"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.

1448

"disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks.

1449

"a_key": {

1450

"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.

1451

"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.

1452

"source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance.

1453

},

1454

},

1455

"metadata": { # Preserved metadata defined for this instance.

"a_key": "A String",

},

},

"tag": "A String", # [Output Only] Tag describing the version.

1460

"version": { # [Output Only] Intended version of this instance.

1461

"instanceTemplate": "A String", # [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }.

1462

"name": "A String", # [Output Only] Name of the version.

1463

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1464

},

1465

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1466

"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-03-13 12:12:03 -0400

[diff] [blame]

1471

<code class="details" id="listManagedInstances_next">listManagedInstances_next(previous_request, previous_response)</code>

1472

<pre>Retrieves the next page of results.

1473

1474

Args:

1475

previous_request: The request for the previous page. (required)

1476

previous_response: The response from the request for the previous page. (required)

1477

1478

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1479

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1480

page. Returns None if there are no more items in the collection.

</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1485

<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]

1486

<pre>Lists all of the per-instance configs defined for the managed instance group. The orderBy query parameter is not supported.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1487

1488

Args:

1489

project: string, Project ID for this request. (required)

1490

region: string, Name of the region scoping this request, should conform to RFC1035. (required)

1491

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]

1492

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]

1493

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1494

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]

1495

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1496

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]

1497

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1498

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) ```

1499

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`)

1500

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

1501

1502

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.

1503

1504

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

1505

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.

1506

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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1507

1508

Returns:

1509

An object of the form:

1510

1511

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1512

"items": [ # [Output Only] The list of PerInstanceConfig.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1513

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1514

"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.

1515

"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.

1516

"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.

1517

"disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks.

1518

"a_key": {

1519

"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.

1520

"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.

1521

"source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1522

},

1523

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1524

"metadata": { # Preserved metadata defined for this instance.

1525

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1526

},

1527

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1528

"status": "A String", # The status of applying this per-instance config on the corresponding managed instance.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1529

},

1530

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1531

"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.

1532

"warning": { # [Output Only] Informational warning message.

1533

"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.

1534

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1535

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1536

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1537

"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).

1538

"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]

1539

},

1540

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1541

"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]

},

}</pre>

</div>

<code class="details" id="listPerInstanceConfigs_next">listPerInstanceConfigs_next(previous_request, previous_response)</code>

1548

<pre>Retrieves the next page of results.

1549

1550

Args:

1551

previous_request: The request for the previous page. (required)

1552

previous_response: The response from the request for the previous page. (required)

1553

1554

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1555

A request object that you can call 'execute()' on to request the next

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1556

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]

1561

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

1562

<pre>Retrieves the next page of results.

1563

1564

Args:

1565

previous_request: The request for the previous page. (required)

1566

previous_response: The response from the request for the previous page. (required)

1567

1568

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1569

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1570

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]

1575

<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]

1576

<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]

1577

1578

Args:

1579

project: string, Project ID for this request. (required)

1580

region: string, Name of the region scoping this request. (required)

1581

instanceGroupManager: string, The name of the instance group manager. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1582

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1583

The object takes the form of:

1584

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1585

{ # Represents a Managed Instance Group resource.

1586

#

1587

# An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups.

1588

#

1589

# For zonal Managed Instance Group, use the instanceGroupManagers resource.

1590

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1591

# 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]

1592

"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]

1593

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1594

"healthCheck": "A String", # The URL for the health check that signals autohealing.

1595

"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].

1596

"maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when autohealing. When 'percent' is used, the value is rounded UP. The instance is considered available if all of the following conditions are satisfied: 1. Instance's status is RUNNING. 2. Instance's currentAction is NONE (in particular its liveness health check result was observed to be HEALTHY at least once as it passed VERIFYING). 3. There is no outgoing action on an instance triggered by IGM.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1597

#

1598

# By default, number of concurrently autohealed instances is smaller than the managed instance group target size. However, if a zonal managed instance group has only one instance, or a regional managed instance group has only one instance per zone, autohealing will recreate these instances when they become unhealthy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1599

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1600

#

1601

#

1602

# - If the value is fixed, then the calculated value is equal to the fixed value.

1603

# - 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1604

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

1605

"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1606

},

1607

},

1608

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1609

"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.

1610

"creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.

1611

"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.

1612

"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.

1613

"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]

1614

#

1615

# 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]

1616

"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.

1617

"deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.

1618

"none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.

1619

"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.

1620

"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.

1621

"restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.

1622

"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]

1623

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1624

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

1625

"distributionPolicy": { # Policy specifying intended distribution of instances in regional managed instance group.

1626

"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.

1627

"zones": [ # Zones where the regional managed instance group will create and manage instances.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1628

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1629

"zone": "A String", # The URL of the zone. The zone must exist in the region where the managed instance group is located.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1630

},

1631

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1632

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1633

"failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.

1634

"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.

1635

#

1636

# To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.

1637

"id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.

1638

"instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.

1639

"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.

1640

"kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.

1641

"name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.

1642

"namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.

1643

{ # The named port. For example: .

1644

"name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.

1645

"port": 42, # The port number, which can be a value between 1 and 65535.

1646

},

1647

],

1648

"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.

1649

"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.

1650

"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.

1651

"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.

1652

"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.

1653

},

1654

"region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).

1655

"selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.

1656

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1657

"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.

1658

"statefulPolicy": { # Stateful configuration for this Instanced Group Manager

1659

"preservedState": { # Configuration of preserved resources.

1660

"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.

1661

"a_key": {

1662

"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]

},

},

},

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1667

"status": { # [Output Only] The status of this managed instance group.

1668

"autoscaler": "A String", # [Output Only] The URL of the Autoscaler that targets this instance group manager.

1669

"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.

1670

"stateful": { # [Output Only] Stateful status of the given Instance Group Manager.

1671

"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.

1672

"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]

1673

"perInstanceConfigs": { # [Output Only] Status of per-instance configs on the instance.

1674

"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.

1675

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1676

},

1677

"versionTarget": { # [Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager.

1678

"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.

1679

},

1680

},

1681

"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.

1682

"A String",

1683

],

1684

"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.

1685

"updatePolicy": { # The update policy for this managed instance group.

1686

"instanceRedistributionType": "A String", # The instance redistribution policy for regional managed instance groups. Valid values are:

1687

# - PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region.

1688

# - NONE: For non-autoscaled groups, proactive redistribution is disabled.

1689

"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.

1690

#

1691

# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge.

1692

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

1693

#

1694

#

1695

# - If the value is fixed, then the calculated value is equal to the fixed value.

1696

# - 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.

1697

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

1698

"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

1699

},

1700

"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:

1701

#

1702

#

1703

# - The instance's status is RUNNING.

1704

# - 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.

1705

#

1706

# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable.

1707

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

1708

#

1709

#

1710

# - If the value is fixed, then the calculated value is equal to the fixed value.

1711

# - 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.

1712

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

1713

"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

1714

},

1715

"minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].

1716

"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.

1717

"replacementMethod": "A String", # What action should be used to replace instances. See minimal_action.REPLACE

1718

"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).

1719

},

1720

"versions": [ # Specifies the instance templates used by this managed instance group to create instances.

1721

#

1722

# 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.

1723

{

1724

"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.

1725

"name": "A String", # Name of the version. Unique among all versions in the scope of this managed instance group.

1726

"tag": "A String", # Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged. Deprecated in favor of 'name'.

1727

"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:

1728

# - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used.

1729

# - 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.

1730

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

1731

#

1732

#

1733

# - If the value is fixed, then the calculated value is equal to the fixed value.

1734

# - 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.

1735

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

1736

"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

},

},

],

"zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1741

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1742

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1743

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.

1744

1745

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.

1746

1747

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]

1748

1749

Returns:

1750

An object of the form:

1751

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1752

{ # Represents an Operation resource.

1753

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1754

# Google Compute Engine has three Operation resources:

1755

#

1756

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

1757

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1758

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

1759

#

1760

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1761

# - For global operations, use the `globalOperations` resource.

1762

# - For regional operations, use the `regionOperations` resource.

1763

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1764

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1765

# 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]

1766

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1767

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1768

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1769

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1770

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1771

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1772

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1773

"code": "A String", # [Output Only] The error type identifier for this error.

1774

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1775

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1776

},

1777

],

1778

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1779

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1780

"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.

1781

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

1782

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1783

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1784

"name": "A String", # [Output Only] Name of the operation.

1785

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1786

"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.

1787

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

1788

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1789

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1790

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1791

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

1792

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1793

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1794

"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.

1795

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1796

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1797

{

1798

"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.

1799

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1800

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

1801

{

1802

"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).

1803

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1804

},

1805

],

1806

"message": "A String", # [Output Only] A human-readable description of the warning code.

1807

},

1808

],

1809

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1814

<code class="details" id="patchPerInstanceConfigs">patchPerInstanceConfigs(project, region, instanceGroupManager, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1815

<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.

1816

1817

Args:

1818

project: string, Project ID for this request. (required)

1819

region: string, Name of the region scoping this request, should conform to RFC1035. (required)

1820

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]

1821

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1822

The object takes the form of:

1823

1824

{ # RegionInstanceGroupManagers.patchPerInstanceConfigs

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1825

"perInstanceConfigs": [ # The list of per-instance configs to insert or patch on this managed instance group.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1826

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1827

"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.

1828

"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.

1829

"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.

1830

"disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks.

1831

"a_key": {

1832

"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.

1833

"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.

1834

"source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1835

},

1836

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1837

"metadata": { # Preserved metadata defined for this instance.

1838

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1839

},

1840

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1841

"status": "A String", # The status of applying this per-instance config on the corresponding managed instance.

Bu Sun Kim

2019-06-14 16:50:42 -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.

1847

1848

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.

1849

1850

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

1851

1852

Returns:

1853

An object of the form:

1854

1855

{ # Represents an Operation resource.

1856

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1857

# Google Compute Engine has three Operation resources:

1858

#

1859

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

1860

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1861

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

1862

#

1863

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1864

# - For global operations, use the `globalOperations` resource.

1865

# - For regional operations, use the `regionOperations` resource.

1866

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1867

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1868

# 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]

1869

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1870

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1871

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1872

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1873

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1874

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1875

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1876

"code": "A String", # [Output Only] The error type identifier for this error.

1877

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1878

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1879

},

1880

],

1881

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1882

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1883

"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.

1884

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

1885

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1886

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1887

"name": "A String", # [Output Only] Name of the operation.

1888

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1889

"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.

1890

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

1891

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1892

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1893

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1894

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

1895

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1896

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1897

"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.

1898

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1899

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1900

{

1901

"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.

1902

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1903

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

1904

{

1905

"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).

1906

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1907

},

1908

],

1909

"message": "A String", # [Output Only] A human-readable description of the warning code.

1910

},

1911

],

1912

"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]

1917

<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]

1918

<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]

1919

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1920

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.

1921

1922

You can specify a maximum of 1000 instances with this method per request.

1923

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1924

Args:

1925

project: string, Project ID for this request. (required)

1926

region: string, Name of the region scoping this request. (required)

1927

instanceGroupManager: string, Name of the managed instance group. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1928

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1929

The object takes the form of:

1930

1931

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1932

"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].

1933

"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]

1937

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.

1938

1939

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.

1940

1941

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]

1942

1943

Returns:

1944

An object of the form:

1945

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1946

{ # Represents an Operation resource.

1947

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1948

# Google Compute Engine has three Operation resources:

1949

#

1950

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

1951

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1952

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

1953

#

1954

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1955

# - For global operations, use the `globalOperations` resource.

1956

# - For regional operations, use the `regionOperations` resource.

1957

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1958

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1959

# 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]

1960

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1961

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1962

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1963

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1964

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1965

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1966

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1967

"code": "A String", # [Output Only] The error type identifier for this error.

1968

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1969

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1970

},

1971

],

1972

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1973

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1974

"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.

1975

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

1976

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1977

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1978

"name": "A String", # [Output Only] Name of the operation.

1979

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1980

"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.

1981

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

1982

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1983

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1984

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1985

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

1986

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1987

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1988

"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.

1989

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1990

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1991

{

1992

"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.

1993

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1994

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

1995

{

1996

"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).

1997

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1998

},

1999

],

2000

"message": "A String", # [Output Only] A human-readable description of the warning code.

2001

},

2002

],

2003

"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>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

2008

<code class="details" id="resize">resize(project, region, instanceGroupManager, size, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2009

<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.

2010

2011

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]

2012

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2013

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.

2014

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2015

Args:

2016

project: string, Project ID for this request. (required)

2017

region: string, Name of the region scoping this request. (required)

2018

instanceGroupManager: string, Name of the managed instance group. (required)

2019

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]

2020

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.

2021

2022

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.

2023

2024

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]

2025

2026

Returns:

2027

An object of the form:

2028

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2029

{ # Represents an Operation resource.

2030

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2031

# Google Compute Engine has three Operation resources:

2032

#

2033

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2034

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2035

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2036

#

2037

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2038

# - For global operations, use the `globalOperations` resource.

2039

# - For regional operations, use the `regionOperations` resource.

2040

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2041

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2042

# 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]

2043

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2044

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2045

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2046

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2047

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2048

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2049

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2050

"code": "A String", # [Output Only] The error type identifier for this error.

2051

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2052

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2053

},

2054

],

2055

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2056

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2057

"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.

2058

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2059

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2060

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2061

"name": "A String", # [Output Only] Name of the operation.

2062

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2063

"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.

2064

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2065

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2066

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2067

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2068

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2069

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2070

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2071

"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.

2072

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2073

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2074

{

2075

"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.

2076

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2077

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2078

{

2079

"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).

2080

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2081

},

2082

],

2083

"message": "A String", # [Output Only] A human-readable description of the warning code.

2084

},

2085

],

2086

"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]

2091

<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]

2092

<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]

2093

2094

Args:

2095

project: string, Project ID for this request. (required)

2096

region: string, Name of the region scoping this request. (required)

2097

instanceGroupManager: string, Name of the managed instance group. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2098

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2099

The object takes the form of:

2100

2101

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2102

"autoHealingPolicies": [

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2103

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2104

"healthCheck": "A String", # The URL for the health check that signals autohealing.

2105

"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].

2106

"maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when autohealing. When 'percent' is used, the value is rounded UP. The instance is considered available if all of the following conditions are satisfied: 1. Instance's status is RUNNING. 2. Instance's currentAction is NONE (in particular its liveness health check result was observed to be HEALTHY at least once as it passed VERIFYING). 3. There is no outgoing action on an instance triggered by IGM.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2107

#

2108

# By default, number of concurrently autohealed instances is smaller than the managed instance group target size. However, if a zonal managed instance group has only one instance, or a regional managed instance group has only one instance per zone, autohealing will recreate these instances when they become unhealthy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2109

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2110

#

2111

#

2112

# - If the value is fixed, then the calculated value is equal to the fixed value.

2113

# - 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2114

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

2115

"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

},

},

],

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2121

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.

2122

2123

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.

2124

2125

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]

2126

2127

Returns:

2128

An object of the form:

2129

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2130

{ # Represents an Operation resource.

2131

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2132

# Google Compute Engine has three Operation resources:

2133

#

2134

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2135

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2136

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2137

#

2138

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2139

# - For global operations, use the `globalOperations` resource.

2140

# - For regional operations, use the `regionOperations` resource.

2141

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2142

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2143

# 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]

2144

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2145

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2146

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2147

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2148

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2149

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2150

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2151

"code": "A String", # [Output Only] The error type identifier for this error.

2152

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2153

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2154

},

2155

],

2156

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2157

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2158

"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.

2159

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2160

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2161

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2162

"name": "A String", # [Output Only] Name of the operation.

2163

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2164

"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.

2165

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2166

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2167

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2168

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2169

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2170

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2171

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2172

"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.

2173

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2174

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2175

{

2176

"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.

2177

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2178

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2179

{

2180

"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).

2181

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2182

},

2183

],

2184

"message": "A String", # [Output Only] A human-readable description of the warning code.

2185

},

2186

],

2187

"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]

2192

<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]

2193

<pre>Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected.

2194

2195

Args:

2196

project: string, Project ID for this request. (required)

2197

region: string, Name of the region scoping this request. (required)

2198

instanceGroupManager: string, The name of the managed instance group. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2199

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2200

The object takes the form of:

2201

2202

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2203

"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]

2204

}

2205

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2206

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.

2207

2208

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.

2209

2210

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]

2211

2212

Returns:

2213

An object of the form:

2214

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2215

{ # Represents an Operation resource.

2216

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2217

# Google Compute Engine has three Operation resources:

2218

#

2219

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2220

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2221

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2222

#

2223

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2224

# - For global operations, use the `globalOperations` resource.

2225

# - For regional operations, use the `regionOperations` resource.

2226

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2227

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2228

# 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]

2229

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2230

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2231

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2232

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2233

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2234

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2235

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2236

"code": "A String", # [Output Only] The error type identifier for this error.

2237

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2238

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2239

},

2240

],

2241

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2242

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2243

"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.

2244

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2245

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2246

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2247

"name": "A String", # [Output Only] Name of the operation.

2248

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2249

"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.

2250

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2251

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2252

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2253

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2254

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2255

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2256

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2257

"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.

2258

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2259

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2260

{

2261

"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.

2262

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2263

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2264

{

2265

"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).

2266

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2267

},

2268

],

2269

"message": "A String", # [Output Only] A human-readable description of the warning code.

2270

},

2271

],

2272

"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]

2277

<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]

2278

<pre>Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.

2279

2280

Args:

2281

project: string, Project ID for this request. (required)

2282

region: string, Name of the region scoping this request. (required)

2283

instanceGroupManager: string, Name of the managed instance group. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2284

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2285

The object takes the form of:

2286

2287

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2288

"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.

2289

"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.

2290

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2291

],

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2292

}

2293

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2294

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.

2295

2296

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.

2297

2298

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]

2299

2300

Returns:

2301

An object of the form:

2302

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2303

{ # Represents an Operation resource.

2304

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2305

# Google Compute Engine has three Operation resources:

2306

#

2307

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2308

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2309

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2310

#

2311

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2312

# - For global operations, use the `globalOperations` resource.

2313

# - For regional operations, use the `regionOperations` resource.

2314

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2315

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2316

# 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]

2317

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2318

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2319

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2320

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2321

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2322

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2323

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2324

"code": "A String", # [Output Only] The error type identifier for this error.

2325

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2326

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2327

},

2328

],

2329

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2330

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2331

"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.

2332

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2333

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2334

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2335

"name": "A String", # [Output Only] Name of the operation.

2336

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2337

"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.

2338

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2339

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2340

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2341

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2342

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2343

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2344

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2345

"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.

2346

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2347

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2348

{

2349

"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.

2350

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2351

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2352

{

2353

"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).

2354

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2355

},

2356

],

2357

"message": "A String", # [Output Only] A human-readable description of the warning code.

2358

},

2359

],

2360

"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]

2365

<code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2366

<pre>Returns permissions that a caller has on the specified resource.

2367

2368

Args:

2369

project: string, Project ID for this request. (required)

2370

region: string, The name of the region for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2371

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2372

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2373

The object takes the form of:

2374

2375

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2376

"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.

2377

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

],

}

Returns:

An object of the form:

2384

2385

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2386

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.

2387

"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]

2393

<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]

2394

<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.

2395

2396

Args:

2397

project: string, Project ID for this request. (required)

2398

region: string, Name of the region scoping this request. (required)

2399

instanceGroupManager: string, The name of the instance group manager. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2400

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2401

The object takes the form of:

2402

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2403

{ # Represents a Managed Instance Group resource.

2404

#

2405

# An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups.

2406

#

2407

# For zonal Managed Instance Group, use the instanceGroupManagers resource.

2408

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2409

# 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]

2410

"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]

2411

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2412

"healthCheck": "A String", # The URL for the health check that signals autohealing.

2413

"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].

2414

"maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when autohealing. When 'percent' is used, the value is rounded UP. The instance is considered available if all of the following conditions are satisfied: 1. Instance's status is RUNNING. 2. Instance's currentAction is NONE (in particular its liveness health check result was observed to be HEALTHY at least once as it passed VERIFYING). 3. There is no outgoing action on an instance triggered by IGM.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2415

#

2416

# By default, number of concurrently autohealed instances is smaller than the managed instance group target size. However, if a zonal managed instance group has only one instance, or a regional managed instance group has only one instance per zone, autohealing will recreate these instances when they become unhealthy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2417

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2418

#

2419

#

2420

# - If the value is fixed, then the calculated value is equal to the fixed value.

2421

# - 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2422

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

2423

"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2424

},

2425

},

2426

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2427

"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.

2428

"creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.

2429

"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.

2430

"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.

2431

"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]

2432

#

2433

# 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]

2434

"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.

2435

"deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.

2436

"none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.

2437

"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.

2438

"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.

2439

"restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.

2440

"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]

2441

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2442

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2443

"distributionPolicy": { # Policy specifying intended distribution of instances in regional managed instance group.

2444

"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.

2445

"zones": [ # Zones where the regional managed instance group will create and manage instances.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2446

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2447

"zone": "A String", # The URL of the zone. The zone must exist in the region where the managed instance group is located.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2448

},

2449

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2450

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2451

"failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.

2452

"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.

2453

#

2454

# To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.

2455

"id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.

2456

"instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.

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 all new instances in the managed instance group.

2458

"kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.

2459

"name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.

2460

"namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.

2461

{ # The named port. For example: .

2462

"name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.

2463

"port": 42, # The port number, which can be a value between 1 and 65535.

2464

},

2465

],

2466

"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.

2467

"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.

2468

"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.

2469

"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.

2470

"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.

2471

},

2472

"region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).

2473

"selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.

2474

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2475

"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.

2476

"statefulPolicy": { # Stateful configuration for this Instanced Group Manager

2477

"preservedState": { # Configuration of preserved resources.

2478

"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.

2479

"a_key": {

2480

"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]

},

},

},

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2485

"status": { # [Output Only] The status of this managed instance group.

2486

"autoscaler": "A String", # [Output Only] The URL of the Autoscaler that targets this instance group manager.

2487

"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.

2488

"stateful": { # [Output Only] Stateful status of the given Instance Group Manager.

2489

"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.

2490

"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]

2491

"perInstanceConfigs": { # [Output Only] Status of per-instance configs on the instance.

2492

"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.

2493

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2494

},

2495

"versionTarget": { # [Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager.

2496

"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.

2497

},

2498

},

2499

"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.

2500

"A String",

2501

],

2502

"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.

2503

"updatePolicy": { # The update policy for this managed instance group.

2504

"instanceRedistributionType": "A String", # The instance redistribution policy for regional managed instance groups. Valid values are:

2505

# - PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region.

2506

# - NONE: For non-autoscaled groups, proactive redistribution is disabled.

2507

"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.

2508

#

2509

# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge.

2510

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

2511

#

2512

#

2513

# - If the value is fixed, then the calculated value is equal to the fixed value.

2514

# - 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.

2515

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

2516

"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

2517

},

2518

"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:

2519

#

2520

#

2521

# - The instance's status is RUNNING.

2522

# - 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.

2523

#

2524

# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable.

2525

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

2526

#

2527

#

2528

# - If the value is fixed, then the calculated value is equal to the fixed value.

2529

# - 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.

2530

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

2531

"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

2532

},

2533

"minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].

2534

"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.

2535

"replacementMethod": "A String", # What action should be used to replace instances. See minimal_action.REPLACE

2536

"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).

2537

},

2538

"versions": [ # Specifies the instance templates used by this managed instance group to create instances.

2539

#

2540

# 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.

2541

{

2542

"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.

2543

"name": "A String", # Name of the version. Unique among all versions in the scope of this managed instance group.

2544

"tag": "A String", # Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged. Deprecated in favor of 'name'.

2545

"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:

2546

# - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used.

2547

# - 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.

2548

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

2549

#

2550

#

2551

# - If the value is fixed, then the calculated value is equal to the fixed value.

2552

# - 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.

2553

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

2554

"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

},

},

],

"zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2559

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2560

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2561

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.

2562

2563

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.

2564

2565

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]

2566

2567

Returns:

2568

An object of the form:

2569

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2570

{ # Represents an Operation resource.

2571

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2572

# Google Compute Engine has three Operation resources:

2573

#

2574

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2575

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2576

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2577

#

2578

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2579

# - For global operations, use the `globalOperations` resource.

2580

# - For regional operations, use the `regionOperations` resource.

2581

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2582

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2583

# 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]

2584

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2585

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2586

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2587

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2588

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2589

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2590

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2591

"code": "A String", # [Output Only] The error type identifier for this error.

2592

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2593

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2594

},

2595

],

2596

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2597

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2598

"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.

2599

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2600

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2601

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2602

"name": "A String", # [Output Only] Name of the operation.

2603

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2604

"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.

2605

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2606

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2607

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2608

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2609

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2610

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2611

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2612

"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.

2613

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2614

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2615

{

2616

"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.

2617

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2618

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2619

{

2620

"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).

2621

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2622

},

2623

],

2624

"message": "A String", # [Output Only] A human-readable description of the warning code.

2625

},

2626

],

2627

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2632

<code class="details" id="updatePerInstanceConfigs">updatePerInstanceConfigs(project, region, instanceGroupManager, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2633

<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.

2634

2635

Args:

2636

project: string, Project ID for this request. (required)

2637

region: string, Name of the region scoping this request, should conform to RFC1035. (required)

2638

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]

2639

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2640

The object takes the form of:

2641

2642

{ # RegionInstanceGroupManagers.updatePerInstanceConfigs

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2643

"perInstanceConfigs": [ # The list of per-instance configs to insert or patch on this managed instance group.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2644

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2645

"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.

2646

"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.

2647

"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.

2648

"disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks.

2649

"a_key": {

2650

"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.

2651

"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.

2652

"source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2653

},

2654

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2655

"metadata": { # Preserved metadata defined for this instance.

2656

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2657

},

2658

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2659

"status": "A String", # The status of applying this per-instance config on the corresponding managed instance.

Bu Sun Kim

2019-06-14 16:50:42 -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.

2665

2666

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.

2667

2668

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

2669

2670

Returns:

2671

An object of the form:

2672

2673

{ # Represents an Operation resource.

2674

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2675

# Google Compute Engine has three Operation resources:

2676

#

2677

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2678

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2679

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2680

#

2681

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2682

# - For global operations, use the `globalOperations` resource.

2683

# - For regional operations, use the `regionOperations` resource.

2684

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2685

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2686

# 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]

2687

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2688

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2689

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2690

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2691

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2692

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2693

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2694

"code": "A String", # [Output Only] The error type identifier for this error.

2695

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2696

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2697

},

2698

],

2699

},

Bu Sun Kim