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

Dmitry Frenkel

3e17f89

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

[diff] [blame]

84

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

85

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

86

Dan O'Meara

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

[diff] [blame]

87

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

Bu Sun Kim

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

[diff] [blame]

88

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

Sai Cheemalapati

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

[diff] [blame]

89

Sai Cheemalapati

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

[diff] [blame]

90

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

Sai Cheemalapati

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

[diff] [blame]

91

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

92

Dan O'Meara

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

[diff] [blame]

93

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

Bu Sun Kim

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

[diff] [blame]

94

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

95

Dan O'Meara

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

[diff] [blame]

96

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

Bu Sun Kim

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

[diff] [blame]

97

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

98

99

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

100

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

101

Dan O'Meara

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

[diff] [blame]

102

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

Bu Sun Kim

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

[diff] [blame]

103

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

Sai Cheemalapati

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

[diff] [blame]

104

Bu Sun Kim

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

[diff] [blame]

105

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

Sai Cheemalapati

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

[diff] [blame]

106

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

107

Bu Sun Kim

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

[diff] [blame]

108

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

Bu Sun Kim

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

[diff] [blame]

109

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

Bu Sun Kim

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

[diff] [blame]

110

111

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

112

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

113

Bu Sun Kim

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

[diff] [blame]

114

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

115

<p class="firstline">Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. The orderBy query parameter is not supported.</p>

Sai Cheemalapati

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

[diff] [blame]

116

Sai Cheemalapati

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

[diff] [blame]

117

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

118

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

119

Bu Sun Kim

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

[diff] [blame]

120

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

Bu Sun Kim

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

[diff] [blame]

121

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

Bu Sun Kim

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

[diff] [blame]

122

123

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

124

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

125

Sai Cheemalapati

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

[diff] [blame]

126

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

127

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

128

Dan O'Meara

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

[diff] [blame]

129

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

Bu Sun Kim

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

[diff] [blame]

130

<p class="firstline">Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.</p>

131

Dan O'Meara

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

[diff] [blame]

132

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

133

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

Sai Cheemalapati

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

[diff] [blame]

134

Dan O'Meara

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

[diff] [blame]

135

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

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

136

<p class="firstline">Flags the specified VM instances in the managed instance group to be immediately recreated. Each instance is recreated using the group's current configuration. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of each instance by checking its currentAction field; for more information, see Checking the status of managed instances.</p>

Sai Cheemalapati

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

[diff] [blame]

137

Sai Cheemalapati

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

[diff] [blame]

138

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

139

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

Sai Cheemalapati

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

[diff] [blame]

140

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

141

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

142

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

143

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

144

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

145

<p class="firstline">Flags the specified instances in the managed instance group to be resumed. This method increases the targetSize and decreases the targetSuspendedSize of the managed instance group by the number of instances that you resume. The resumeInstances operation is marked DONE if the resumeInstances request is successful. The underlying actions take additional time. You must separately verify the status of the RESUMING action with the listmanagedinstances method.</p>

146

Dan O'Meara

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

[diff] [blame]

147

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

148

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

Sai Cheemalapati

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

[diff] [blame]

149

Dan O'Meara

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

[diff] [blame]

150

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

151

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

152

Dan O'Meara

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

[diff] [blame]

153

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

154

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

155

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

156

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

157

<p class="firstline">Flags the specified instances in the managed instance group to be started. This method increases the targetSize and decreases the targetStoppedSize of the managed instance group by the number of instances that you start. The startInstances operation is marked DONE if the startInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STARTING action with the listmanagedinstances method.</p>

158

159

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

160

<p class="firstline">Flags the specified instances in the managed instance group to be immediately stopped. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetStoppedSize of the managed instance group by the number of instances that you stop. The stopInstances operation is marked DONE if the stopInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STOPPING action with the listmanagedinstances method.</p>

161

162

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

163

<p class="firstline">Flags the specified instances in the managed instance group to be immediately suspended. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetSuspendedSize of the managed instance group by the number of instances that you suspend. The suspendInstances operation is marked DONE if the suspendInstances request is successful. The underlying actions take additional time. You must separately verify the status of the SUSPENDING action with the listmanagedinstances method.</p>

164

Dan O'Meara

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

[diff] [blame]

165

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

Sai Cheemalapati

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

[diff] [blame]

166

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

167

Dan O'Meara

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

[diff] [blame]

168

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

169

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

170

Dan O'Meara

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

[diff] [blame]

171

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

172

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

Sai Cheemalapati

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

[diff] [blame]

173

<h3>Method Details</h3>

174

Dan O'Meara

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

[diff] [blame]

175

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

176

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

177

Sai Cheemalapati

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

[diff] [blame]

178

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.

179

180

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

181

Sai Cheemalapati

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

[diff] [blame]

182

Args:

183

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

184

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

185

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

Dan O'Meara

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

[diff] [blame]

186

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

187

The object takes the form of:

188

189

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

190

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

191

"A String",

192

],

193

}

Sai Cheemalapati

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

[diff] [blame]

194

Bu Sun Kim

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

[diff] [blame]

195

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.

196

197

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.

198

199

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]

200

201

Returns:

202

An object of the form:

203

Bu Sun Kim

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

[diff] [blame]

204

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

205

#

206

# Google Compute Engine has three Operation resources:

207

#

208

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

209

#

210

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

211

#

212

# Operations can be global, regional or zonal.

213

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

214

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

215

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

216

#

217

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

218

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

219

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

220

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

221

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

222

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

223

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

Bu Sun Kim

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

[diff] [blame]

224

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

225

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

226

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

227

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

Bu Sun Kim

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

[diff] [blame]

228

},

229

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

230

},

231

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

232

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

233

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

234

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

235

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

236

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

237

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

238

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

239

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

240

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

241

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

242

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

243

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

244

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

245

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

246

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

247

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

248

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

249

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

250

{

251

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

252

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

253

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

254

{

255

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

256

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

257

},

258

],

259

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

260

},

261

],

262

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

263

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

267

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

Bu Sun Kim

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

[diff] [blame]

268

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

269

270

Args:

271

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

272

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

273

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]

274

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

275

The object takes the form of:

276

Dmitry Frenkel

3e17f89

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

[diff] [blame]

277

{ # RegionInstanceGroupManagers.applyUpdatesToInstances

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

278

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

279

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

280

"A String",

281

],

282

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

283

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

284

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

285

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

286

# - REFRESH: Do not stop the instance.

287

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

288

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

289

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

290

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

291

# - REFRESH: Do not stop the instance.

292

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

293

}

Bu Sun Kim

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

[diff] [blame]

Returns:

An object of the form:

298

299

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

300

#

301

# Google Compute Engine has three Operation resources:

302

#

303

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

304

#

305

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

306

#

307

# Operations can be global, regional or zonal.

308

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

309

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

310

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

311

#

312

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

313

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

314

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

315

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

316

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

317

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

318

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

Bu Sun Kim

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

[diff] [blame]

319

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

320

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

321

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

322

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

Bu Sun Kim

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

[diff] [blame]

323

},

324

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

325

},

326

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

327

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

328

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

329

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

330

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

331

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

332

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

333

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

334

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

335

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

336

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

337

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

338

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

339

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

340

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

341

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

342

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

343

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

344

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

345

{

346

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

347

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

348

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

349

{

350

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

351

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

352

},

353

],

354

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

355

},

356

],

357

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

358

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Dmitry Frenkel

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

[diff] [blame]

362

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

363

<pre>Close httplib2 connections.</pre>

</div>

Dan O'Meara

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

[diff] [blame]

367

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

368

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

369

370

Args:

371

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

372

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

373

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]

374

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

375

The object takes the form of:

376

377

{ # RegionInstanceGroupManagers.createInstances

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

378

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

379

{

380

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

381

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

382

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

383

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

384

"a_key": {

385

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

386

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

387

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

388

},

389

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

390

"externalIPs": { # Preserved external IPs defined for this instance. This map is keyed with the name of the network interface.

391

"a_key": {

392

"autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted.

393

"ipAddress": { # Ip address representation

394

"address": "A String", # The URL of the reservation for this IP address.

395

"literal": "A String", # An IPv4 internal network address to assign to the instance for this network interface.

},

},

},

"internalIPs": { # Preserved internal IPs defined for this instance. This map is keyed with the name of the network interface.

400

"a_key": {

401

"autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted.

402

"ipAddress": { # Ip address representation

403

"address": "A String", # The URL of the reservation for this IP address.

404

"literal": "A String", # An IPv4 internal network address to assign to the instance for this network interface.

405

},

406

},

407

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

408

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

409

"a_key": "A String",

410

},

Bu Sun Kim

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

[diff] [blame]

411

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

412

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

413

},

414

],

415

}

Bu Sun Kim

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

[diff] [blame]

416

417

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.

418

419

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.

420

421

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

422

423

Returns:

424

An object of the form:

425

426

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

427

#

428

# Google Compute Engine has three Operation resources:

429

#

430

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

431

#

432

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

433

#

434

# Operations can be global, regional or zonal.

435

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

436

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

437

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

438

#

439

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

440

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

441

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

442

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

443

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

444

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

445

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

Bu Sun Kim

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

[diff] [blame]

446

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

447

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

448

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

449

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

Bu Sun Kim

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

[diff] [blame]

450

},

451

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

452

},

453

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

454

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

455

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

456

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

457

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

458

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

459

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

460

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

461

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

462

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

463

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

464

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

465

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

466

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

467

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

468

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

469

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

470

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

471

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

472

{

473

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

474

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

475

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

476

{

477

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

478

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

479

},

480

],

481

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

482

},

483

],

484

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

485

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Sai Cheemalapati

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

[diff] [blame]

489

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

Sai Cheemalapati

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

[diff] [blame]

490

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

491

492

Args:

493

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

494

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

495

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

Bu Sun Kim

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

[diff] [blame]

496

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.

497

498

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.

499

500

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]

501

502

Returns:

503

An object of the form:

504

Bu Sun Kim

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

[diff] [blame]

505

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

506

#

507

# Google Compute Engine has three Operation resources:

508

#

509

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

510

#

511

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

512

#

513

# Operations can be global, regional or zonal.

514

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

515

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

516

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

517

#

518

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

519

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

520

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

521

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

522

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

523

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

524

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

Bu Sun Kim

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

[diff] [blame]

525

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

526

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

527

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

528

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

Bu Sun Kim

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

[diff] [blame]

529

},

530

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

531

},

532

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

533

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

534

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

535

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

536

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

537

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

538

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

539

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

540

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

541

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

542

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

543

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

544

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

545

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

546

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

547

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

548

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

549

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

550

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

551

{

552

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

553

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

554

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

555

{

556

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

557

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

558

},

559

],

560

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

561

},

562

],

563

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

564

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

568

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

569

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

570

Sai Cheemalapati

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

[diff] [blame]

571

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.

572

573

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

574

Sai Cheemalapati

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

[diff] [blame]

575

Args:

576

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

577

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

578

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

Dan O'Meara

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

[diff] [blame]

579

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

580

The object takes the form of:

581

582

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

583

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

584

"A String",

585

],

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

586

"skipInapplicableInstances": True or False, # Skip instances which cannot be deleted (instances not belonging to this managed group, already being deleted or being abandoned). If `false`, fail whole flow, if such instance is passed. DEPRECATED: Use skip_instances_on_validation_error instead.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

587

"skipInstancesOnValidationError": True or False, # Specifies whether the request should proceed despite the inclusion of instances that are not members of the group or that are already in the process of being deleted or abandoned. If this field is set to `false` and such an instance is specified in the request, the operation fails. The operation always fails if the request contains a malformed instance URL or a reference to an instance that exists in a zone or region other than the group's zone or region.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

588

}

Sai Cheemalapati

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

[diff] [blame]

589

Bu Sun Kim

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

[diff] [blame]

590

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.

591

592

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.

593

594

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]

595

596

Returns:

597

An object of the form:

598

Bu Sun Kim

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

[diff] [blame]

599

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

600

#

601

# Google Compute Engine has three Operation resources:

602

#

603

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

604

#

605

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

606

#

607

# Operations can be global, regional or zonal.

608

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

609

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

610

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

611

#

612

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

613

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

614

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

615

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

616

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

617

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

618

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

Bu Sun Kim

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

[diff] [blame]

619

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

620

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

621

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

622

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

Bu Sun Kim

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

[diff] [blame]

623

},

624

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

625

},

626

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

627

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

628

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

629

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

630

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

631

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

632

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

633

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

634

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

635

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

636

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

637

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

638

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

639

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

640

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

641

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

642

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

643

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

644

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

645

{

646

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

647

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

648

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

649

{

650

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

651

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

652

},

653

],

654

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

655

},

656

],

657

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

658

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

662

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

Bu Sun Kim

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

[diff] [blame]

663

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

664

665

Args:

666

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

667

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

668

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]

669

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

670

The object takes the form of:

671

672

{ # RegionInstanceGroupManagers.deletePerInstanceConfigs

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

673

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

674

"A String",

675

],

676

}

Bu Sun Kim

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

[diff] [blame]

Returns:

An object of the form:

681

682

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

683

#

684

# Google Compute Engine has three Operation resources:

685

#

686

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

687

#

688

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

689

#

690

# Operations can be global, regional or zonal.

691

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

692

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

693

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

694

#

695

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

696

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

697

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

698

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

699

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

700

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

701

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

Bu Sun Kim

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

[diff] [blame]

702

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

703

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

704

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

705

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

Bu Sun Kim

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

[diff] [blame]

706

},

707

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

708

},

709

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

710

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

711

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

712

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

713

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

714

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

715

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

716

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

717

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

718

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

719

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

720

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

721

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

722

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

723

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

724

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

725

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

726

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

727

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

728

{

729

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

730

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

731

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

732

{

733

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

734

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

735

},

736

],

737

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

738

},

739

],

740

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

741

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

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

746

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

747

748

Args:

749

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

750

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

751

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

752

753

Returns:

754

An object of the form:

755

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

756

{ # Whether the instance is a standby. Properties of a standby instance comparing to the regular instance: ========================================================================= | regular | standby ========================================================================= managed by IGM? | yes | yes added to the IG? | yes | yes counts towards IGM's target size? | yes | no taken into account by Autoscaler? | yes | no receives traffic from LB? | yes | no =========================================================================

757

#

758

# Represents a Managed Instance Group resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

759

#

760

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

761

#

762

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

763

#

764

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

765

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

766

{

767

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

768

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

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

769

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

Jon Wayne Parrott

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

[diff] [blame]

770

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

771

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

772

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

773

#

774

#

775

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

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

776

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

Bu Sun Kim

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

[diff] [blame]

777

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

778

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

779

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

780

},

781

],

782

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

783

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

784

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

785

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

786

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

787

#

788

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

789

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

790

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

791

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

792

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

793

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

794

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

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

795

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

796

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

797

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

798

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

799

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

800

},

801

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

802

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

803

"targetShape": "A String", # The distribution shape to which the group converges either proactively or on resize events (depending on the value set in updatePolicy.instanceRedistributionType).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

804

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

805

{

806

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

},

],

},

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

811

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

812

#

813

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

814

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

815

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

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

816

"instanceLifecyclePolicy": { # Instance lifecycle policy for this Instance Group Manager.

817

"metadataBasedReadinessSignal": { # The configuration for metadata based readiness signal sent by the instance during initialization when stopping / suspending an instance. The Instance Group Manager will wait for a signal that indicates successful initialization before stopping / suspending an instance.

818

#

819

# If a successful readiness signal is not sent before timeout, the corresponding instance will not be stopped / suspended. Instead, an error will be visible in the lastAttempt.errors field of the managed instance in the listmanagedinstances method.

820

#

821

# If metadataBasedReadinessSignal.timeoutSec is unset, the Instance Group Manager will directly proceed to suspend / stop instances, skipping initialization on them.

822

"timeoutSec": 42, # The number of seconds to wait for a readiness signal during initialization before timing out.

823

},

824

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

825

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

826

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

827

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

828

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

829

{ # The named port. For example: .

830

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

831

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

832

},

833

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

834

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

835

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

836

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

837

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

838

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

839

"preservedState": { # Configuration of preserved resources.

840

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

841

"a_key": {

842

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

843

},

844

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

845

"externalIPs": { # External network IPs assigned to the instances that will be preserved on instance delete, update, etc. This map is keyed with the network interface name.

846

"a_key": {

847

"autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted.

848

},

849

},

850

"internalIPs": { # Internal network IPs assigned to the instances that will be preserved on instance delete, update, etc. This map is keyed with the network interface name.

851

"a_key": {

852

"autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted.

853

},

854

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

855

},

856

},

857

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

858

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

859

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

860

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

861

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

862

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

863

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

864

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

865

},

866

},

867

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

868

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

869

},

870

},

871

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

872

"A String",

873

],

874

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

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

875

"targetStoppedSize": 42, # The target number of stopped instances for this managed instance group. This number changes when you:

876

# - Stop instance using the stopInstances method or start instances using the startInstances method.

877

# - Manually change the targetStoppedSize using the update method.

878

"targetSuspendedSize": 42, # The target number of suspended instances for this managed instance group. This number changes when you:

879

# - Suspend instance using the suspendInstances method or resume instances using the resumeInstances method.

880

# - Manually change the targetSuspendedSize using the update method.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

881

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

882

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

883

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

884

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

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

885

"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. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxSurge is a fixed value equal to the number of zones in which the managed instance group operates.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

886

#

887

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

888

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

Bu Sun Kim

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

[diff] [blame]

889

#

890

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

891

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

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

892

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

893

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

894

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

895

},

896

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

897

#

898

#

899

# - The instance's status is RUNNING.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

900

# - If there is a health check on the instance group, the instance's health check status must be HEALTHY at least once. If there is no health check on the group, then the instance only needs to have a status of RUNNING to be considered available. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxUnavailable is a fixed value equal to the number of zones in which the managed instance group operates.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

901

#

902

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

903

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

Bu Sun Kim

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

[diff] [blame]

904

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

905

#

906

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

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

907

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

908

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

909

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

910

},

911

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

912

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

913

"mostDisruptiveAllowedAction": "A String", # Most disruptive action that is allowed to be taken on an instance. You can specify either NONE to forbid any actions, REFRESH to allow actions that do not need instance restart, RESTART to allow actions that can be applied without instance replacing or REPLACE to allow all possible actions. If the Updater determines that the minimal update action needed is more disruptive than most disruptive allowed action you specify it will not perform the update at all.

914

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

915

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

916

},

917

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

918

#

919

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

920

{

921

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

922

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

923

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

924

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

925

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

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

926

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

Bu Sun Kim

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

[diff] [blame]

927

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

928

#

929

#

930

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

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

931

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

Bu Sun Kim

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

[diff] [blame]

932

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

933

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

934

},

Bu Sun Kim

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

[diff] [blame]

935

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

936

],

937

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

938

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

942

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

943

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

944

945

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

946

947

Args:

948

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

949

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

Dan O'Meara

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

[diff] [blame]

950

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

951

The object takes the form of:

952

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

953

{ # Whether the instance is a standby. Properties of a standby instance comparing to the regular instance: ========================================================================= | regular | standby ========================================================================= managed by IGM? | yes | yes added to the IG? | yes | yes counts towards IGM's target size? | yes | no taken into account by Autoscaler? | yes | no receives traffic from LB? | yes | no =========================================================================

954

#

955

# Represents a Managed Instance Group resource.

Bu Sun Kim

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

[diff] [blame]

956

#

957

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

958

#

959

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

960

#

Dan O'Meara

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

[diff] [blame]

961

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

962

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

963

{

Bu Sun Kim

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

[diff] [blame]

964

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

965

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

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

966

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

967

#

968

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

969

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

970

#

971

#

972

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

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

973

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

Bu Sun Kim

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

[diff] [blame]

974

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

975

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

976

},

977

},

978

],

Bu Sun Kim

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

[diff] [blame]

979

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

980

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

981

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

982

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

983

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

984

#

985

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

986

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

987

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

988

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

989

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

990

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

991

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

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

992

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

993

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

994

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

995

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

Bu Sun Kim

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

[diff] [blame]

996

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

997

},

Bu Sun Kim

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

[diff] [blame]

998

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

Bu Sun Kim

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

[diff] [blame]

999

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1000

"targetShape": "A String", # The distribution shape to which the group converges either proactively or on resize events (depending on the value set in updatePolicy.instanceRedistributionType).

Bu Sun Kim

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

[diff] [blame]

1001

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

Bu Sun Kim

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

[diff] [blame]

1002

{

Bu Sun Kim

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

[diff] [blame]

1003

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

1004

},

1005

],

1006

},

Bu Sun Kim

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

[diff] [blame]

1007

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

1008

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

1009

#

1010

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

1011

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

1012

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

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1013

"instanceLifecyclePolicy": { # Instance lifecycle policy for this Instance Group Manager.

1014

"metadataBasedReadinessSignal": { # The configuration for metadata based readiness signal sent by the instance during initialization when stopping / suspending an instance. The Instance Group Manager will wait for a signal that indicates successful initialization before stopping / suspending an instance.

1015

#

1016

# If a successful readiness signal is not sent before timeout, the corresponding instance will not be stopped / suspended. Instead, an error will be visible in the lastAttempt.errors field of the managed instance in the listmanagedinstances method.

1017

#

1018

# If metadataBasedReadinessSignal.timeoutSec is unset, the Instance Group Manager will directly proceed to suspend / stop instances, skipping initialization on them.

1019

"timeoutSec": 42, # The number of seconds to wait for a readiness signal during initialization before timing out.

1020

},

1021

},

Bu Sun Kim

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

[diff] [blame]

1022

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

Bu Sun Kim

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

[diff] [blame]

1023

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

1024

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

1025

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

1026

{ # The named port. For example: .

1027

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

1028

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

1029

},

1030

],

Bu Sun Kim

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

[diff] [blame]

1031

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

1032

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

1033

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

1034

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

1035

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

1036

"preservedState": { # Configuration of preserved resources.

1037

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

1038

"a_key": {

1039

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

1040

},

1041

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1042

"externalIPs": { # External network IPs assigned to the instances that will be preserved on instance delete, update, etc. This map is keyed with the network interface name.

1043

"a_key": {

1044

"autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted.

1045

},

1046

},

1047

"internalIPs": { # Internal network IPs assigned to the instances that will be preserved on instance delete, update, etc. This map is keyed with the network interface name.

1048

"a_key": {

1049

"autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted.

1050

},

1051

},

Bu Sun Kim

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

[diff] [blame]

1052

},

1053

},

Bu Sun Kim

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

[diff] [blame]

1054

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

1055

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

1056

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

1057

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

1058

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

1059

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

1060

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

1061

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

1062

},

Bu Sun Kim

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

[diff] [blame]

1063

},

1064

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

1065

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

1066

},

1067

},

1068

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

1069

"A String",

1070

],

1071

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

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1072

"targetStoppedSize": 42, # The target number of stopped instances for this managed instance group. This number changes when you:

1073

# - Stop instance using the stopInstances method or start instances using the startInstances method.

1074

# - Manually change the targetStoppedSize using the update method.

1075

"targetSuspendedSize": 42, # The target number of suspended instances for this managed instance group. This number changes when you:

1076

# - Suspend instance using the suspendInstances method or resume instances using the resumeInstances method.

1077

# - Manually change the targetSuspendedSize using the update method.

Bu Sun Kim

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

[diff] [blame]

1078

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

1079

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

1080

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

1081

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

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

1082

"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. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxSurge is a fixed value equal to the number of zones in which the managed instance group operates.

Bu Sun Kim

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

[diff] [blame]

1083

#

1084

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

1085

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

1086

#

1087

#

1088

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

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

1089

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

Bu Sun Kim

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

[diff] [blame]

1090

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

1091

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

1092

},

1093

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

1094

#

1095

#

1096

# - The instance's status is RUNNING.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

1097

# - If there is a health check on the instance group, the instance's health check status must be HEALTHY at least once. If there is no health check on the group, then the instance only needs to have a status of RUNNING to be considered available. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxUnavailable is a fixed value equal to the number of zones in which the managed instance group operates.

Bu Sun Kim

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

[diff] [blame]

1098

#

1099

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

1100

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

1101

#

1102

#

1103

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

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

1104

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

Bu Sun Kim

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

[diff] [blame]

1105

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

1106

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

1107

},

1108

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

1109

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

Yoshi Automation Bot

0d561ef

2020-11-25 07:50:41 -0800

[diff] [blame]

1110

"mostDisruptiveAllowedAction": "A String", # Most disruptive action that is allowed to be taken on an instance. You can specify either NONE to forbid any actions, REFRESH to allow actions that do not need instance restart, RESTART to allow actions that can be applied without instance replacing or REPLACE to allow all possible actions. If the Updater determines that the minimal update action needed is more disruptive than most disruptive allowed action you specify it will not perform the update at all.

Bu Sun Kim

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

[diff] [blame]

1111

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

1112

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

1113

},

1114

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

1115

#

1116

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

1117

{

Bu Sun Kim

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

[diff] [blame]

1118

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

Bu Sun Kim

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

[diff] [blame]

1119

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

1120

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

1121

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

1122

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

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

1123

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

Bu Sun Kim

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

[diff] [blame]

1124

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

1125

#

1126

#

1127

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

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

1128

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

Bu Sun Kim

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

[diff] [blame]

1129

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

1130

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

1131

},

1132

},

1133

],

Bu Sun Kim

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

[diff] [blame]

1134

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

Bu Sun Kim

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

[diff] [blame]

1135

}

Sai Cheemalapati

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

[diff] [blame]

1136

Bu Sun Kim

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

[diff] [blame]

1137

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.

1138

1139

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.

1140

1141

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]

1142

1143

Returns:

1144

An object of the form:

1145

Bu Sun Kim

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

[diff] [blame]

1146

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1147

#

1148

# Google Compute Engine has three Operation resources:

1149

#

1150

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

1151

#

1152

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

1153

#

1154

# Operations can be global, regional or zonal.

1155

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

1156

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

1157

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

1158

#

1159

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

1160

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

1161

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

1162

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

1163

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

1164

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

1165

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

Bu Sun Kim

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

[diff] [blame]

1166

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1167

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

1168

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

1169

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

Bu Sun Kim

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

[diff] [blame]

1170

},

1171

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1172

},

1173

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

1174

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

1175

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

1176

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

1177

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

1178

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1179

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1180

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

1181

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

1182

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

1183

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

1184

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

1185

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

1186

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

1187

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

1188

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

1189

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

1190

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

1191

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

1192

{

1193

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

1194

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

1195

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

1196

{

1197

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

1198

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

1199

},

1200

],

1201

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

1202

},

1203

],

1204

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

1205

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

1209

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

1210

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

1211

1212

Args:

1213

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

1214

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

Dan O'Meara

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

[diff] [blame]

1215

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]

1216

Dan O'Meara

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

[diff] [blame]

1217

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]

1218

Dan O'Meara

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

[diff] [blame]

1219

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]

1220

Bu Sun Kim

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

[diff] [blame]

1221

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

1222

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

1223

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

1224

1225

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.

1226

1227

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

1228

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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1229

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

Sai Cheemalapati

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

[diff] [blame]

1230

1231

Returns:

1232

An object of the form:

1233

1234

{ # Contains a list of managed instance groups.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1235

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

1236

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

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

1237

{ # Whether the instance is a standby. Properties of a standby instance comparing to the regular instance: ========================================================================= | regular | standby ========================================================================= managed by IGM? | yes | yes added to the IG? | yes | yes counts towards IGM's target size? | yes | no taken into account by Autoscaler? | yes | no receives traffic from LB? | yes | no =========================================================================

1238

#

1239

# Represents a Managed Instance Group resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1240

#

1241

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

1242

#

1243

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

1244

#

1245

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

1246

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

1247

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1248

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

1249

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

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

1250

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1251

#

1252

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

1253

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

1254

#

1255

#

1256

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

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

1257

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1258

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

1259

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

1260

},

Bu Sun Kim

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

[diff] [blame]

1261

},

1262

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1263

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

1264

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

1265

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

1266

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

1267

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

1268

#

1269

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

1270

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

1271

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

1272

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

1273

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

1274

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

1275

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

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1276

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

1277

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

1278

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

1279

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1280

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

1281

},

1282

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

1283

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1284

"targetShape": "A String", # The distribution shape to which the group converges either proactively or on resize events (depending on the value set in updatePolicy.instanceRedistributionType).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1285

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

1286

{

1287

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

},

],

},

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

1292

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

1293

#

1294

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

1295

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

1296

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

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1297

"instanceLifecyclePolicy": { # Instance lifecycle policy for this Instance Group Manager.

1298

"metadataBasedReadinessSignal": { # The configuration for metadata based readiness signal sent by the instance during initialization when stopping / suspending an instance. The Instance Group Manager will wait for a signal that indicates successful initialization before stopping / suspending an instance.

1299

#

1300

# If a successful readiness signal is not sent before timeout, the corresponding instance will not be stopped / suspended. Instead, an error will be visible in the lastAttempt.errors field of the managed instance in the listmanagedinstances method.

1301

#

1302

# If metadataBasedReadinessSignal.timeoutSec is unset, the Instance Group Manager will directly proceed to suspend / stop instances, skipping initialization on them.

1303

"timeoutSec": 42, # The number of seconds to wait for a readiness signal during initialization before timing out.

1304

},

1305

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1306

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

1307

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

1308

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

1309

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

1310

{ # The named port. For example: .

1311

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

1312

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

1313

},

1314

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1315

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

1316

"selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.

1317

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1318

"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.

1319

"statefulPolicy": { # Stateful configuration for this Instanced Group Manager

1320

"preservedState": { # Configuration of preserved resources.

1321

"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.

1322

"a_key": {

1323

"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.

1324

},

1325

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1326

"externalIPs": { # External network IPs assigned to the instances that will be preserved on instance delete, update, etc. This map is keyed with the network interface name.

1327

"a_key": {

1328

"autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted.

1329

},

1330

},

1331

"internalIPs": { # Internal network IPs assigned to the instances that will be preserved on instance delete, update, etc. This map is keyed with the network interface name.

1332

"a_key": {

1333

"autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted.

1334

},

1335

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1336

},

1337

},

1338

"status": { # [Output Only] The status of this managed instance group.

1339

"autoscaler": "A String", # [Output Only] The URL of the Autoscaler that targets this instance group manager.

1340

"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.

1341

"stateful": { # [Output Only] Stateful status of the given Instance Group Manager.

1342

"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.

1343

"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.

1344

"perInstanceConfigs": { # [Output Only] Status of per-instance configs on the instance.

1345

"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.

1346

},

1347

},

1348

"versionTarget": { # [Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager.

1349

"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.

1350

},

1351

},

1352

"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.

1353

"A String",

1354

],

1355

"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.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1356

"targetStoppedSize": 42, # The target number of stopped instances for this managed instance group. This number changes when you:

1357

# - Stop instance using the stopInstances method or start instances using the startInstances method.

1358

# - Manually change the targetStoppedSize using the update method.

1359

"targetSuspendedSize": 42, # The target number of suspended instances for this managed instance group. This number changes when you:

1360

# - Suspend instance using the suspendInstances method or resume instances using the resumeInstances method.

1361

# - Manually change the targetSuspendedSize using the update method.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1362

"updatePolicy": { # The update policy for this managed instance group.

1363

"instanceRedistributionType": "A String", # The instance redistribution policy for regional managed instance groups. Valid values are:

1364

# - PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region.

1365

# - NONE: For non-autoscaled groups, proactive redistribution is disabled.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

1366

"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. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxSurge is a fixed value equal to the number of zones in which the managed instance group operates.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1367

#

1368

# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge.

1369

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

1370

#

1371

#

1372

# - If the value is fixed, then the calculated value is equal to the fixed value.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

1373

# - 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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1374

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

1375

"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

1376

},

1377

"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:

1378

#

1379

#

1380

# - The instance's status is RUNNING.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

1381

# - If there is a health check on the instance group, the instance's health check status must be HEALTHY at least once. If there is no health check on the group, then the instance only needs to have a status of RUNNING to be considered available. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxUnavailable is a fixed value equal to the number of zones in which the managed instance group operates.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1382

#

1383

# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable.

1384

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

1385

#

1386

#

1387

# - If the value is fixed, then the calculated value is equal to the fixed value.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

1388

# - 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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1389

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

1390

"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

1391

},

1392

"minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].

1393

"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.

1394

"mostDisruptiveAllowedAction": "A String", # Most disruptive action that is allowed to be taken on an instance. You can specify either NONE to forbid any actions, REFRESH to allow actions that do not need instance restart, RESTART to allow actions that can be applied without instance replacing or REPLACE to allow all possible actions. If the Updater determines that the minimal update action needed is more disruptive than most disruptive allowed action you specify it will not perform the update at all.

1395

"replacementMethod": "A String", # What action should be used to replace instances. See minimal_action.REPLACE

1396

"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).

1397

},

1398

"versions": [ # Specifies the instance templates used by this managed instance group to create instances.

1399

#

1400

# 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.

1401

{

1402

"instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create new instances in the managed instance group until the `targetSize` for this version is reached. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE; in those cases, existing instances are updated until the `targetSize` for this version is reached.

1403

"name": "A String", # Name of the version. Unique among all versions in the scope of this managed instance group.

1404

"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'.

1405

"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:

1406

# - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

1407

# - if expressed as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) If there is a remainder, the number is rounded. If unset, this version will update any remaining instances not updated by another version. Read Starting a canary update for more information.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1408

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

1409

#

1410

#

1411

# - If the value is fixed, then the calculated value is equal to the fixed value.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

1412

# - 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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1413

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

1414

"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 a zone where the managed instance group is located (for zonal resources).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1419

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1420

],

1421

"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.

1422

"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.

1423

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

1424

"warning": { # [Output Only] Informational warning message.

1425

"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.

1426

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1427

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

1428

{

1429

"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).

1430

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1431

},

1432

],

1433

"message": "A String", # [Output Only] A human-readable description of the warning code.

1434

},

1435

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1439

<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]

1440

<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]

1441

1442

Args:

1443

project: string, Project ID for this request. (required)

1444

region: string, Name of the region scoping this request. This should conform to RFC1035. (required)

1445

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]

1446

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]

1447

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1448

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]

1449

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1450

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]

1451

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1452

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) ```

1453

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`)

1454

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

1455

1456

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.

1457

1458

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

1459

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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1460

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1461

1462

Returns:

1463

An object of the form:

1464

1465

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1466

"items": [ # [Output Only] The list of errors of the managed instance group.

1467

{

1468

"error": { # [Output Only] Contents of the error.

1469

"code": "A String", # [Output Only] Error code.

1470

"message": "A String", # [Output Only] Error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1471

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1472

"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.

1473

"action": "A String", # [Output Only] Action that managed instance group was executing on the instance when the error occurred. Possible values:

1474

"instance": "A String", # [Output Only] The URL of the instance. The URL can be set even if the instance has not yet been created.

1475

"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.

1476

"instanceTemplate": "A String", # [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }.

1477

"name": "A String", # [Output Only] Name of the version.

1478

},

1479

},

1480

"timestamp": "A String", # [Output Only] The time that this error occurred. This value is in RFC3339 text format.

1481

},

1482

],

1483

"nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

1484

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

<code class="details" id="listErrors_next">listErrors_next(previous_request, previous_response)</code>

1489

<pre>Retrieves the next page of results.

1490

1491

Args:

1492

previous_request: The request for the previous page. (required)

1493

previous_response: The response from the request for the previous page. (required)

1494

1495

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1496

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]

1497

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]

1502

<code class="details" id="listManagedInstances">listManagedInstances(project, region, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>

1503

<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]

1504

1505

Args:

1506

project: string, Project ID for this request. (required)

1507

region: string, Name of the region scoping this request. (required)

1508

instanceGroupManager: string, The name of the managed instance group. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1509

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]

1510

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1511

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]

1512

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1513

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]

1514

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1515

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) ```

1516

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`)

1517

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

1518

1519

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.

1520

1521

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

1522

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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1523

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1524

1525

Returns:

1526

An object of the form:

1527

1528

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1529

"managedInstances": [ # A list of managed instances.

1530

{ # A Managed Instance resource.

1531

"currentAction": "A String", # [Output Only] The current action that the managed instance group has scheduled for the instance. Possible values:

1532

# - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance.

1533

# - 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.

1534

# - 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.

1535

# - RECREATING The managed instance group is recreating this instance.

1536

# - DELETING The managed instance group is permanently deleting this instance.

1537

# - 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.

1538

# - RESTARTING The managed instance group is restarting the instance.

1539

# - 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.

1540

# - VERIFYING The managed instance group has created the instance and it is in the process of being verified.

1541

"id": "A String", # [Output only] The unique identifier for this resource. This field is empty when instance does not exist.

1542

"instance": "A String", # [Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created.

1543

"instanceHealth": [ # [Output Only] Health state of the instance per health-check.

1544

{

1545

"detailedHealthState": "A String", # [Output Only] The current detailed instance health state.

1546

"healthCheck": "A String", # [Output Only] The URL for the health check that verifies whether the instance is healthy.

1547

"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]

1548

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1549

],

1550

"instanceStatus": "A String", # [Output Only] The status of the instance. This field is empty when the instance does not exist.

1551

"instanceTemplate": "A String", # [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }.

1552

"lastAttempt": { # [Output Only] Information about the last attempt to create or delete the instance.

1553

"errors": { # [Output Only] Encountered errors during the last attempt to create or delete the instance.

1554

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

1555

{

1556

"code": "A String", # [Output Only] The error type identifier for this error.

1557

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1558

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1559

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1560

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1561

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1562

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1563

"preservedStateFromConfig": { # Preserved state for a given instance. # [Output Only] Preserved state applied from per-instance config for this instance.

1564

"disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks.

1565

"a_key": {

1566

"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.

1567

"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.

1568

"source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance.

1569

},

1570

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1571

"externalIPs": { # Preserved external IPs defined for this instance. This map is keyed with the name of the network interface.

1572

"a_key": {

1573

"autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted.

1574

"ipAddress": { # Ip address representation

1575

"address": "A String", # The URL of the reservation for this IP address.

1576

"literal": "A String", # An IPv4 internal network address to assign to the instance for this network interface.

},

},

},

"internalIPs": { # Preserved internal IPs defined for this instance. This map is keyed with the name of the network interface.

1581

"a_key": {

1582

"autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted.

1583

"ipAddress": { # Ip address representation

1584

"address": "A String", # The URL of the reservation for this IP address.

1585

"literal": "A String", # An IPv4 internal network address to assign to the instance for this network interface.

1586

},

1587

},

1588

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1589

"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.

1594

"disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks.

1595

"a_key": {

1596

"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.

1597

"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.

1598

"source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance.

1599

},

1600

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1601

"externalIPs": { # Preserved external IPs defined for this instance. This map is keyed with the name of the network interface.

1602

"a_key": {

1603

"autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted.

1604

"ipAddress": { # Ip address representation

1605

"address": "A String", # The URL of the reservation for this IP address.

1606

"literal": "A String", # An IPv4 internal network address to assign to the instance for this network interface.

},

},

},

"internalIPs": { # Preserved internal IPs defined for this instance. This map is keyed with the name of the network interface.

1611

"a_key": {

1612

"autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted.

1613

"ipAddress": { # Ip address representation

1614

"address": "A String", # The URL of the reservation for this IP address.

1615

"literal": "A String", # An IPv4 internal network address to assign to the instance for this network interface.

1616

},

1617

},

1618

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1619

"metadata": { # Preserved metadata defined for this instance.

"a_key": "A String",

},

},

"tag": "A String", # [Output Only] Tag describing the version.

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

1624

"targetStatus": "A String", # [Output Only] The eventual status of the instance. The instance group manager will not be identified as stable till each managed instance reaches its targetStatus.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1625

"version": { # [Output Only] Intended version of this instance.

1626

"instanceTemplate": "A String", # [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }.

1627

"name": "A String", # [Output Only] Name of the version.

},

},

],

"nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger 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.

1632

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1636

<code class="details" id="listManagedInstances_next">listManagedInstances_next(previous_request, previous_response)</code>

1637

<pre>Retrieves the next page of results.

1638

1639

Args:

1640

previous_request: The request for the previous page. (required)

1641

previous_response: The response from the request for the previous page. (required)

1642

1643

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1644

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1645

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]

1650

<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]

1651

<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]

1652

1653

Args:

1654

project: string, Project ID for this request. (required)

1655

region: string, Name of the region scoping this request, should conform to RFC1035. (required)

1656

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]

1657

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]

1658

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1659

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]

1660

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1661

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]

1662

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1663

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) ```

1664

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`)

1665

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

1666

1667

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.

1668

1669

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

1670

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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1671

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1672

1673

Returns:

1674

An object of the form:

1675

1676

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1677

"items": [ # [Output Only] The list of PerInstanceConfig.

1678

{

1679

"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.

1680

"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.

1681

"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.

1682

"disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks.

1683

"a_key": {

1684

"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.

1685

"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.

1686

"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]

1687

},

1688

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1689

"externalIPs": { # Preserved external IPs defined for this instance. This map is keyed with the name of the network interface.

1690

"a_key": {

1691

"autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted.

1692

"ipAddress": { # Ip address representation

1693

"address": "A String", # The URL of the reservation for this IP address.

1694

"literal": "A String", # An IPv4 internal network address to assign to the instance for this network interface.

},

},

},

"internalIPs": { # Preserved internal IPs defined for this instance. This map is keyed with the name of the network interface.

1699

"a_key": {

1700

"autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted.

1701

"ipAddress": { # Ip address representation

1702

"address": "A String", # The URL of the reservation for this IP address.

1703

"literal": "A String", # An IPv4 internal network address to assign to the instance for this network interface.

1704

},

1705

},

1706

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1707

"metadata": { # Preserved metadata defined for this instance.

"a_key": "A String",

},

},

"status": "A String", # The status of applying this per-instance config on the corresponding managed instance.

1712

},

1713

],

1714

"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.

1715

"warning": { # [Output Only] Informational warning message.

1716

"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.

1717

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1718

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

1719

{

1720

"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).

1721

"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]

1722

},

1723

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1724

"message": "A String", # [Output Only] A human-readable description of the warning code.

1725

},

1726

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

<code class="details" id="listPerInstanceConfigs_next">listPerInstanceConfigs_next(previous_request, previous_response)</code>

1731

<pre>Retrieves the next page of results.

1732

1733

Args:

1734

previous_request: The request for the previous page. (required)

1735

previous_response: The response from the request for the previous page. (required)

1736

1737

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1738

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]

1739

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]

1744

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

1745

<pre>Retrieves the next page of results.

1746

1747

Args:

1748

previous_request: The request for the previous page. (required)

1749

previous_response: The response from the request for the previous page. (required)

1750

1751

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1752

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1753

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]

1758

<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]

1759

<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]

1760

1761

Args:

1762

project: string, Project ID for this request. (required)

1763

region: string, Name of the region scoping this request. (required)

1764

instanceGroupManager: string, The name of the instance group manager. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1765

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1766

The object takes the form of:

1767

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

1768

{ # Whether the instance is a standby. Properties of a standby instance comparing to the regular instance: ========================================================================= | regular | standby ========================================================================= managed by IGM? | yes | yes added to the IG? | yes | yes counts towards IGM's target size? | yes | no taken into account by Autoscaler? | yes | no receives traffic from LB? | yes | no =========================================================================

1769

#

1770

# Represents a Managed Instance Group resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1771

#

1772

# An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups.

1773

#

1774

# For zonal Managed Instance Group, use the instanceGroupManagers resource.

1775

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1776

# 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]

1777

"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]

1778

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1779

"healthCheck": "A String", # The URL for the health check that signals autohealing.

1780

"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].

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

1781

"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 if necessary. 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]

1782

#

1783

# 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]

1784

"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]

1785

#

1786

#

1787

# - If the value is fixed, then the calculated value is equal to the fixed value.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

1788

# - 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1789

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

1790

"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]

1791

},

1792

},

1793

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1794

"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.

1795

"creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.

1796

"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.

1797

"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.

1798

"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]

1799

#

1800

# 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]

1801

"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.

1802

"deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.

1803

"none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.

1804

"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.

1805

"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.

1806

"restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1807

"resuming": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be resumed or are currently being resumed.

1808

"starting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be started or are currently being started.

1809

"stopping": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be stopped or are currently being stopped.

1810

"suspending": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be suspended or are currently being suspended.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1811

"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]

1812

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1813

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1814

"distributionPolicy": { # Policy specifying the intended distribution of managed instances across zones in a regional managed instance group.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1815

"targetShape": "A String", # The distribution shape to which the group converges either proactively or on resize events (depending on the value set in updatePolicy.instanceRedistributionType).

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1816

"zones": [ # Zones where the regional managed instance group will create and manage its instances.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1817

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1818

"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]

1819

},

1820

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1821

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1822

"failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.

1823

"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.

1824

#

1825

# To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.

1826

"id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.

1827

"instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1828

"instanceLifecyclePolicy": { # Instance lifecycle policy for this Instance Group Manager.

1829

"metadataBasedReadinessSignal": { # The configuration for metadata based readiness signal sent by the instance during initialization when stopping / suspending an instance. The Instance Group Manager will wait for a signal that indicates successful initialization before stopping / suspending an instance.

1830

#

1831

# If a successful readiness signal is not sent before timeout, the corresponding instance will not be stopped / suspended. Instead, an error will be visible in the lastAttempt.errors field of the managed instance in the listmanagedinstances method.

1832

#

1833

# If metadataBasedReadinessSignal.timeoutSec is unset, the Instance Group Manager will directly proceed to suspend / stop instances, skipping initialization on them.

1834

"timeoutSec": 42, # The number of seconds to wait for a readiness signal during initialization before timing out.

1835

},

1836

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1837

"instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1838

"kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.

1839

"name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.

1840

"namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.

1841

{ # The named port. For example: .

1842

"name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.

1843

"port": 42, # The port number, which can be a value between 1 and 65535.

1844

},

1845

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1846

"region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).

1847

"selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.

1848

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1849

"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.

1850

"statefulPolicy": { # Stateful configuration for this Instanced Group Manager

1851

"preservedState": { # Configuration of preserved resources.

1852

"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.

1853

"a_key": {

1854

"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]

1855

},

1856

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1857

"externalIPs": { # External network IPs assigned to the instances that will be preserved on instance delete, update, etc. This map is keyed with the network interface name.

1858

"a_key": {

1859

"autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted.

1860

},

1861

},

1862

"internalIPs": { # Internal network IPs assigned to the instances that will be preserved on instance delete, update, etc. This map is keyed with the network interface name.

1863

"a_key": {

1864

"autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted.

1865

},

1866

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1867

},

1868

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1869

"status": { # [Output Only] The status of this managed instance group.

1870

"autoscaler": "A String", # [Output Only] The URL of the Autoscaler that targets this instance group manager.

1871

"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.

1872

"stateful": { # [Output Only] Stateful status of the given Instance Group Manager.

1873

"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.

1874

"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]

1875

"perInstanceConfigs": { # [Output Only] Status of per-instance configs on the instance.

1876

"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.

1877

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1878

},

1879

"versionTarget": { # [Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager.

1880

"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.

1881

},

1882

},

1883

"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.

1884

"A String",

1885

],

1886

"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.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1887

"targetStoppedSize": 42, # The target number of stopped instances for this managed instance group. This number changes when you:

1888

# - Stop instance using the stopInstances method or start instances using the startInstances method.

1889

# - Manually change the targetStoppedSize using the update method.

1890

"targetSuspendedSize": 42, # The target number of suspended instances for this managed instance group. This number changes when you:

1891

# - Suspend instance using the suspendInstances method or resume instances using the resumeInstances method.

1892

# - Manually change the targetSuspendedSize using the update method.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1893

"updatePolicy": { # The update policy for this managed instance group.

1894

"instanceRedistributionType": "A String", # The instance redistribution policy for regional managed instance groups. Valid values are:

1895

# - PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region.

1896

# - NONE: For non-autoscaled groups, proactive redistribution is disabled.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

1897

"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. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxSurge is a fixed value equal to the number of zones in which the managed instance group operates.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1898

#

1899

# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge.

1900

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

1901

#

1902

#

1903

# - If the value is fixed, then the calculated value is equal to the fixed value.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

1904

# - 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1905

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

1906

"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

1907

},

1908

"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:

1909

#

1910

#

1911

# - The instance's status is RUNNING.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

1912

# - If there is a health check on the instance group, the instance's health check status must be HEALTHY at least once. If there is no health check on the group, then the instance only needs to have a status of RUNNING to be considered available. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxUnavailable is a fixed value equal to the number of zones in which the managed instance group operates.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1913

#

1914

# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable.

1915

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

1916

#

1917

#

1918

# - If the value is fixed, then the calculated value is equal to the fixed value.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

1919

# - 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1920

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

1921

"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

1922

},

1923

"minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].

1924

"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.

Yoshi Automation Bot

0d561ef

2020-11-25 07:50:41 -0800

[diff] [blame]

1925

"mostDisruptiveAllowedAction": "A String", # Most disruptive action that is allowed to be taken on an instance. You can specify either NONE to forbid any actions, REFRESH to allow actions that do not need instance restart, RESTART to allow actions that can be applied without instance replacing or REPLACE to allow all possible actions. If the Updater determines that the minimal update action needed is more disruptive than most disruptive allowed action you specify it will not perform the update at all.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1926

"replacementMethod": "A String", # What action should be used to replace instances. See minimal_action.REPLACE

1927

"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).

1928

},

1929

"versions": [ # Specifies the instance templates used by this managed instance group to create instances.

1930

#

1931

# 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.

1932

{

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1933

"instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create new instances in the managed instance group until the `targetSize` for this version is reached. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE; in those cases, existing instances are updated until the `targetSize` for this version is reached.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1934

"name": "A String", # Name of the version. Unique among all versions in the scope of this managed instance group.

1935

"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'.

1936

"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:

1937

# - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

1938

# - if expressed as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) If there is a remainder, the number is rounded. If unset, this version will update any remaining instances not updated by another version. Read Starting a canary update for more information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1939

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

1940

#

1941

#

1942

# - If the value is fixed, then the calculated value is equal to the fixed value.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

1943

# - 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1944

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

1945

"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

1946

},

1947

},

1948

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1949

"zone": "A String", # [Output Only] The URL of a zone where the managed instance group is located (for zonal resources).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1950

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1951

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1952

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.

1953

1954

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.

1955

1956

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]

1957

1958

Returns:

1959

An object of the form:

1960

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1961

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1962

#

1963

# Google Compute Engine has three Operation resources:

1964

#

1965

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

1966

#

1967

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

1968

#

1969

# Operations can be global, regional or zonal.

1970

# - For global operations, use the `globalOperations` resource.

1971

# - For regional operations, use the `regionOperations` resource.

1972

# - For zonal operations, use the `zonalOperations` resource.

1973

#

1974

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

1975

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1976

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1977

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1978

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1979

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1980

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1981

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1982

"code": "A String", # [Output Only] The error type identifier for this error.

1983

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1984

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1985

},

1986

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1987

},

1988

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1989

"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.

1990

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

1991

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1992

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1993

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1994

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1995

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1996

"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.

1997

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

1998

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1999

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2000

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2001

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2002

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2003

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2004

"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.

2005

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2006

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2007

{

2008

"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.

2009

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2010

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2011

{

2012

"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).

2013

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2014

},

2015

],

2016

"message": "A String", # [Output Only] A human-readable description of the warning code.

2017

},

2018

],

2019

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

2020

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2024

<code class="details" id="patchPerInstanceConfigs">patchPerInstanceConfigs(project, region, instanceGroupManager, body=None, requestId=None)</code>

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2025

<pre>Inserts or patches per-instance configs for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2026

2027

Args:

2028

project: string, Project ID for this request. (required)

2029

region: string, Name of the region scoping this request, should conform to RFC1035. (required)

2030

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]

2031

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2032

The object takes the form of:

2033

2034

{ # RegionInstanceGroupManagers.patchPerInstanceConfigs

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2035

"perInstanceConfigs": [ # The list of per-instance configs to insert or patch on this managed instance group.

2036

{

2037

"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.

2038

"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.

2039

"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.

2040

"disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks.

2041

"a_key": {

2042

"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.

2043

"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.

2044

"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]

2045

},

2046

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2047

"externalIPs": { # Preserved external IPs defined for this instance. This map is keyed with the name of the network interface.

2048

"a_key": {

2049

"autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted.

2050

"ipAddress": { # Ip address representation

2051

"address": "A String", # The URL of the reservation for this IP address.

2052

"literal": "A String", # An IPv4 internal network address to assign to the instance for this network interface.

},

},

},

"internalIPs": { # Preserved internal IPs defined for this instance. This map is keyed with the name of the network interface.

2057

"a_key": {

2058

"autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted.

2059

"ipAddress": { # Ip address representation

2060

"address": "A String", # The URL of the reservation for this IP address.

2061

"literal": "A String", # An IPv4 internal network address to assign to the instance for this network interface.

2062

},

2063

},

2064

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2065

"metadata": { # Preserved metadata defined for this instance.

2066

"a_key": "A String",

2067

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2068

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2069

"status": "A String", # The status of applying this per-instance config on the corresponding managed instance.

2070

},

2071

],

2072

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2073

2074

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.

2075

2076

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.

2077

2078

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

2079

2080

Returns:

2081

An object of the form:

2082

2083

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2084

#

2085

# Google Compute Engine has three Operation resources:

2086

#

2087

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2088

#

2089

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2090

#

2091

# Operations can be global, regional or zonal.

2092

# - For global operations, use the `globalOperations` resource.

2093

# - For regional operations, use the `regionOperations` resource.

2094

# - For zonal operations, use the `zonalOperations` resource.

2095

#

2096

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

2097

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2098

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2099

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2100

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2101

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2102

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2103

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2104

"code": "A String", # [Output Only] The error type identifier for this error.

2105

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2106

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2107

},

2108

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2109

},

2110

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2111

"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.

2112

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2113

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2114

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2115

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2116

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2117

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2118

"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.

2119

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2120

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2121

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2122

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2123

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2124

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2125

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2126

"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.

2127

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2128

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2129

{

2130

"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.

2131

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2132

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2133

{

2134

"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).

2135

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2136

},

2137

],

2138

"message": "A String", # [Output Only] A human-readable description of the warning code.

2139

},

2140

],

2141

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

2142

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2146

<code class="details" id="recreateInstances">recreateInstances(project, region, instanceGroupManager, body=None, requestId=None)</code>

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

2147

<pre>Flags the specified VM instances in the managed instance group to be immediately recreated. Each instance is recreated using the group's current configuration. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of each instance by checking its currentAction field; for more information, see Checking the status of managed instances.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2148

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2149

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.

2150

2151

You can specify a maximum of 1000 instances with this method per request.

2152

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2153

Args:

2154

project: string, Project ID for this request. (required)

2155

region: string, Name of the region scoping this request. (required)

2156

instanceGroupManager: string, Name of the managed instance group. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2157

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2158

The object takes the form of:

2159

2160

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2161

"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].

2162

"A String",

2163

],

2164

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2165

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2166

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.

2167

2168

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.

2169

2170

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]

2171

2172

Returns:

2173

An object of the form:

2174

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2175

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2176

#

2177

# Google Compute Engine has three Operation resources:

2178

#

2179

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2180

#

2181

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2182

#

2183

# Operations can be global, regional or zonal.

2184

# - For global operations, use the `globalOperations` resource.

2185

# - For regional operations, use the `regionOperations` resource.

2186

# - For zonal operations, use the `zonalOperations` resource.

2187

#

2188

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

2189

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2190

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2191

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2192

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2193

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2194

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2195

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2196

"code": "A String", # [Output Only] The error type identifier for this error.

2197

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2198

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2199

},

2200

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2201

},

2202

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2203

"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.

2204

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2205

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2206

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2207

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2208

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2209

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2210

"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.

2211

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2212

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2213

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2214

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2215

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2216

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2217

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2218

"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.

2219

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2220

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2221

{

2222

"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.

2223

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2224

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2225

{

2226

"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).

2227

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2228

},

2229

],

2230

"message": "A String", # [Output Only] A human-readable description of the warning code.

2231

},

2232

],

2233

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

2234

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

2238

<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]

2239

<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.

2240

2241

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]

2242

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2243

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.

2244

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2245

Args:

2246

project: string, Project ID for this request. (required)

2247

region: string, Name of the region scoping this request. (required)

2248

instanceGroupManager: string, Name of the managed instance group. (required)

2249

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]

2250

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.

2251

2252

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.

2253

2254

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]

2255

2256

Returns:

2257

An object of the form:

2258

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2259

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2260

#

2261

# Google Compute Engine has three Operation resources:

2262

#

2263

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2264

#

2265

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2266

#

2267

# Operations can be global, regional or zonal.

2268

# - For global operations, use the `globalOperations` resource.

2269

# - For regional operations, use the `regionOperations` resource.

2270

# - For zonal operations, use the `zonalOperations` resource.

2271

#

2272

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

2273

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2274

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2275

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2276

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2277

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2278

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2279

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2280

"code": "A String", # [Output Only] The error type identifier for this error.

2281

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2282

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2283

},

2284

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2285

},

2286

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2287

"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.

2288

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2289

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2290

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2291

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2292

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

2293

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2294

"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.

2295

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2296

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2297

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2298

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2299

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2300

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2301

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2302

"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.

2303

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2304

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2305

{

2306

"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.

2307

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2308

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2309

{

2310

"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).

2311

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2312

},

2313

],

2314

"message": "A String", # [Output Only] A human-readable description of the warning code.

2315

},

2316

],

2317

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

}</pre>

</div>

<code class="details" id="resizeAdvanced">resizeAdvanced(project, region, instanceGroupManager, body=None, requestId=None)</code>

2323

<pre>Resizes the regional managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method.

2324

2325

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.

2326

2327

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 get or listmanagedinstances method.

2328

2329

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.

2330

2331

Args:

2332

project: string, Project ID for this request. (required)

2333

region: string, Name of the region scoping this request. It must be a string that meets the requirements in RFC1035. (required)

2334

instanceGroupManager: string, The name of the managed instance group. It must be a string that meets the requirements in RFC1035. (required)

2335

body: object, The request body.

2336

The object takes the form of:

2337

2338

{

2339

"noCreationRetries": True or False, # If this flag is true, the managed instance group attempts to create all instances initiated by this resize request only once. If there is an error during creation, the managed instance group does not retry create this instance, and we will decrease the targetSize of the request instead. If the flag is false, the group attempts to recreate each instance continuously until it succeeds.

2340

#

2341

# This flag matters only in the first attempt of creation of an instance. After an instance is successfully created while this flag is enabled, the instance behaves the same way as all the other instances created with a regular resize request. In particular, if a running instance dies unexpectedly at a later time and needs to be recreated, this mode does not affect the recreation behavior in that scenario.

2342

#

2343

# This flag is applicable only to the current resize request. It does not influence other resize requests in any way.

2344

#

2345

# You can see which instances ar being created in which mode by calling the get or listManagedInstances API.

2346

"targetSize": 42, # The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter.

2347

}

2348

2349

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.

2350

2351

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.

2352

2353

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

2354

2355

Returns:

2356

An object of the form:

2357

2358

{ # Represents an Operation resource.

2359

#

2360

# Google Compute Engine has three Operation resources:

2361

#

2362

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2363

#

2364

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2365

#

2366

# Operations can be global, regional or zonal.

2367

# - For global operations, use the `globalOperations` resource.

2368

# - For regional operations, use the `regionOperations` resource.

2369

# - For zonal operations, use the `zonalOperations` resource.

2370

#

2371

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

2372

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2373

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2374

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2375

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2376

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2377

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

2378

{

2379

"code": "A String", # [Output Only] The error type identifier for this error.

2380

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2381

"message": "A String", # [Output Only] An optional, human-readable error message.

},

],

},

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2386

"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.

2387

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2388

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2389

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2390

"name": "A String", # [Output Only] Name of the operation.

2391

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2392

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2393

"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.

2394

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2395

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2396

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2397

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2398

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2399

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2400

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2401

"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.

2402

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2403

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2404

{

2405

"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.

2406

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2407

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2408

{

2409

"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).

2410

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2411

},

2412

],

2413

"message": "A String", # [Output Only] A human-readable description of the warning code.

2414

},

2415

],

2416

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

2417

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2421

<code class="details" id="resumeInstances">resumeInstances(project, region, instanceGroupManager, body=None, requestId=None)</code>

2422

<pre>Flags the specified instances in the managed instance group to be resumed. This method increases the targetSize and decreases the targetSuspendedSize of the managed instance group by the number of instances that you resume. The resumeInstances operation is marked DONE if the resumeInstances request is successful. The underlying actions take additional time. You must separately verify the status of the RESUMING action with the listmanagedinstances method.

2423

2424

In this request, you can only specify instances that are suspended. For example, if an instance was previously suspended using the suspendInstances method, it can be resumed using the resumeInstances method.

2425

2426

If a health check is attached to the managed instance group, the specified instances will be verified as healthy after they are resumed.

2427

2428

You can specify a maximum of 1000 instances with this method per request.

2429

2430

Args:

2431

project: string, Project ID for this request. (required)

2432

region: string, Name of the region scoping this request. (required)

2433

instanceGroupManager: string, Name of the managed instance group. (required)

2434

body: object, The request body.

2435

The object takes the form of:

2436

2437

{

2438

"instances": [ # The URLs of one or more instances to resume. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].

"A String",

],

}

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

2444

2445

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.

2446

2447

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

2448

2449

Returns:

2450

An object of the form:

2451

2452

{ # Represents an Operation resource.

2453

#

2454

# Google Compute Engine has three Operation resources:

2455

#

2456

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2457

#

2458

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2459

#

2460

# Operations can be global, regional or zonal.

2461

# - For global operations, use the `globalOperations` resource.

2462

# - For regional operations, use the `regionOperations` resource.

2463

# - For zonal operations, use the `zonalOperations` resource.

2464

#

2465

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

2466

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2467

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2468

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2469

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2470

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2471

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

2472

{

2473

"code": "A String", # [Output Only] The error type identifier for this error.

2474

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2475

"message": "A String", # [Output Only] An optional, human-readable error message.

},

],

},

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2480

"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.

2481

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2482

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2483

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2484

"name": "A String", # [Output Only] Name of the operation.

2485

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

2486

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2487

"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.

2488

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2489

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2490

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2491

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2492

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2493

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2494

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2495

"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.

2496

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2497

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2498

{

2499

"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.

2500

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2501

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2502

{

2503

"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).

2504

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2505

},

2506

],

2507

"message": "A String", # [Output Only] A human-readable description of the warning code.

2508

},

2509

],

2510

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2515

<code class="details" id="setAutoHealingPolicies">setAutoHealingPolicies(project, region, instanceGroupManager, body=None, requestId=None)</code>

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2516

<pre>Modifies the autohealing policy for the instances in this managed instance group. [Deprecated] This method is deprecated. Use regionInstanceGroupManagers.patch instead.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2517

2518

Args:

2519

project: string, Project ID for this request. (required)

2520

region: string, Name of the region scoping this request. (required)

2521

instanceGroupManager: string, Name of the managed instance group. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2522

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2523

The object takes the form of:

2524

2525

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2526

"autoHealingPolicies": [

2527

{

2528

"healthCheck": "A String", # The URL for the health check that signals autohealing.

2529

"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].

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

2530

"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 if necessary. 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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2531

#

2532

# 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.

2533

"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]

2534

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2535

#

2536

# - If the value is fixed, then the calculated value is equal to the fixed value.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

2537

# - 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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2538

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

2539

"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]

2540

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2541

},

2542

],

2543

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2544

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2545

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.

2546

2547

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.

2548

2549

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]

2550

2551

Returns:

2552

An object of the form:

2553

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2554

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2555

#

2556

# Google Compute Engine has three Operation resources:

2557

#

2558

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2559

#

2560

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2561

#

2562

# Operations can be global, regional or zonal.

2563

# - For global operations, use the `globalOperations` resource.

2564

# - For regional operations, use the `regionOperations` resource.

2565

# - For zonal operations, use the `zonalOperations` resource.

2566

#

2567

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

2568

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2569

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2570

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2571

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2572

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2573

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2574

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2575

"code": "A String", # [Output Only] The error type identifier for this error.

2576

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2577

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2578

},

2579

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2580

},

2581

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2582

"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.

2583

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2584

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2585

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2586

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2587

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2588

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2589

"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.

2590

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2591

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2592

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2593

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2594

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2595

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2596

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2597

"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.

2598

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2599

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2600

{

2601

"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.

2602

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2603

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2604

{

2605

"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).

2606

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2607

},

2608

],

2609

"message": "A String", # [Output Only] A human-readable description of the warning code.

2610

},

2611

],

2612

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

2613

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2617

<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]

2618

<pre>Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected.

2619

2620

Args:

2621

project: string, Project ID for this request. (required)

2622

region: string, Name of the region scoping this request. (required)

2623

instanceGroupManager: string, The name of the managed instance group. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2624

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2625

The object takes the form of:

2626

2627

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2628

"instanceTemplate": "A String", # URL of the InstanceTemplate resource from which all new instances will be created.

2629

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2630

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2631

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.

2632

2633

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.

2634

2635

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]

2636

2637

Returns:

2638

An object of the form:

2639

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2640

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2641

#

2642

# Google Compute Engine has three Operation resources:

2643

#

2644

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2645

#

2646

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2647

#

2648

# Operations can be global, regional or zonal.

2649

# - For global operations, use the `globalOperations` resource.

2650

# - For regional operations, use the `regionOperations` resource.

2651

# - For zonal operations, use the `zonalOperations` resource.

2652

#

2653

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

2654

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2655

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2656

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2657

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2658

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2659

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2660

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2661

"code": "A String", # [Output Only] The error type identifier for this error.

2662

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2663

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2664

},

2665

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2666

},

2667

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2668

"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.

2669

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2670

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2671

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2672

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2673

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2674

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2675

"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.

2676

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2677

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2678

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2679

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2680

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2681

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2682

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2683

"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.

2684

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2685

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2686

{

2687

"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.

2688

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2689

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2690

{

2691

"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).

2692

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2693

},

2694

],

2695

"message": "A String", # [Output Only] A human-readable description of the warning code.

2696

},

2697

],

2698

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

2699

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2703

<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]

2704

<pre>Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.

2705

2706

Args:

2707

project: string, Project ID for this request. (required)

2708

region: string, Name of the region scoping this request. (required)

2709

instanceGroupManager: string, Name of the managed instance group. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2710

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2711

The object takes the form of:

2712

2713

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2714

"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.

2715

"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.

2716

"A String",

2717

],

2718

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2719

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2720

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.

2721

2722

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.

2723

2724

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]

2725

2726

Returns:

2727

An object of the form:

2728

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2729

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2730

#

2731

# Google Compute Engine has three Operation resources:

2732

#

2733

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2734

#

2735

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2736

#

2737

# Operations can be global, regional or zonal.

2738

# - For global operations, use the `globalOperations` resource.

2739

# - For regional operations, use the `regionOperations` resource.

2740

# - For zonal operations, use the `zonalOperations` resource.

2741

#

2742

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

2743

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2744

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2745

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2746

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2747

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2748

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2749

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2750

"code": "A String", # [Output Only] The error type identifier for this error.

2751

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2752

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2753

},

2754

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2755

},

2756

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2757

"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.

2758

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2759

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2760

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2761

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2762

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2763

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2764

"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.

2765

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2766

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2767

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2768

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2769

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2770

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2771

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2772

"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.

2773

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2774

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2775

{

2776

"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.

2777

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2778

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2779

{

2780

"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).

2781

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2782

},

2783

],

2784

"message": "A String", # [Output Only] A human-readable description of the warning code.

2785

},

2786

],

2787

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

2788

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2792

<code class="details" id="startInstances">startInstances(project, region, instanceGroupManager, body=None, requestId=None)</code>

2793

<pre>Flags the specified instances in the managed instance group to be started. This method increases the targetSize and decreases the targetStoppedSize of the managed instance group by the number of instances that you start. The startInstances operation is marked DONE if the startInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STARTING action with the listmanagedinstances method.

2794

2795

In this request, you can only specify instances that are stopped. For example, if an instance was previously stopped using the stopInstances method, it can be started using the startInstances method.

2796

2797

If a health check is attached to the managed instance group, the specified instances will be verified as healthy after they are started.

2798

2799

You can specify a maximum of 1000 instances with this method per request.

2800

2801

Args:

2802

project: string, Project ID for this request. (required)

2803

region: string, Name of the region scoping this request. (required)

2804

instanceGroupManager: string, Name of the managed instance group. (required)

2805

body: object, The request body.

2806

The object takes the form of:

2807

2808

{

2809

"instances": [ # The URLs of one or more instances to start. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].

"A String",

],

}

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

2815

2816

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.

2817

2818

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

2819

2820

Returns:

2821

An object of the form:

2822

2823

{ # Represents an Operation resource.

2824

#

2825

# Google Compute Engine has three Operation resources:

2826

#

2827

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2828

#

2829

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2830

#

2831

# Operations can be global, regional or zonal.

2832

# - For global operations, use the `globalOperations` resource.

2833

# - For regional operations, use the `regionOperations` resource.

2834

# - For zonal operations, use the `zonalOperations` resource.

2835

#

2836

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

2837

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2838

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2839

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2840

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2841

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2842

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

2843

{

2844

"code": "A String", # [Output Only] The error type identifier for this error.

2845

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2846

"message": "A String", # [Output Only] An optional, human-readable error message.

},

],

},

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2851

"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.

2852

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2853

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2854

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2855

"name": "A String", # [Output Only] Name of the operation.

2856

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

2857

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2858

"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.

2859

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2860

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2861

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2862

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2863

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2864

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2865

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2866

"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.

2867

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2868

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2869

{

2870

"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.

2871

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2872

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2873

{

2874

"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).

2875

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2876

},

2877

],

2878

"message": "A String", # [Output Only] A human-readable description of the warning code.

2879

},

2880

],

2881

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

}</pre>

</div>

<code class="details" id="stopInstances">stopInstances(project, region, instanceGroupManager, body=None, requestId=None)</code>

2887

<pre>Flags the specified instances in the managed instance group to be immediately stopped. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetStoppedSize of the managed instance group by the number of instances that you stop. The stopInstances operation is marked DONE if the stopInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STOPPING action with the listmanagedinstances method.

2888

2889

If the instanceLifecyclePolicy.metadataBasedReadinessSignal field is set on the Instance Group Manager, each instance will be initialized before it is stopped, to give user programs time to perform necessary tasks. To initialize an instance, the Instance Group Manager sets the metadata key google-compute-initialization-intent to value INITIALIZE_AND_STOP on the instance, and waits for the user program to signal it is ready. This is done by setting the guest attribute path google-compute/initialization-state to value INITIALIZED. If the instance does not signal successful initialization (does not set the guest attribute to INITIALIZED) before timeout, the initialization is considered failed and the instance is not stopped.

2890

2891

If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is suspended.

2892

2893

Stopped instances can be started using the startInstances method.

2894

2895

You can specify a maximum of 1000 instances with this method per request.

2896

2897

Args:

2898

project: string, Project ID for this request. (required)

2899

region: string, Name of the region scoping this request. (required)

2900

instanceGroupManager: string, The name of the managed instance group. (required)

2901

body: object, The request body.

2902

The object takes the form of:

2903

2904

{

2905

"forceStop": True or False, # If this flag is set to true, the Instance Group Manager will proceed to stop the instances, skipping initialization on them.

2906

"instances": [ # The URLs of one or more instances to stop. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].

"A String",

],

}

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

2912

2913

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.

2914

2915

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

2916

2917

Returns:

2918

An object of the form:

2919

2920

{ # Represents an Operation resource.

2921

#

2922

# Google Compute Engine has three Operation resources:

2923

#

2924

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2925

#

2926

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2927

#

2928

# Operations can be global, regional or zonal.

2929

# - For global operations, use the `globalOperations` resource.

2930

# - For regional operations, use the `regionOperations` resource.

2931

# - For zonal operations, use the `zonalOperations` resource.

2932

#

2933

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

2934

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2935

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2936

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2937

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2938

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2939

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

2940

{

2941

"code": "A String", # [Output Only] The error type identifier for this error.

2942

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2943

"message": "A String", # [Output Only] An optional, human-readable error message.

},

],

},

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2948

"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.

2949

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2950

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2951

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2952

"name": "A String", # [Output Only] Name of the operation.

2953

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

2954

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2955

"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.

2956

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2957

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2958

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2959

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2960

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2961

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2962

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2963

"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.

2964

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2965

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2966

{

2967

"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.

2968

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2969

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2970

{

2971

"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).

2972

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2973

},

2974

],

2975

"message": "A String", # [Output Only] A human-readable description of the warning code.

2976

},

2977

],

2978

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

}</pre>

</div>

<code class="details" id="suspendInstances">suspendInstances(project, region, instanceGroupManager, body=None, requestId=None)</code>

2984

<pre>Flags the specified instances in the managed instance group to be immediately suspended. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetSuspendedSize of the managed instance group by the number of instances that you suspend. The suspendInstances operation is marked DONE if the suspendInstances request is successful. The underlying actions take additional time. You must separately verify the status of the SUSPENDING action with the listmanagedinstances method.

2985

2986

If the instanceLifecyclePolicy.metadataBasedReadinessSignal field is set on the Instance Group Manager, each instance will be initialized before it is suspended, to give user programs time to perform necessary tasks. To initialize an instance, the Instance Group Manager sets the metadata key google-compute-initialization-intent to value INITIALIZE_AND_SUSPEND on the instance, and waits for the user program to signal it is ready. This is done by setting the guest attribute path google-compute/initialization-state to value INITIALIZED. If the instance does not signal successful initialization (does not set the guest attribute to INITIALIZED) before timeout, the initialization is considered failed and the instance is not suspended.

2987

2988

If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is suspended.

2989

2990

Suspended instances can be resumed using the resumeInstances method.

2991

2992

You can specify a maximum of 1000 instances with this method per request.

2993

2994

Args:

2995

project: string, Project ID for this request. (required)

2996

region: string, Name of the region scoping this request. (required)

2997

instanceGroupManager: string, Name of the managed instance group. (required)

2998

body: object, The request body.

2999

The object takes the form of:

3000

3001

{

3002

"forceSuspend": True or False, # If this flag is set to true, the Instance Group Manager will proceed to suspend the instances, skipping initialization on them.

3003

"instances": [ # The URLs of one or more instances to suspend. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].

"A String",

],

}

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

3009

3010

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.

3011

3012

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

3013

3014

Returns:

3015

An object of the form:

3016

3017

{ # Represents an Operation resource.

3018

#

3019

# Google Compute Engine has three Operation resources:

3020

#

3021

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

3022

#

3023

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

3024

#

3025

# Operations can be global, regional or zonal.

3026

# - For global operations, use the `globalOperations` resource.

3027

# - For regional operations, use the `regionOperations` resource.

3028

# - For zonal operations, use the `zonalOperations` resource.

3029

#

3030

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

3031

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3032

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3033

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3034

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3035

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3036

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

3037

{

3038

"code": "A String", # [Output Only] The error type identifier for this error.

3039

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3040

"message": "A String", # [Output Only] An optional, human-readable error message.

},

],

},

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3045

"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.

3046

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3047

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3048

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

3049

"name": "A String", # [Output Only] Name of the operation.

3050

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

3051

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3052

"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.

3053

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3054

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3055

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

3056

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3057

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3058

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3059

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3060

"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.

3061

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3062

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3063

{

3064

"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.

3065

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

3066

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

3067

{

3068

"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).

3069

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3070

},

3071

],

3072

"message": "A String", # [Output Only] A human-readable description of the warning code.

3073

},

3074

],

3075

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3080

<code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3081

<pre>Returns permissions that a caller has on the specified resource.

3082

3083

Args:

3084

project: string, Project ID for this request. (required)

3085

region: string, The name of the region for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3086

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3087

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3088

The object takes the form of:

3089

3090

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3091

"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.

3092

"A String",

3093

],

3094

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

Returns:

An object of the form:

3099

3100

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3101

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.

3102

"A String",

3103

],

3104

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3108

<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]

3109

<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.

3110

3111

Args:

3112

project: string, Project ID for this request. (required)

3113

region: string, Name of the region scoping this request. (required)

3114

instanceGroupManager: string, The name of the instance group manager. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3115

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3116

The object takes the form of:

3117

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

3118

{ # Whether the instance is a standby. Properties of a standby instance comparing to the regular instance: ========================================================================= | regular | standby ========================================================================= managed by IGM? | yes | yes added to the IG? | yes | yes counts towards IGM's target size? | yes | no taken into account by Autoscaler? | yes | no receives traffic from LB? | yes | no =========================================================================

3119

#

3120

# Represents a Managed Instance Group resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3121

#

3122

# An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups.

3123

#

3124

# For zonal Managed Instance Group, use the instanceGroupManagers resource.

3125

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3126

# 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]

3127

"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]

3128

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3129

"healthCheck": "A String", # The URL for the health check that signals autohealing.

3130

"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].

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

3131

"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 if necessary. 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]

3132

#

3133

# 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]

3134

"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]

3135

#

3136

#

3137

# - If the value is fixed, then the calculated value is equal to the fixed value.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

3138

# - 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3139

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

3140

"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]

3141

},

3142

},

3143

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3144

"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.

3145

"creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.

3146

"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.

3147

"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.

3148

"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]

3149

#

3150

# 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]

3151

"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.

3152

"deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.

3153

"none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.

3154

"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.

3155

"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.

3156

"restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

3157

"resuming": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be resumed or are currently being resumed.

3158

"starting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be started or are currently being started.

3159

"stopping": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be stopped or are currently being stopped.

3160

"suspending": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be suspended or are currently being suspended.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3161

"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]

3162

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3163

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3164

"distributionPolicy": { # Policy specifying the intended distribution of managed instances across zones in a regional managed instance group.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3165

"targetShape": "A String", # The distribution shape to which the group converges either proactively or on resize events (depending on the value set in updatePolicy.instanceRedistributionType).

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3166

"zones": [ # Zones where the regional managed instance group will create and manage its instances.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

3167

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3168

"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]

3169

},

3170

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3171

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3172

"failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.

3173

"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.

3174

#

3175

# To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.

3176

"id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.

3177

"instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

3178

"instanceLifecyclePolicy": { # Instance lifecycle policy for this Instance Group Manager.

3179

"metadataBasedReadinessSignal": { # The configuration for metadata based readiness signal sent by the instance during initialization when stopping / suspending an instance. The Instance Group Manager will wait for a signal that indicates successful initialization before stopping / suspending an instance.

3180

#

3181

# If a successful readiness signal is not sent before timeout, the corresponding instance will not be stopped / suspended. Instead, an error will be visible in the lastAttempt.errors field of the managed instance in the listmanagedinstances method.

3182

#

3183

# If metadataBasedReadinessSignal.timeoutSec is unset, the Instance Group Manager will directly proceed to suspend / stop instances, skipping initialization on them.

3184

"timeoutSec": 42, # The number of seconds to wait for a readiness signal during initialization before timing out.

3185

},

3186

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3187

"instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3188

"kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.

3189

"name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.

3190

"namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.

3191

{ # The named port. For example: .

3192

"name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.

3193

"port": 42, # The port number, which can be a value between 1 and 65535.

3194

},

3195

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3196

"region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).

3197

"selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.

3198

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

3199

"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.

3200

"statefulPolicy": { # Stateful configuration for this Instanced Group Manager

3201

"preservedState": { # Configuration of preserved resources.

3202

"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.

3203

"a_key": {

3204

"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]

3205

},

3206

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3207

"externalIPs": { # External network IPs assigned to the instances that will be preserved on instance delete, update, etc. This map is keyed with the network interface name.

3208

"a_key": {

3209

"autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted.

3210

},

3211

},

3212

"internalIPs": { # Internal network IPs assigned to the instances that will be preserved on instance delete, update, etc. This map is keyed with the network interface name.

3213

"a_key": {

3214

"autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted.

3215

},

3216

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3217

},

3218

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3219

"status": { # [Output Only] The status of this managed instance group.

3220

"autoscaler": "A String", # [Output Only] The URL of the Autoscaler that targets this instance group manager.

3221

"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.

3222

"stateful": { # [Output Only] Stateful status of the given Instance Group Manager.

3223

"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.

3224

"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]

3225

"perInstanceConfigs": { # [Output Only] Status of per-instance configs on the instance.

3226

"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.

3227

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3228

},

3229

"versionTarget": { # [Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager.

3230

"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.

3231

},

3232

},

3233

"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.

3234

"A String",

3235

],

3236

"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.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

3237

"targetStoppedSize": 42, # The target number of stopped instances for this managed instance group. This number changes when you:

3238

# - Stop instance using the stopInstances method or start instances using the startInstances method.

3239

# - Manually change the targetStoppedSize using the update method.

3240

"targetSuspendedSize": 42, # The target number of suspended instances for this managed instance group. This number changes when you:

3241

# - Suspend instance using the suspendInstances method or resume instances using the resumeInstances method.

3242

# - Manually change the targetSuspendedSize using the update method.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3243

"updatePolicy": { # The update policy for this managed instance group.

3244

"instanceRedistributionType": "A String", # The instance redistribution policy for regional managed instance groups. Valid values are:

3245

# - PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region.

3246

# - NONE: For non-autoscaled groups, proactive redistribution is disabled.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

3247

"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. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxSurge is a fixed value equal to the number of zones in which the managed instance group operates.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3248

#

3249

# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge.

3250

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

3251

#

3252

#

3253

# - If the value is fixed, then the calculated value is equal to the fixed value.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

3254

# - 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3255

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

3256

"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

3257

},

3258

"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:

3259

#

3260

#

3261

# - The instance's status is RUNNING.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

3262

# - If there is a health check on the instance group, the instance's health check status must be HEALTHY at least once. If there is no health check on the group, then the instance only needs to have a status of RUNNING to be considered available. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxUnavailable is a fixed value equal to the number of zones in which the managed instance group operates.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3263

#

3264

# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable.

3265

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

3266

#

3267

#

3268

# - If the value is fixed, then the calculated value is equal to the fixed value.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

3269

# - 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3270

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

3271

"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

3272

},

3273

"minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].

3274

"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.

Yoshi Automation Bot

0d561ef

2020-11-25 07:50:41 -0800

[diff] [blame]

3275

"mostDisruptiveAllowedAction": "A String", # Most disruptive action that is allowed to be taken on an instance. You can specify either NONE to forbid any actions, REFRESH to allow actions that do not need instance restart, RESTART to allow actions that can be applied without instance replacing or REPLACE to allow all possible actions. If the Updater determines that the minimal update action needed is more disruptive than most disruptive allowed action you specify it will not perform the update at all.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3276

"replacementMethod": "A String", # What action should be used to replace instances. See minimal_action.REPLACE

3277

"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).

3278

},

3279

"versions": [ # Specifies the instance templates used by this managed instance group to create instances.

3280

#

3281

# 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.

3282

{

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3283

"instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create new instances in the managed instance group until the `targetSize` for this version is reached. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE; in those cases, existing instances are updated until the `targetSize` for this version is reached.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3284

"name": "A String", # Name of the version. Unique among all versions in the scope of this managed instance group.

3285

"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'.

3286

"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:

3287

# - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

3288

# - if expressed as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) If there is a remainder, the number is rounded. If unset, this version will update any remaining instances not updated by another version. Read Starting a canary update for more information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3289

"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.

3290

#

3291

#

3292

# - If the value is fixed, then the calculated value is equal to the fixed value.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

3293

# - 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3294

"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.

3295

"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

3296

},

3297

},

3298

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3299

"zone": "A String", # [Output Only] The URL of a zone where the managed instance group is located (for zonal resources).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3300

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3301

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3302

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.

3303

3304

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.

3305

3306

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]

3307

3308

Returns:

3309

An object of the form:

3310

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3311

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3312

#

3313

# Google Compute Engine has three Operation resources:

3314

#

3315

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

3316

#

3317

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

3318

#

3319

# Operations can be global, regional or zonal.

3320

# - For global operations, use the `globalOperations` resource.

3321

# - For regional operations, use the `regionOperations` resource.

3322

# - For zonal operations, use the `zonalOperations` resource.

3323

#

3324

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

3325

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3326

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3327

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3328

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3329

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3330

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3331

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3332

"code": "A String", # [Output Only] The error type identifier for this error.

3333

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3334

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3335

},

3336

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3337

},

3338

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3339

"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.

3340

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3341

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3342

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3343

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3344

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3345

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3346

"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.

3347

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3348

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3349

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

3350

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3351

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3352

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3353

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3354

"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.

3355

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3356

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3357

{

3358

"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.

3359

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

3360

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

3361

{

3362

"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).

3363

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3364

},

3365

],

3366

"message": "A String", # [Output Only] A human-readable description of the warning code.

3367

},

3368

],

3369

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

3370

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3374

<code class="details" id="updatePerInstanceConfigs">updatePerInstanceConfigs(project, region, instanceGroupManager, body=None, requestId=None)</code>

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3375

<pre>Inserts or updates per-instance configs for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3376

3377

Args:

3378

project: string, Project ID for this request. (required)

3379

region: string, Name of the region scoping this request, should conform to RFC1035. (required)

3380

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]

3381

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3382

The object takes the form of:

3383

3384

{ # RegionInstanceGroupManagers.updatePerInstanceConfigs

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3385

"perInstanceConfigs": [ # The list of per-instance configs to insert or patch on this managed instance group.

3386

{

3387

"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.

3388

"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.

3389

"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.

3390

"disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks.

3391

"a_key": {

3392

"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.

3393

"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.

3394

"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]

3395

},

3396

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3397

"externalIPs": { # Preserved external IPs defined for this instance. This map is keyed with the name of the network interface.

3398

"a_key": {

3399

"autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted.

3400

"ipAddress": { # Ip address representation

3401

"address": "A String", # The URL of the reservation for this IP address.

3402

"literal": "A String", # An IPv4 internal network address to assign to the instance for this network interface.

},

},

},

"internalIPs": { # Preserved internal IPs defined for this instance. This map is keyed with the name of the network interface.

3407

"a_key": {

3408

"autoDelete": "A String", # These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted.

3409

"ipAddress": { # Ip address representation

3410

"address": "A String", # The URL of the reservation for this IP address.

3411

"literal": "A String", # An IPv4 internal network address to assign to the instance for this network interface.

3412

},

3413

},

3414

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3415

"metadata": { # Preserved metadata defined for this instance.

3416

"a_key": "A String",

3417

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3418

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3419

"status": "A String", # The status of applying this per-instance config on the corresponding managed instance.

3420

},

3421

],

3422

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3423

3424

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.

3425

3426

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.

3427

3428

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

3429

3430

Returns:

3431

An object of the form:

3432

3433

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3434

#

3435

# Google Compute Engine has three Operation resources:

3436

#

3437

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

3438

#

3439

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

3440

#

3441

# Operations can be global, regional or zonal.

3442

# - For global operations, use the `globalOperations` resource.

3443

# - For regional operations, use the `regionOperations` resource.

3444

# - For zonal operations, use the `zonalOperations` resource.

3445

#

3446

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

3447

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3448

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3449

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3450

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3451

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3452

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3453

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3454

"code": "A String", # [Output Only] The error type identifier for this error.

3455

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3456

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3457

},

3458

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3459

},

3460

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3461

"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.

3462

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3463

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3464

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3465

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3466

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot