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

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

[diff] [blame]

84

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

Bu Sun Kim

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

[diff] [blame]

85

<p class="firstline">Retrieves aggregated list of all of the instances in your project across all regions and zones.</p>

Sai Cheemalapati

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

[diff] [blame]

86

87

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

88

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

89

Dan O'Meara

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

[diff] [blame]

90

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

Sai Cheemalapati

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

[diff] [blame]

91

<p class="firstline">Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, read Adding a persistent disk to your instance.</p>

Sai Cheemalapati

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

[diff] [blame]

92

Dmitry Frenkel

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

[diff] [blame]

93

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

94

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

95

Bu Sun Kim

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

[diff] [blame]

96

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

Sai Cheemalapati

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

[diff] [blame]

97

<p class="firstline">Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance.</p>

98

Bu Sun Kim

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

[diff] [blame]

99

<code><a href="#deleteAccessConfig">deleteAccessConfig(project, zone, instance, accessConfig, networkInterface, requestId=None)</a></code></p>

Sai Cheemalapati

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

[diff] [blame]

100

<p class="firstline">Deletes an access config from an instance's network interface.</p>

101

Bu Sun Kim

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

[diff] [blame]

102

<code><a href="#detachDisk">detachDisk(project, zone, instance, deviceName, requestId=None)</a></code></p>

Sai Cheemalapati

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

[diff] [blame]

103

<p class="firstline">Detaches a disk from an instance.</p>

104

105

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

Bu Sun Kim

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

[diff] [blame]

106

<p class="firstline">Returns the specified Instance resource. Gets a list of available instances by making a list() request.</p>

107

Dan O'Meara

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

[diff] [blame]

108

<code><a href="#getEffectiveFirewalls">getEffectiveFirewalls(project, zone, instance, networkInterface)</a></code></p>

109

<p class="firstline">Returns effective firewalls applied to an interface of the instance.</p>

110

Bu Sun Kim

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

[diff] [blame]

111

<code><a href="#getGuestAttributes">getGuestAttributes(project, zone, instance, queryPath=None, variableKey=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

112

<p class="firstline">Returns the specified guest attributes entry.</p>

113

Dan O'Meara

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

[diff] [blame]

114

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

Bu Sun Kim

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

[diff] [blame]

115

<p class="firstline">Gets the access control policy for a resource. May be empty if no such policy or resource exists.</p>

Sai Cheemalapati

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

[diff] [blame]

116

Dan O'Meara

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

[diff] [blame]

117

<code><a href="#getScreenshot">getScreenshot(project, zone, instance)</a></code></p>

118

<p class="firstline">Returns the screenshot from the specified instance.</p>

119

Bu Sun Kim

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

[diff] [blame]

120

<code><a href="#getSerialPortOutput">getSerialPortOutput(project, zone, instance, port=None, start=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

121

<p class="firstline">Returns the last 1 MB of serial port output from the specified instance.</p>

Sai Cheemalapati

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

[diff] [blame]

122

Bu Sun Kim

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

[diff] [blame]

123

<code><a href="#getShieldedInstanceIdentity">getShieldedInstanceIdentity(project, zone, instance)</a></code></p>

124

<p class="firstline">Returns the Shielded Instance Identity of an instance</p>

125

126

<code><a href="#getShieldedVmIdentity">getShieldedVmIdentity(project, zone, instance)</a></code></p>

127

<p class="firstline">Returns the Shielded VM Identity of an instance</p>

128

Bu Sun Kim

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

[diff] [blame]

129

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

Sai Cheemalapati

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

[diff] [blame]

130

<p class="firstline">Creates an instance resource in the specified project using the data included in the request.</p>

131

Dmitry Frenkel

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

[diff] [blame]

132

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

Sai Cheemalapati

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

[diff] [blame]

133

<p class="firstline">Retrieves the list of instances contained within the specified zone.</p>

134

Dmitry Frenkel

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

[diff] [blame]

135

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

Bu Sun Kim

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

[diff] [blame]

136

<p class="firstline">Retrieves a list of resources that refer to the VM instance specified in the request. For example, if the VM instance is part of a managed or unmanaged instance group, the referrers list includes the instance group. For more information, read Viewing referrers to VM instances.</p>

Sai Cheemalapati

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

[diff] [blame]

137

138

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

139

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

140

Sai Cheemalapati

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

[diff] [blame]

141

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

142

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

143

Dan O'Meara

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

[diff] [blame]

144

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

145

<p class="firstline">Removes resource policies from an instance.</p>

146

Bu Sun Kim

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

[diff] [blame]

147

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

148

<p class="firstline">Performs a reset on the instance. This is a hard reset the VM does not do a graceful shutdown. For more information, see Resetting an instance.</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="#resume">resume(project, zone, instance, body=None, requestId=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

151

<p class="firstline">Resumes an instance that was suspended using the instances().suspend method.</p>

152

153

<code><a href="#setDeletionProtection">setDeletionProtection(project, zone, resource, deletionProtection=None, requestId=None)</a></code></p>

154

<p class="firstline">Sets deletion protection on the instance.</p>

155

156

<code><a href="#setDiskAutoDelete">setDiskAutoDelete(project, zone, instance, autoDelete, deviceName, requestId=None)</a></code></p>

Sai Cheemalapati

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

[diff] [blame]

157

<p class="firstline">Sets the auto-delete flag for a disk attached to an instance.</p>

158

Dan O'Meara

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

[diff] [blame]

159

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

Bu Sun Kim

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

[diff] [blame]

160

<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p>

Sai Cheemalapati

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

[diff] [blame]

161

Dan O'Meara

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

[diff] [blame]

162

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

Bu Sun Kim

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

[diff] [blame]

163

<p class="firstline">Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation.</p>

164

Dan O'Meara

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

[diff] [blame]

165

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

Sai Cheemalapati

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

[diff] [blame]

166

<p class="firstline">Changes the number and/or type of accelerator for a stopped instance to the values specified in the request.</p>

167

Dan O'Meara

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

[diff] [blame]

168

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

Sai Cheemalapati

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

[diff] [blame]

169

<p class="firstline">Changes the machine type for a stopped instance to the machine type specified in the request.</p>

170

Dan O'Meara

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

[diff] [blame]

171

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

Sai Cheemalapati

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

[diff] [blame]

172

<p class="firstline">Sets metadata for the specified instance to the data included in the request.</p>

173

Dan O'Meara

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

[diff] [blame]

174

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

Bu Sun Kim

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

[diff] [blame]

175

<p class="firstline">Changes the minimum CPU platform that this instance should use. This method can only be called on a stopped instance. For more information, read Specifying a Minimum CPU Platform.</p>

Sai Cheemalapati

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

[diff] [blame]

176

Dmitry Frenkel

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

[diff] [blame]

177

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

178

<p class="firstline">Sets name of an instance.</p>

179

Dan O'Meara

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

[diff] [blame]

180

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

Bu Sun Kim

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

[diff] [blame]

181

<p class="firstline">Sets an instance's scheduling options. You can only call this method on a stopped instance, that is, a VM instance that is in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.</p>

Sai Cheemalapati

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

[diff] [blame]

182

Dan O'Meara

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

[diff] [blame]

183

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

Sai Cheemalapati

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

[diff] [blame]

184

<p class="firstline">Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance.</p>

Jon Wayne Parrott

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

[diff] [blame]

185

Dan O'Meara

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

[diff] [blame]

186

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

Bu Sun Kim

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

[diff] [blame]

187

<p class="firstline">Sets the Shielded Instance integrity policy for an instance. You can only use this method on a running instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.</p>

Sai Cheemalapati

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

[diff] [blame]

188

Dan O'Meara

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

[diff] [blame]

189

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

Bu Sun Kim

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

[diff] [blame]

190

<p class="firstline">Sets the Shielded VM integrity policy for a VM instance. You can only use this method on a running VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.</p>

Sai Cheemalapati

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

[diff] [blame]

191

Dan O'Meara

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

[diff] [blame]

192

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

Bu Sun Kim

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

[diff] [blame]

193

<p class="firstline">Sets network tags for the specified instance to the data included in the request.</p>

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

<code><a href="#simulateMaintenanceEvent">simulateMaintenanceEvent(project, zone, instance)</a></code></p>

196

<p class="firstline">Simulates a maintenance event on the instance.</p>

197

198

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

199

<p class="firstline">Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.</p>

200

Dan O'Meara

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

[diff] [blame]

201

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

Bu Sun Kim

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

[diff] [blame]

202

<p class="firstline">Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.</p>

203

204

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

205

<p class="firstline">Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur VM usage charges while they are stopped. However, resources that the VM is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.</p>

206

207

<code><a href="#suspend">suspend(project, zone, instance, discardLocalSsd=None, requestId=None)</a></code></p>

208

<p class="firstline">This method suspends a running instance, saving its state to persistent storage, and allows you to resume the instance at a later time. Suspended instances incur reduced per-minute, virtual machine usage charges while they are suspended. Any resources the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted.</p>

Sai Cheemalapati

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

[diff] [blame]

209

Dan O'Meara

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

[diff] [blame]

210

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

Sai Cheemalapati

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

[diff] [blame]

211

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

Bu Sun Kim

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

[diff] [blame]

212

Bu Sun Kim

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

[diff] [blame]

213

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

Dan O'Meara

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

[diff] [blame]

214

<p class="firstline">Updates an instance only if the necessary resources are available. This method can update only a specific set of instance properties. See Updating a running instance for a list of updatable instance properties.</p>

215

216

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

Bu Sun Kim

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

[diff] [blame]

217

<p class="firstline">Updates the specified access config from an instance's network interface with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.</p>

218

Dan O'Meara

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

[diff] [blame]

219

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

Bu Sun Kim

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

[diff] [blame]

220

<p class="firstline">Updates the Display config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.</p>

221

Dan O'Meara

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

[diff] [blame]

222

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

Bu Sun Kim

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

[diff] [blame]

223

<p class="firstline">Updates an instance's network interface. This method follows PATCH semantics.</p>

224

Dan O'Meara

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

[diff] [blame]

225

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

Bu Sun Kim

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

[diff] [blame]

226

<p class="firstline">Updates the Shielded Instance config for an instance. You can only use this method on a stopped instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.</p>

227

Dan O'Meara

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

[diff] [blame]

228

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

Bu Sun Kim

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

[diff] [blame]

229

<p class="firstline">Updates the Shielded VM config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.</p>

Sai Cheemalapati

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

[diff] [blame]

230

<h3>Method Details</h3>

231

Dan O'Meara

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

[diff] [blame]

232

<code class="details" id="addAccessConfig">addAccessConfig(project, zone, instance, networkInterface, body=None, requestId=None)</code>

Bu Sun Kim

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

[diff] [blame]

233

<pre>Adds an access config to an instance's network interface.

Sai Cheemalapati

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

[diff] [blame]

234

235

Args:

236

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

237

zone: string, The name of the zone for this request. (required)

238

instance: string, The instance name for this request. (required)

239

networkInterface: string, The name of the network interface to add to this instance. (required)

Dan O'Meara

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

[diff] [blame]

240

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

241

The object takes the form of:

242

Bu Sun Kim

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

[diff] [blame]

243

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

244

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

245

"name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.

246

"natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.

247

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

Bu Sun Kim

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

[diff] [blame]

248

#

249

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

250

#

251

# If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.

Bu Sun Kim

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

[diff] [blame]

252

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

253

"setPublicPtr": True or False, # Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name.

254

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

Sai Cheemalapati

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

[diff] [blame]

255

}

256

Bu Sun Kim

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

[diff] [blame]

257

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.

258

259

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.

260

261

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]

262

263

Returns:

264

An object of the form:

265

Bu Sun Kim

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

[diff] [blame]

266

{ # Represents an Operation resource.

267

#

Dan O'Meara

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

[diff] [blame]

268

# Google Compute Engine has three Operation resources:

269

#

270

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

271

#

Bu Sun Kim

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

[diff] [blame]

272

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

273

#

274

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

275

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

276

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

277

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

Bu Sun Kim

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

[diff] [blame]

278

#

Dan O'Meara

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

[diff] [blame]

279

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

Bu Sun Kim

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

[diff] [blame]

280

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

281

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

282

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

283

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

284

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

285

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

Sai Cheemalapati

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

[diff] [blame]

286

{

Bu Sun Kim

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

[diff] [blame]

287

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

288

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

289

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

Sai Cheemalapati

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

[diff] [blame]

290

},

291

],

292

},

Bu Sun Kim

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

[diff] [blame]

293

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

294

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

295

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

296

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

297

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

298

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

299

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

300

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

301

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

302

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

303

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

304

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

305

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

306

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

307

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

308

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

309

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

310

{

311

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

312

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

313

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

314

{

315

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

316

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

317

},

318

],

319

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

320

},

321

],

322

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

327

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

328

<pre>Adds existing resource policies to an instance. You can only add one policy right now which will be applied to this instance for scheduling live migrations.

329

330

Args:

331

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

332

zone: string, The name of the zone for this request. (required)

333

instance: string, The instance name for this request. (required)

334

body: object, The request body.

335

The object takes the form of:

336

337

{

Bu Sun Kim

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

[diff] [blame]

338

"resourcePolicies": [ # Resource policies to be added to this instance.

339

"A String",

Dan O'Meara

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

[diff] [blame]

],

}

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

344

345

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.

346

347

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

348

349

Returns:

350

An object of the form:

351

352

{ # Represents an Operation resource.

353

#

354

# Google Compute Engine has three Operation resources:

355

#

356

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

357

#

358

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

359

#

360

# Operations can be global, regional or zonal.

361

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

362

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

363

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

364

#

365

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

Bu Sun Kim

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

[diff] [blame]

366

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

367

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

368

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

369

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

370

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

371

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

Dan O'Meara

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

[diff] [blame]

372

{

Bu Sun Kim

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

[diff] [blame]

373

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

374

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

375

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

Dan O'Meara

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

[diff] [blame]

376

},

377

],

378

},

Bu Sun Kim

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

[diff] [blame]

379

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

380

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

381

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

382

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

383

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

384

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

385

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

386

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

387

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

388

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

389

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

390

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

391

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

392

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

393

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

394

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

395

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

396

{

397

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

398

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

399

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

400

{

401

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

402

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

403

},

404

],

405

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

406

},

407

],

408

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

Dan O'Meara

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

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

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

[diff] [blame]

413

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

Bu Sun Kim

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

[diff] [blame]

414

<pre>Retrieves aggregated list of all of the instances in your project across all regions and zones.

Sai Cheemalapati

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

[diff] [blame]

415

416

Args:

417

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

Dan O'Meara

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

[diff] [blame]

418

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]

419

Dan O'Meara

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

[diff] [blame]

420

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]

421

Dan O'Meara

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

[diff] [blame]

422

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]

423

Bu Sun Kim

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

[diff] [blame]

424

To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```

Dan O'Meara

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

[diff] [blame]

425

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

Bu Sun Kim

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

[diff] [blame]

426

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

427

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

428

429

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.

430

431

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

432

pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

Dmitry Frenkel

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

[diff] [blame]

433

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

Sai Cheemalapati

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

[diff] [blame]

434

435

Returns:

436

An object of the form:

437

438

{

Bu Sun Kim

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

[diff] [blame]

439

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

440

"items": { # An object that contains a list of instances scoped by zone.

441

"a_key": { # [Output Only] Name of the scope containing this set of instances.

442

"instances": [ # [Output Only] A list of instances contained in this scope.

Bu Sun Kim

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

[diff] [blame]

443

{ # Represents an Instance resource.

444

#

Dan O'Meara

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

[diff] [blame]

445

# An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. (== resource_for {$api_version}.instances ==)

Bu Sun Kim

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

[diff] [blame]

446

"canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.

Bu Sun Kim

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

[diff] [blame]

447

"confidentialInstanceConfig": { # A set of Confidential Instance options.

448

"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.

449

},

Bu Sun Kim

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

[diff] [blame]

450

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

451

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

452

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

453

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

454

"disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.

Sai Cheemalapati

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

[diff] [blame]

455

{ # An instance-attached disk resource.

Bu Sun Kim

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

[diff] [blame]

456

"autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).

457

"boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

458

"deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.

459

#

460

# If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.

Dmitry Frenkel

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

[diff] [blame]

461

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.

Sai Cheemalapati

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

[diff] [blame]

462

#

463

# If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.

464

#

465

# If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.

466

#

467

# If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.

468

#

469

# Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.

Bu Sun Kim

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

[diff] [blame]

470

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

471

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

472

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

473

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

Sai Cheemalapati

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

[diff] [blame]

474

#

475

# The key must meet the following requirements before you can provide it to Compute Engine:

476

# - The key is wrapped using a RSA public key certificate provided by Google.

Bu Sun Kim

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

[diff] [blame]

477

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

Sai Cheemalapati

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

[diff] [blame]

478

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

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

[diff] [blame]

479

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Sai Cheemalapati

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

[diff] [blame]

480

},

Bu Sun Kim

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

[diff] [blame]

481

"diskSizeGb": "A String", # The size of the disk in GB.

482

"guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

483

{ # Guest OS features.

484

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

485

},

486

],

487

"index": 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.

488

"initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.

Sai Cheemalapati

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

[diff] [blame]

489

#

490

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

491

#

492

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

Bu Sun Kim

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

[diff] [blame]

493

"description": "A String", # An optional description. Provide this property when creating the disk.

494

"diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created.

495

"diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB.

496

"diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:

Sai Cheemalapati

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

[diff] [blame]

497

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

498

#

Bu Sun Kim

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

[diff] [blame]

499

#

Sai Cheemalapati

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

[diff] [blame]

500

# Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:

501

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType

502

# - projects/project/zones/zone/diskTypes/diskType

503

# - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.

Bu Sun Kim

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

[diff] [blame]

504

"guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

Bu Sun Kim

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

[diff] [blame]

505

#

506

# Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

507

{ # Guest OS features.

Bu Sun Kim

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

[diff] [blame]

508

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

Bu Sun Kim

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

[diff] [blame]

509

},

510

],

Bu Sun Kim

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

[diff] [blame]

511

"labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.

512

"a_key": "A String",

513

},

Bu Sun Kim

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

[diff] [blame]

514

"multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.

Bu Sun Kim

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

[diff] [blame]

515

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

516

"resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name.

517

"A String",

Bu Sun Kim

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

[diff] [blame]

518

],

Bu Sun Kim

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

[diff] [blame]

519

"sourceImage": "A String", # The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.

Sai Cheemalapati

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

[diff] [blame]

520

#

Bu Sun Kim

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

[diff] [blame]

521

# To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image:

522

# projects/debian-cloud/global/images/family/debian-9

Sai Cheemalapati

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

[diff] [blame]

523

#

Sai Cheemalapati

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

[diff] [blame]

524

#

525

# Alternatively, use a specific version of a public operating system image:

Bu Sun Kim

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

[diff] [blame]

526

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

Sai Cheemalapati

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

[diff] [blame]

527

#

Sai Cheemalapati

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

[diff] [blame]

528

#

Bu Sun Kim

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

[diff] [blame]

529

# To create a disk with a custom image that you created, specify the image name in the following format:

530

# global/images/my-custom-image

Sai Cheemalapati

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

[diff] [blame]

531

#

Sai Cheemalapati

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

[diff] [blame]

532

#

Bu Sun Kim

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

[diff] [blame]

533

# You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:

534

# global/images/family/my-image-family

Sai Cheemalapati

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

[diff] [blame]

535

#

Jon Wayne Parrott

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

[diff] [blame]

536

#

537

# If the source image is deleted later, this field will not be set.

Dmitry Frenkel

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

[diff] [blame]

538

"sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

Bu Sun Kim

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

[diff] [blame]

539

#

540

# Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.

541

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

542

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

543

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

544

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

Bu Sun Kim

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

[diff] [blame]

545

#

546

# The key must meet the following requirements before you can provide it to Compute Engine:

547

# - The key is wrapped using a RSA public key certificate provided by Google.

548

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

549

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

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

[diff] [blame]

550

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

551

},

552

"sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD.

553

#

554

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

555

# global/snapshots/my-backup

556

#

557

#

558

# If the source snapshot is deleted later, this field will not be set.

Dmitry Frenkel

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

[diff] [blame]

559

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

Bu Sun Kim

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

[diff] [blame]

560

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

561

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

562

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

563

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

564

#

565

# The key must meet the following requirements before you can provide it to Compute Engine:

566

# - The key is wrapped using a RSA public key certificate provided by Google.

567

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

568

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

569

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Bu Sun Kim

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

[diff] [blame]

570

},

Sai Cheemalapati

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

[diff] [blame]

571

},

Bu Sun Kim

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

[diff] [blame]

572

"interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.

573

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

574

"licenses": [ # [Output Only] Any valid publicly visible licenses.

575

"A String",

576

],

577

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

578

"shieldedInstanceInitialState": { # Initial State for shielded instance, these are public keys which are safe to store in public # [Output Only] shielded vm initial state stored on disk

579

"dbs": [ # The Key Database (db).

Dan O'Meara

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

[diff] [blame]

580

{

Bu Sun Kim

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

[diff] [blame]

581

"content": "A String", # The raw content in the secure keys file.

582

"fileType": "A String", # The file type of source file.

Dan O'Meara

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

[diff] [blame]

583

},

584

],

Bu Sun Kim

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

[diff] [blame]

585

"dbxs": [ # The forbidden key database (dbx).

Dan O'Meara

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

[diff] [blame]

586

{

Bu Sun Kim

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

[diff] [blame]

587

"content": "A String", # The raw content in the secure keys file.

588

"fileType": "A String", # The file type of source file.

Dan O'Meara

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

[diff] [blame]

589

},

590

],

Bu Sun Kim

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

[diff] [blame]

591

"keks": [ # The Key Exchange Key (KEK).

Dan O'Meara

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

[diff] [blame]

592

{

Bu Sun Kim

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

[diff] [blame]

593

"content": "A String", # The raw content in the secure keys file.

594

"fileType": "A String", # The file type of source file.

Dan O'Meara

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

[diff] [blame]

595

},

596

],

Bu Sun Kim

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

[diff] [blame]

597

"pk": { # The Platform Key (PK).

598

"content": "A String", # The raw content in the secure keys file.

599

"fileType": "A String", # The file type of source file.

Dan O'Meara

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

[diff] [blame]

600

},

601

},

Bu Sun Kim

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

[diff] [blame]

602

"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.

Jon Wayne Parrott

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

[diff] [blame]

603

#

604

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

605

#

606

# Note that for InstanceTemplate, specify the disk name, not the URL for the disk.

Bu Sun Kim

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

[diff] [blame]

607

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

Sai Cheemalapati

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

[diff] [blame]

608

},

609

],

Bu Sun Kim

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

[diff] [blame]

610

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

611

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

612

},

613

"eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.

614

"fingerprint": "A String", # Specifies a fingerprint for this resource, which is essentially a hash of the instance's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance. You must always provide an up-to-date fingerprint hash in order to update the instance.

615

#

616

# To see the latest fingerprint, make get() request to the instance.

617

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

618

{ # A specification of the type and number of accelerator cards attached to the instance.

619

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

620

"acceleratorType": "A String", # Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.

621

},

622

],

623

"hostname": "A String", # Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.

624

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

625

"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.

626

"labelFingerprint": "A String", # A fingerprint for this request, which is essentially a hash of the label's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.

627

#

628

# To see the latest fingerprint, make get() request to the instance.

629

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

630

"a_key": "A String",

631

},

Bu Sun Kim

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

[diff] [blame]

632

"lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format.

633

"lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format.

634

"lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format.

Bu Sun Kim

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

[diff] [blame]

635

"machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:

636

# zones/us-central1-f/machineTypes/n1-standard-1

637

#

638

#

639

# To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):

640

# zones/zone/machineTypes/custom-CPUS-MEMORY

641

#

642

#

643

# For example: zones/us-central1-f/machineTypes/custom-4-5120

644

#

645

# For a full list of restrictions, read the Specifications for custom machine types.

646

"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

647

"fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet.

648

#

649

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

650

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

651

{

652

"key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.

653

"value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).

654

},

655

],

656

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

657

},

658

"minCpuPlatform": "A String", # Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge".

659

"name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

660

"networkInterfaces": [ # An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance.

661

{ # A network interface resource attached to an instance.

662

"accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.

663

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

664

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

665

"name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.

666

"natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.

667

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

668

#

669

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

670

#

671

# If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.

672

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

673

"setPublicPtr": True or False, # Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name.

674

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

675

},

676

],

677

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

678

{ # An alias IP range attached to an instance's network interface.

679

"ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4), a netmask (such as /24) or a CIDR-formatted string (such as 10.1.2.0/24).

680

"subnetworkRangeName": "A String", # The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used.

681

},

682

],

683

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface, otherwise the request will fail with error 412 conditionNotMet.

684

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

685

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

686

"name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc.

687

"network": "A String", # URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred.

688

#

689

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

690

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

691

# - projects/project/global/networks/network

692

# - global/networks/default

693

"networkIP": "A String", # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.

694

"subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:

695

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

696

# - regions/region/subnetworks/subnetwork

697

},

698

],

699

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.

700

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.

701

"consumeReservationType": "A String", # Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples.

702

"key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value.

703

"values": [ # Corresponds to the label values of a reservation resource.

"A String",

],

},

"resourcePolicies": [ # Resource policies applied to this instance.

708

"A String",

709

],

Dmitry Frenkel

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

[diff] [blame]

710

"scheduling": { # Sets the scheduling options for an Instance. NextID: 13 # Sets the scheduling options for this instance.

Bu Sun Kim

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

[diff] [blame]

711

"automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.

712

#

713

# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

714

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

715

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

716

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

717

"key": "A String", # Corresponds to the label key of Node resource.

718

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

719

"values": [ # Corresponds to the label values of Node resource.

"A String",

],

},

],

"onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.

Bu Sun Kim

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

[diff] [blame]

725

"preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.

Bu Sun Kim

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

[diff] [blame]

726

},

727

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

728

"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

729

#

730

# Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.

731

{ # A service account.

732

"email": "A String", # Email address of the service account.

733

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

739

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

740

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

741

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

742

},

743

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

744

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

745

},

Dmitry Frenkel

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

[diff] [blame]

746

"shieldedVmConfig": { # A set of Shielded VM options. # Deprecating, please use shielded_instance_config.

Bu Sun Kim

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

[diff] [blame]

747

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

748

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

749

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

750

},

Dmitry Frenkel

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

[diff] [blame]

751

"shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured. # Deprecating, please use shielded_instance_integrity_policy.

Bu Sun Kim

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

[diff] [blame]

752

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

753

},

754

"sourceMachineImage": "A String", # Source machine image

Dmitry Frenkel

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

[diff] [blame]

755

"sourceMachineImageEncryptionKey": { # Source GMI encryption key when creating an instance from GMI.

Bu Sun Kim

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

[diff] [blame]

756

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

757

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

758

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

759

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

760

#

761

# The key must meet the following requirements before you can provide it to Compute Engine:

762

# - The key is wrapped using a RSA public key certificate provided by Google.

763

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

764

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

765

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

766

},

767

"startRestricted": True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.

Bu Sun Kim

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

[diff] [blame]

768

"status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.

Bu Sun Kim

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

[diff] [blame]

769

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

770

"tags": { # A set of instance tags. # Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the 'tags.items' field.

771

"fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the tags' contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags.

772

#

773

# To see the latest fingerprint, make get() request to the instance.

774

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

"A String",

],

},

"zone": "A String", # [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

Sai Cheemalapati

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

[diff] [blame]

779

},

780

],

Bu Sun Kim

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

[diff] [blame]

781

"warning": { # [Output Only] Informational warning which replaces the list of instances when the list is empty.

782

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

783

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

784

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

Sai Cheemalapati

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

[diff] [blame]

785

{

Bu Sun Kim

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

[diff] [blame]

786

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

787

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

Sai Cheemalapati

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

[diff] [blame]

788

},

789

],

Bu Sun Kim

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

[diff] [blame]

790

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

Sai Cheemalapati

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

[diff] [blame]

791

},

792

},

793

},

Bu Sun Kim

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

[diff] [blame]

794

"kind": "compute#instanceAggregatedList", # [Output Only] Type of resource. Always compute#instanceAggregatedList for aggregated lists of Instance resources.

795

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

796

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

Dmitry Frenkel

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

[diff] [blame]

797

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

798

"A String",

799

],

Bu Sun Kim

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

[diff] [blame]

800

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

801

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

802

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

803

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

Bu Sun Kim

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

[diff] [blame]

804

{

Bu Sun Kim

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

[diff] [blame]

805

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

806

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

807

},

808

],

Bu Sun Kim

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

[diff] [blame]

809

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

Bu Sun Kim

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

[diff] [blame]

810

},

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

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

816

<pre>Retrieves the next page of results.

817

818

Args:

819

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

820

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

821

822

Returns:

Bu Sun Kim

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

[diff] [blame]

823

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

Sai Cheemalapati

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

[diff] [blame]

824

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]

829

<code class="details" id="attachDisk">attachDisk(project, zone, instance, body=None, forceAttach=None, requestId=None)</code>

Sai Cheemalapati

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

[diff] [blame]

830

<pre>Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, read Adding a persistent disk to your instance.

Sai Cheemalapati

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

[diff] [blame]

831

832

Args:

833

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

834

zone: string, The name of the zone for this request. (required)

835

instance: string, The instance name for this request. (required)

Dan O'Meara

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

[diff] [blame]

836

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

837

The object takes the form of:

838

839

{ # An instance-attached disk resource.

Bu Sun Kim

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

[diff] [blame]

840

"autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).

841

"boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

842

"deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.

843

#

844

# If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.

Dmitry Frenkel

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

[diff] [blame]

845

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.

Sai Cheemalapati

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

[diff] [blame]

846

#

847

# If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.

848

#

849

# If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.

850

#

851

# If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.

852

#

853

# Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.

Bu Sun Kim

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

[diff] [blame]

854

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

855

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

856

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

857

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

Sai Cheemalapati

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

[diff] [blame]

858

#

859

# The key must meet the following requirements before you can provide it to Compute Engine:

860

# - The key is wrapped using a RSA public key certificate provided by Google.

Bu Sun Kim

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

[diff] [blame]

861

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

Sai Cheemalapati

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

[diff] [blame]

862

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

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

[diff] [blame]

863

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Sai Cheemalapati

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

[diff] [blame]

864

},

Bu Sun Kim

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

[diff] [blame]

865

"diskSizeGb": "A String", # The size of the disk in GB.

866

"guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

867

{ # Guest OS features.

868

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

869

},

870

],

871

"index": 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.

872

"initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.

Sai Cheemalapati

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

[diff] [blame]

873

#

874

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

875

#

876

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

Bu Sun Kim

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

[diff] [blame]

877

"description": "A String", # An optional description. Provide this property when creating the disk.

878

"diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created.

879

"diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB.

880

"diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:

Sai Cheemalapati

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

[diff] [blame]

881

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

882

#

Bu Sun Kim

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

[diff] [blame]

883

#

Sai Cheemalapati

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

[diff] [blame]

884

# Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:

885

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType

886

# - projects/project/zones/zone/diskTypes/diskType

887

# - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.

Bu Sun Kim

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

[diff] [blame]

888

"guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

Bu Sun Kim

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

[diff] [blame]

889

#

890

# Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

891

{ # Guest OS features.

Bu Sun Kim

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

[diff] [blame]

892

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

Bu Sun Kim

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

[diff] [blame]

893

},

894

],

Bu Sun Kim

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

[diff] [blame]

895

"labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.

896

"a_key": "A String",

897

},

Bu Sun Kim

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

[diff] [blame]

898

"multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.

Bu Sun Kim

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

[diff] [blame]

899

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

900

"resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name.

901

"A String",

Bu Sun Kim

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

[diff] [blame]

902

],

Bu Sun Kim

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

[diff] [blame]

903

"sourceImage": "A String", # The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.

Sai Cheemalapati

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

[diff] [blame]

904

#

Bu Sun Kim

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

[diff] [blame]

905

# To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image:

906

# projects/debian-cloud/global/images/family/debian-9

Sai Cheemalapati

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

[diff] [blame]

907

#

Sai Cheemalapati

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

[diff] [blame]

908

#

909

# Alternatively, use a specific version of a public operating system image:

Bu Sun Kim

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

[diff] [blame]

910

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

Sai Cheemalapati

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

[diff] [blame]

911

#

Sai Cheemalapati

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

[diff] [blame]

912

#

Bu Sun Kim

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

[diff] [blame]

913

# To create a disk with a custom image that you created, specify the image name in the following format:

914

# global/images/my-custom-image

Sai Cheemalapati

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

[diff] [blame]

915

#

Sai Cheemalapati

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

[diff] [blame]

916

#

Bu Sun Kim

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

[diff] [blame]

917

# You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:

918

# global/images/family/my-image-family

Sai Cheemalapati

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

[diff] [blame]

919

#

Jon Wayne Parrott

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

[diff] [blame]

920

#

921

# If the source image is deleted later, this field will not be set.

Dmitry Frenkel

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

[diff] [blame]

922

"sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

Bu Sun Kim

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

[diff] [blame]

923

#

924

# Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.

925

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

926

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

927

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

928

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

Bu Sun Kim

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

[diff] [blame]

929

#

930

# The key must meet the following requirements before you can provide it to Compute Engine:

931

# - The key is wrapped using a RSA public key certificate provided by Google.

932

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

933

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

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

[diff] [blame]

934

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

935

},

936

"sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD.

937

#

938

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

939

# global/snapshots/my-backup

940

#

941

#

942

# If the source snapshot is deleted later, this field will not be set.

Dmitry Frenkel

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

[diff] [blame]

943

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

Bu Sun Kim

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

[diff] [blame]

944

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

945

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

946

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

947

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

948

#

949

# The key must meet the following requirements before you can provide it to Compute Engine:

950

# - The key is wrapped using a RSA public key certificate provided by Google.

951

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

952

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

953

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Bu Sun Kim

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

[diff] [blame]

954

},

Sai Cheemalapati

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

[diff] [blame]

955

},

Bu Sun Kim

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

[diff] [blame]

956

"interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.

957

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

958

"licenses": [ # [Output Only] Any valid publicly visible licenses.

959

"A String",

960

],

961

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

962

"shieldedInstanceInitialState": { # Initial State for shielded instance, these are public keys which are safe to store in public # [Output Only] shielded vm initial state stored on disk

963

"dbs": [ # The Key Database (db).

Dan O'Meara

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

[diff] [blame]

964

{

Bu Sun Kim

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

[diff] [blame]

965

"content": "A String", # The raw content in the secure keys file.

966

"fileType": "A String", # The file type of source file.

Dan O'Meara

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

[diff] [blame]

967

},

968

],

Bu Sun Kim

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

[diff] [blame]

969

"dbxs": [ # The forbidden key database (dbx).

Dan O'Meara

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

[diff] [blame]

970

{

Bu Sun Kim

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

[diff] [blame]

971

"content": "A String", # The raw content in the secure keys file.

972

"fileType": "A String", # The file type of source file.

Dan O'Meara

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

[diff] [blame]

973

},

974

],

Bu Sun Kim

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

[diff] [blame]

975

"keks": [ # The Key Exchange Key (KEK).

Dan O'Meara

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

[diff] [blame]

976

{

Bu Sun Kim

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

[diff] [blame]

977

"content": "A String", # The raw content in the secure keys file.

978

"fileType": "A String", # The file type of source file.

Dan O'Meara

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

[diff] [blame]

979

},

980

],

Bu Sun Kim

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

[diff] [blame]

981

"pk": { # The Platform Key (PK).

982

"content": "A String", # The raw content in the secure keys file.

983

"fileType": "A String", # The file type of source file.

Dan O'Meara

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

[diff] [blame]

984

},

985

},

Bu Sun Kim

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

[diff] [blame]

986

"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.

Jon Wayne Parrott

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

[diff] [blame]

987

#

988

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

989

#

990

# Note that for InstanceTemplate, specify the disk name, not the URL for the disk.

Bu Sun Kim

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

[diff] [blame]

991

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

Sai Cheemalapati

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

[diff] [blame]

992

}

993

Dmitry Frenkel

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

[diff] [blame]

994

forceAttach: boolean, Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error.

Bu Sun Kim

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

[diff] [blame]

995

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.

996

997

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.

998

999

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]

1000

1001

Returns:

1002

An object of the form:

1003

Bu Sun Kim

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

[diff] [blame]

1004

{ # Represents an Operation resource.

1005

#

Dan O'Meara

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

[diff] [blame]

1006

# Google Compute Engine has three Operation resources:

1007

#

1008

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

1009

#

Bu Sun Kim

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

[diff] [blame]

1010

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

1011

#

1012

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

1013

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

1014

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

1015

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

Bu Sun Kim

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

[diff] [blame]

1016

#

Dan O'Meara

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

[diff] [blame]

1017

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

Bu Sun Kim

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

[diff] [blame]

1018

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

1019

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

1020

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

1021

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

1022

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

1023

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

Sai Cheemalapati

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

[diff] [blame]

1024

{

Bu Sun Kim

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

[diff] [blame]

1025

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

1026

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

1027

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

Sai Cheemalapati

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

[diff] [blame]

1028

},

1029

],

1030

},

Bu Sun Kim

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

[diff] [blame]

1031

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

1032

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

1033

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

1034

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

1035

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

1036

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

1037

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

1038

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

1039

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

1040

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

1041

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

1042

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

1043

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

1044

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

1045

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

1046

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

1047

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

1048

{

1049

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

1050

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

1051

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

1052

{

1053

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

1054

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

1055

},

1056

],

1057

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

1058

},

1059

],

1060

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

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

[diff] [blame]

1065

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

1066

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

1070

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

Sai Cheemalapati

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

[diff] [blame]

1071

<pre>Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance.

1072

1073

Args:

1074

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

1075

zone: string, The name of the zone for this request. (required)

1076

instance: string, Name of the instance resource to delete. (required)

Bu Sun Kim

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

[diff] [blame]

1077

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.

1078

1079

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.

1080

1081

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]

1082

1083

Returns:

1084

An object of the form:

1085

Bu Sun Kim

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

[diff] [blame]

1086

{ # Represents an Operation resource.

1087

#

Dan O'Meara

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

[diff] [blame]

1088

# Google Compute Engine has three Operation resources:

1089

#

1090

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

1091

#

Bu Sun Kim

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

[diff] [blame]

1092

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

1093

#

1094

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

1095

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

1096

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

1097

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

Bu Sun Kim

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

[diff] [blame]

1098

#

Dan O'Meara

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

[diff] [blame]

1099

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

Bu Sun Kim

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

[diff] [blame]

1100

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

1101

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

1102

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

1103

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

1104

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

1105

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

Sai Cheemalapati

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

[diff] [blame]

1106

{

Bu Sun Kim

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

[diff] [blame]

1107

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

1108

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

1109

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

Sai Cheemalapati

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

[diff] [blame]

1110

},

1111

],

1112

},

Bu Sun Kim

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

[diff] [blame]

1113

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

1114

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

1115

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

1116

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

1117

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

1118

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

1119

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

1120

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

1121

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

1122

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

1123

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

1124

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

1125

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

1126

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

1127

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

1128

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

1129

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

1130

{

1131

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

1132

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

1133

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

1134

{

1135

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

1136

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

1137

},

1138

],

1139

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

1140

},

1141

],

1142

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

1147

<code class="details" id="deleteAccessConfig">deleteAccessConfig(project, zone, instance, accessConfig, networkInterface, requestId=None)</code>

Bu Sun Kim

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

[diff] [blame]

1148

<pre>Deletes an access config from an instance's network interface.

Sai Cheemalapati

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

[diff] [blame]

1149

1150

Args:

1151

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

1152

zone: string, The name of the zone for this request. (required)

1153

instance: string, The instance name for this request. (required)

1154

accessConfig: string, The name of the access config to delete. (required)

1155

networkInterface: string, The name of the network interface. (required)

Bu Sun Kim

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

[diff] [blame]

1156

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.

1157

1158

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.

1159

1160

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]

1161

1162

Returns:

1163

An object of the form:

1164

Bu Sun Kim

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

[diff] [blame]

1165

{ # Represents an Operation resource.

1166

#

Dan O'Meara

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

[diff] [blame]

1167

# Google Compute Engine has three Operation resources:

1168

#

1169

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

1170

#

Bu Sun Kim

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

[diff] [blame]

1171

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

1172

#

1173

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

1174

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

1175

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

1176

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

Bu Sun Kim

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

[diff] [blame]

1177

#

Dan O'Meara

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

[diff] [blame]

1178

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

Bu Sun Kim

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

[diff] [blame]

1179

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

1180

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

1181

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

1182

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

1183

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

1184

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

Sai Cheemalapati

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

[diff] [blame]

1185

{

Bu Sun Kim

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

[diff] [blame]

1186

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

1187

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

1188

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

Sai Cheemalapati

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

[diff] [blame]

1189

},

1190

],

1191

},

Bu Sun Kim

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

[diff] [blame]

1192

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

1193

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

1194

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

1195

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

1196

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

1197

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

1198

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

1199

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

1200

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

1201

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

1202

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

1203

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

1204

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

1205

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

1206

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

1207

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

1208

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

1209

{

1210

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

1211

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

1212

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

1213

{

1214

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

1215

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

1216

},

1217

],

1218

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

1219

},

1220

],

1221

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

1226

<code class="details" id="detachDisk">detachDisk(project, zone, instance, deviceName, requestId=None)</code>

Sai Cheemalapati

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

[diff] [blame]

1227

<pre>Detaches a disk from an instance.

1228

1229

Args:

1230

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

1231

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

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

[diff] [blame]

1232

instance: string, Instance name for this request. (required)

1233

deviceName: string, The device name of the disk to detach. Make a get() request on the instance to view currently attached disks and device names. (required)

1234

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.

1235

1236

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.

1237

1238

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]

1239

1240

Returns:

1241

An object of the form:

1242

Bu Sun Kim

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

[diff] [blame]

1243

{ # Represents an Operation resource.

1244

#

Dan O'Meara

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

[diff] [blame]

1245

# Google Compute Engine has three Operation resources:

1246

#

1247

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

1248

#

Bu Sun Kim

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

[diff] [blame]

1249

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

1250

#

1251

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

1252

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

1253

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

1254

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

Bu Sun Kim

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

[diff] [blame]

1255

#

Dan O'Meara

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

[diff] [blame]

1256

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

Bu Sun Kim

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

[diff] [blame]

1257

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

1258

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

1259

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

1260

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

1261

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

1262

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

Sai Cheemalapati

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

[diff] [blame]

1263

{

Bu Sun Kim

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

[diff] [blame]

1264

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

1265

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

1266

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

Sai Cheemalapati

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

[diff] [blame]

1267

},

1268

],

1269

},

Bu Sun Kim

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

[diff] [blame]

1270

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

1271

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

1272

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

1273

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

1274

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

1275

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

1276

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

1277

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

1278

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

1279

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

1280

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

1281

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

1282

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

1283

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

1284

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

1285

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

1286

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

1287

{

1288

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

1289

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

1290

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

1291

{

1292

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

1293

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

1294

},

1295

],

1296

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

1297

},

1298

],

1299

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

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

Bu Sun Kim

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

[diff] [blame]

1305

<pre>Returns the specified Instance resource. Gets a list of available instances by making a list() request.

Sai Cheemalapati

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

[diff] [blame]

1306

1307

Args:

1308

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

1309

zone: string, The name of the zone for this request. (required)

1310

instance: string, Name of the instance resource to return. (required)

1311

1312

Returns:

1313

An object of the form:

1314

Bu Sun Kim

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

[diff] [blame]

1315

{ # Represents an Instance resource.

1316

#

Dan O'Meara

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

[diff] [blame]

1317

# An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. (== resource_for {$api_version}.instances ==)

Bu Sun Kim

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

[diff] [blame]

1318

"canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.

Bu Sun Kim

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

[diff] [blame]

1319

"confidentialInstanceConfig": { # A set of Confidential Instance options.

1320

"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.

1321

},

Bu Sun Kim

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

[diff] [blame]

1322

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

1323

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

1324

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

1325

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

1326

"disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.

Sai Cheemalapati

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

[diff] [blame]

1327

{ # An instance-attached disk resource.

Bu Sun Kim

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

[diff] [blame]

1328

"autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).

1329

"boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

1330

"deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.

1331

#

1332

# If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.

Dmitry Frenkel

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

[diff] [blame]

1333

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.

Sai Cheemalapati

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

[diff] [blame]

1334

#

1335

# If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.

1336

#

1337

# If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.

1338

#

1339

# If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.

1340

#

1341

# Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.

Bu Sun Kim

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

[diff] [blame]

1342

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1343

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

1344

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1345

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

Sai Cheemalapati

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

[diff] [blame]

1346

#

1347

# The key must meet the following requirements before you can provide it to Compute Engine:

1348

# - The key is wrapped using a RSA public key certificate provided by Google.

Bu Sun Kim

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

[diff] [blame]

1349

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

Sai Cheemalapati

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

[diff] [blame]

1350

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

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

[diff] [blame]

1351

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Sai Cheemalapati

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

[diff] [blame]

1352

},

Bu Sun Kim

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

[diff] [blame]

1353

"diskSizeGb": "A String", # The size of the disk in GB.

1354

"guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

1355

{ # Guest OS features.

1356

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

1357

},

1358

],

1359

"index": 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.

1360

"initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.

Sai Cheemalapati

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

[diff] [blame]

1361

#

1362

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

1363

#

1364

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

Bu Sun Kim

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

[diff] [blame]

1365

"description": "A String", # An optional description. Provide this property when creating the disk.

1366

"diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created.

1367

"diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB.

1368

"diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:

Sai Cheemalapati

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

[diff] [blame]

1369

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

1370

#

Bu Sun Kim

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

[diff] [blame]

1371

#

Sai Cheemalapati

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

[diff] [blame]

1372

# Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:

1373

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType

1374

# - projects/project/zones/zone/diskTypes/diskType

1375

# - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.

Bu Sun Kim

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

[diff] [blame]

1376

"guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

Bu Sun Kim

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

[diff] [blame]

1377

#

1378

# Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

1379

{ # Guest OS features.

Bu Sun Kim

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

[diff] [blame]

1380

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

Bu Sun Kim

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

[diff] [blame]

1381

},

1382

],

Bu Sun Kim

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

[diff] [blame]

1383

"labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.

1384

"a_key": "A String",

1385

},

Bu Sun Kim

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

[diff] [blame]

1386

"multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.

Bu Sun Kim

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

[diff] [blame]

1387

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

1388

"resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name.

1389

"A String",

Bu Sun Kim

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

[diff] [blame]

1390

],

Bu Sun Kim

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

[diff] [blame]

1391

"sourceImage": "A String", # The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.

Sai Cheemalapati

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

[diff] [blame]

1392

#

Bu Sun Kim

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

[diff] [blame]

1393

# To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image:

1394

# projects/debian-cloud/global/images/family/debian-9

Sai Cheemalapati

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

[diff] [blame]

1395

#

Sai Cheemalapati

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

[diff] [blame]

1396

#

1397

# Alternatively, use a specific version of a public operating system image:

Bu Sun Kim

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

[diff] [blame]

1398

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

Sai Cheemalapati

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

[diff] [blame]

1399

#

Sai Cheemalapati

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

[diff] [blame]

1400

#

Bu Sun Kim

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

[diff] [blame]

1401

# To create a disk with a custom image that you created, specify the image name in the following format:

1402

# global/images/my-custom-image

Sai Cheemalapati

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

[diff] [blame]

1403

#

Sai Cheemalapati

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

[diff] [blame]

1404

#

Bu Sun Kim

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

[diff] [blame]

1405

# You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:

1406

# global/images/family/my-image-family

Sai Cheemalapati

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

[diff] [blame]

1407

#

Jon Wayne Parrott

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

[diff] [blame]

1408

#

1409

# If the source image is deleted later, this field will not be set.

Dmitry Frenkel

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

[diff] [blame]

1410

"sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

Bu Sun Kim

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

[diff] [blame]

1411

#

1412

# Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.

1413

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1414

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

1415

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1416

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

Bu Sun Kim

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

[diff] [blame]

1417

#

1418

# The key must meet the following requirements before you can provide it to Compute Engine:

1419

# - The key is wrapped using a RSA public key certificate provided by Google.

1420

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1421

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

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

[diff] [blame]

1422

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

1423

},

1424

"sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD.

1425

#

1426

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

1427

# global/snapshots/my-backup

1428

#

1429

#

1430

# If the source snapshot is deleted later, this field will not be set.

Dmitry Frenkel

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

[diff] [blame]

1431

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

Bu Sun Kim

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

[diff] [blame]

1432

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1433

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

1434

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1435

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

1436

#

1437

# The key must meet the following requirements before you can provide it to Compute Engine:

1438

# - The key is wrapped using a RSA public key certificate provided by Google.

1439

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1440

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1441

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Bu Sun Kim

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

[diff] [blame]

1442

},

Sai Cheemalapati

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

[diff] [blame]

1443

},

Bu Sun Kim

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

[diff] [blame]

1444

"interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.

1445

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

1446

"licenses": [ # [Output Only] Any valid publicly visible licenses.

1447

"A String",

1448

],

1449

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

1450

"shieldedInstanceInitialState": { # Initial State for shielded instance, these are public keys which are safe to store in public # [Output Only] shielded vm initial state stored on disk

1451

"dbs": [ # The Key Database (db).

Dan O'Meara

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

[diff] [blame]

1452

{

Bu Sun Kim

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

[diff] [blame]

1453

"content": "A String", # The raw content in the secure keys file.

1454

"fileType": "A String", # The file type of source file.

Dan O'Meara

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

[diff] [blame]

1455

},

1456

],

Bu Sun Kim

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

[diff] [blame]

1457

"dbxs": [ # The forbidden key database (dbx).

Dan O'Meara

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

[diff] [blame]

1458

{

Bu Sun Kim

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

[diff] [blame]

1459

"content": "A String", # The raw content in the secure keys file.

1460

"fileType": "A String", # The file type of source file.

Dan O'Meara

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

[diff] [blame]

1461

},

1462

],

Bu Sun Kim

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

[diff] [blame]

1463

"keks": [ # The Key Exchange Key (KEK).

Dan O'Meara

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

[diff] [blame]

1464

{

Bu Sun Kim

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

[diff] [blame]

1465

"content": "A String", # The raw content in the secure keys file.

1466

"fileType": "A String", # The file type of source file.

Dan O'Meara

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

[diff] [blame]

1467

},

1468

],

Bu Sun Kim

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

[diff] [blame]

1469

"pk": { # The Platform Key (PK).

1470

"content": "A String", # The raw content in the secure keys file.

1471

"fileType": "A String", # The file type of source file.

Dan O'Meara

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

[diff] [blame]

1472

},

1473

},

Bu Sun Kim

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

[diff] [blame]

1474

"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.

Jon Wayne Parrott

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

[diff] [blame]

1475

#

1476

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

1477

#

1478

# Note that for InstanceTemplate, specify the disk name, not the URL for the disk.

Bu Sun Kim

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

[diff] [blame]

1479

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

Sai Cheemalapati

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

[diff] [blame]

1480

},

1481

],

Bu Sun Kim

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

[diff] [blame]

1482

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

1483

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

1484

},

1485

"eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.

1486

"fingerprint": "A String", # Specifies a fingerprint for this resource, which is essentially a hash of the instance's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance. You must always provide an up-to-date fingerprint hash in order to update the instance.

1487

#

1488

# To see the latest fingerprint, make get() request to the instance.

1489

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

1490

{ # A specification of the type and number of accelerator cards attached to the instance.

1491

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

1492

"acceleratorType": "A String", # Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.

1493

},

1494

],

1495

"hostname": "A String", # Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.

1496

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

1497

"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.

1498

"labelFingerprint": "A String", # A fingerprint for this request, which is essentially a hash of the label's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.

1499

#

1500

# To see the latest fingerprint, make get() request to the instance.

1501

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

1502

"a_key": "A String",

1503

},

Bu Sun Kim

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

[diff] [blame]

1504

"lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format.

1505

"lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format.

1506

"lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format.

Bu Sun Kim

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

[diff] [blame]

1507

"machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:

1508

# zones/us-central1-f/machineTypes/n1-standard-1

1509

#

1510

#

1511

# To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):

1512

# zones/zone/machineTypes/custom-CPUS-MEMORY

1513

#

1514

#

1515

# For example: zones/us-central1-f/machineTypes/custom-4-5120

1516

#

1517

# For a full list of restrictions, read the Specifications for custom machine types.

1518

"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

1519

"fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet.

1520

#

1521

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

1522

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

1523

{

1524

"key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.

1525

"value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).

1526

},

1527

],

1528

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

1529

},

1530

"minCpuPlatform": "A String", # Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge".

1531

"name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

1532

"networkInterfaces": [ # An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance.

1533

{ # A network interface resource attached to an instance.

1534

"accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.

1535

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

1536

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

1537

"name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.

1538

"natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.

1539

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

1540

#

1541

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

1542

#

1543

# If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.

1544

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

1545

"setPublicPtr": True or False, # Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name.

1546

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

1547

},

1548

],

1549

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

1550

{ # An alias IP range attached to an instance's network interface.

1551

"ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4), a netmask (such as /24) or a CIDR-formatted string (such as 10.1.2.0/24).

1552

"subnetworkRangeName": "A String", # The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used.

1553

},

1554

],

1555

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface, otherwise the request will fail with error 412 conditionNotMet.

1556

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

1557

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

1558

"name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc.

1559

"network": "A String", # URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred.

1560

#

1561

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

1562

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

1563

# - projects/project/global/networks/network

1564

# - global/networks/default

1565

"networkIP": "A String", # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.

1566

"subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:

1567

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

1568

# - regions/region/subnetworks/subnetwork

1569

},

1570

],

1571

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.

1572

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.

1573

"consumeReservationType": "A String", # Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples.

1574

"key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value.

1575

"values": [ # Corresponds to the label values of a reservation resource.

"A String",

],

},

"resourcePolicies": [ # Resource policies applied to this instance.

1580

"A String",

1581

],

Dmitry Frenkel

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

[diff] [blame]

1582

"scheduling": { # Sets the scheduling options for an Instance. NextID: 13 # Sets the scheduling options for this instance.

Bu Sun Kim

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

[diff] [blame]

1583

"automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.

1584

#

1585

# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

1586

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

1587

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

1588

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

1589

"key": "A String", # Corresponds to the label key of Node resource.

1590

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

1591

"values": [ # Corresponds to the label values of Node resource.

"A String",

],

},

],

"onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.

Bu Sun Kim

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

[diff] [blame]

1597

"preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.

Bu Sun Kim

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

[diff] [blame]

1598

},

1599

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

1600

"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

1601

#

1602

# Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.

1603

{ # A service account.

1604

"email": "A String", # Email address of the service account.

1605

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

1611

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

1612

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

1613

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

1614

},

1615

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

1616

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

1617

},

Dmitry Frenkel

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

[diff] [blame]

1618

"shieldedVmConfig": { # A set of Shielded VM options. # Deprecating, please use shielded_instance_config.

Bu Sun Kim

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

[diff] [blame]

1619

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

1620

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

1621

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

1622

},

Dmitry Frenkel

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

[diff] [blame]

1623

"shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured. # Deprecating, please use shielded_instance_integrity_policy.

Bu Sun Kim

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

[diff] [blame]

1624

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

1625

},

1626

"sourceMachineImage": "A String", # Source machine image

Dmitry Frenkel

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

[diff] [blame]

1627

"sourceMachineImageEncryptionKey": { # Source GMI encryption key when creating an instance from GMI.

Bu Sun Kim

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

[diff] [blame]

1628

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1629

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

1630

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1631

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

1632

#

1633

# The key must meet the following requirements before you can provide it to Compute Engine:

1634

# - The key is wrapped using a RSA public key certificate provided by Google.

1635

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1636

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1637

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

1638

},

1639

"startRestricted": True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.

Bu Sun Kim

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

[diff] [blame]

1640

"status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.

Bu Sun Kim

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

[diff] [blame]

1641

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

1642

"tags": { # A set of instance tags. # Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the 'tags.items' field.

1643

"fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the tags' contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags.

1644

#

1645

# To see the latest fingerprint, make get() request to the instance.

1646

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

"A String",

],

},

"zone": "A String", # [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

1655

<code class="details" id="getEffectiveFirewalls">getEffectiveFirewalls(project, zone, instance, networkInterface)</code>

1656

<pre>Returns effective firewalls applied to an interface of the instance.

1657

1658

Args:

1659

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

1660

zone: string, The name of the zone for this request. (required)

1661

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

1662

networkInterface: string, The name of the network interface to get the effective firewalls. (required)

1663

1664

Returns:

1665

An object of the form:

1666

1667

{

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1668

"firewallPolicys": [ # Effective firewalls from firewall policies.

1669

{

1670

"displayName": "A String", # [Output Only] The display name of the firewall policy.

1671

"name": "A String", # [Output Only] The name of the firewall policy.

1672

"rules": [ # The rules that apply to the network.

1673

{ # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).

1674

"action": "A String", # The Action to perform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502.

1675

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

1676

"direction": "A String", # The direction in which this rule applies.

1677

"disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.

1678

"enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.

1679

"kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules

1680

"match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding ?action? is enforced.

1681

"destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 256.

1682

"A String",

1683

],

1684

"layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.

1685

{

1686

"ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.

1687

"ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.

1688

#

1689

# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

"A String",

],

},

],

"srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 256.

1695

"A String",

1696

],

1697

"srcSecureLabels": [ # List of firewall label values, which should be matched at the source of the traffic. Maximum number of source label values allowed is 256.

"A String",

],

},

"priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.

1702

"ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule.

1703

"targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network?s VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.

1704

"A String",

1705

],

1706

"targetSecureLabels": [ # A list of secure labels that controls which instances the firewall rule applies to. If targetSecureLabel are specified, then the firewall rule applies only to instances in the VPC network that have one of those secure labels. targetSecureLabel may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureLabel are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label values allowed is 256.

1707

"A String",

1708

],

1709

"targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.

"A String",

],

},

],

"type": "A String", # [Output Only] The type of the firewall policy.

1715

},

1716

],

Bu Sun Kim

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

[diff] [blame]

1717

"firewalls": [ # Effective firewalls on the instance.

1718

{ # Represents a Firewall Rule resource.

1719

#

1720

# Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules.

1721

"allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

1722

{

1723

"IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp) or the IP protocol number.

1724

"ports": [ # An optional list of ports to which this rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.

1725

#

1726

# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

"A String",

],

},

],

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

1732

"denied": [ # The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.

1733

{

1734

"IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp) or the IP protocol number.

1735

"ports": [ # An optional list of ports to which this rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.

1736

#

1737

# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

"A String",

],

},

],

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

1743

"destinationRanges": [ # If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported.

1744

"A String",

1745

],

1746

"direction": "A String", # Direction of traffic to which this firewall applies, either `INGRESS` or `EGRESS`. The default is `INGRESS`. For `INGRESS` traffic, you cannot specify the destinationRanges field, and for `EGRESS` traffic, you cannot specify the sourceRanges or sourceTags fields.

1747

"disabled": True or False, # Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled.

Bu Sun Kim

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

[diff] [blame]

1748

"enableLogging": True or False, # Deprecated in favor of enable in LogConfig. This field denotes whether to enable logging for a particular firewall rule. If logging is enabled, logs will be exported t Cloud Logging.

Bu Sun Kim

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

[diff] [blame]

1749

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

1750

"kind": "compute#firewall", # [Output Only] Type of the resource. Always compute#firewall for firewall rules.

Bu Sun Kim

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

[diff] [blame]

1751

"logConfig": { # The available logging options for a firewall rule. # This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Cloud Logging.

Bu Sun Kim

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

[diff] [blame]

1752

"enable": True or False, # This field denotes whether to enable logging for a particular firewall rule.

1753

"metadata": "A String", # This field can only be specified for a particular firewall rule if logging is enabled for that rule. This field denotes whether to include or exclude metadata for firewall logs.

1754

},

1755

"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

1756

"network": "A String", # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used:

1757

# global/networks/default

1758

# If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

1759

# - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network

1760

# - projects/myproject/global/networks/my-network

1761

# - global/networks/default

1762

"priority": 42, # Priority for this rule. This is an integer between `0` and `65535`, both inclusive. The default value is `1000`. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority `0` has higher precedence than a rule with priority `1`. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of `65535`. To avoid conflicts with the implied rules, use a priority number less than `65535`.

1763

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

1764

"sourceRanges": [ # If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Only IPv4 is supported.

1765

"A String",

1766

],

1767

"sourceServiceAccounts": [ # If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags.

1768

"A String",

1769

],

1770

"sourceTags": [ # If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply.

1771

"A String",

1772

],

1773

"targetServiceAccounts": [ # A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network.

1774

"A String",

1775

],

1776

"targetTags": [ # A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network.

"A String",

],

},

],

"organizationFirewalls": [ # Effective firewalls from organization policies.

Dan O'Meara

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

[diff] [blame]

1782

{ # A pruned SecurityPolicy containing ID and any applicable firewall rules.

Bu Sun Kim

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

[diff] [blame]

1783

"id": "A String", # The unique identifier for the security policy. This identifier is defined by the server.

1784

"rules": [ # The rules that apply to the network.

Dan O'Meara

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

[diff] [blame]

1785

{ # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).

Bu Sun Kim

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

[diff] [blame]

1786

"action": "A String", # The Action to preform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502.

1787

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

1788

"direction": "A String", # The direction in which this rule applies. This field may only be specified when versioned_expr is set to FIREWALL.

1789

"enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.

Dan O'Meara

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

[diff] [blame]

1790

#

1791

# This field may only be specified when the versioned_expr is set to FIREWALL.

Bu Sun Kim

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

[diff] [blame]

1792

"kind": "compute#securityPolicyRule", # [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules

1793

"match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.

1794

"config": { # The configuration options available when specifying versioned_expr. This field must be specified if versioned_expr is specified and cannot be specified if versioned_expr is not specified.

1795

"destIpRanges": [ # CIDR IP address range.

Dan O'Meara

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

[diff] [blame]

1796

#

1797

# This field may only be specified when versioned_expr is set to FIREWALL.

Bu Sun Kim

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

[diff] [blame]

1798

"A String",

Dan O'Meara

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

[diff] [blame]

1799

],

Bu Sun Kim

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

[diff] [blame]

1800

"layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.

Dan O'Meara

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

[diff] [blame]

1801

#

1802

# This field may only be specified when versioned_expr is set to FIREWALL.

1803

{

Bu Sun Kim

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

[diff] [blame]

1804

"ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.

1805

"ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.

Dan O'Meara

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

[diff] [blame]

1806

#

Bu Sun Kim

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

[diff] [blame]

1807

# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

Dan O'Meara

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

[diff] [blame]

1808

#

1809

# This field may only be specified when versioned_expr is set to FIREWALL.

Bu Sun Kim

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

[diff] [blame]

1810

"A String",

Dan O'Meara

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

[diff] [blame]

1811

],

1812

},

1813

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1814

"srcIpRanges": [ # CIDR IP address range. Maximum number of src_ip_ranges allowed is 10.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1815

"A String",

1816

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1817

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1818

"expr": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header.

1819

#

1820

# Example (Comparison):

1821

#

1822

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

1823

#

1824

# Example (Equality):

1825

#

1826

# title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'"

1831

#

1832

# Example (Data Manipulation):

1833

#

1834

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

1835

#

1836

# The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

1837

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

1838

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

1839

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

1840

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

1841

},

1842

"versionedExpr": "A String", # Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding src_ip_range field in config.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1843

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1844

"preview": True or False, # If set to true, the specified action is not enforced.

1845

"priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1846

"ruleNumber": "A String", # Identifier for the rule. This is only unique within the given security policy. This can only be set during rule creation, if rule number is not specified it will be generated by the server.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1847

"ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall security policy rule.

1848

"targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.

1849

#

1850

# This field may only be specified when versioned_expr is set to FIREWALL.

1851

"A String",

1852

],

1853

"targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.

1854

"A String",

1855

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1856

},

1857

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1858

},

1859

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1864

<code class="details" id="getGuestAttributes">getGuestAttributes(project, zone, instance, queryPath=None, variableKey=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1865

<pre>Returns the specified guest attributes entry.

1866

1867

Args:

1868

project: string, Project ID for this request. (required)

1869

zone: string, The name of the zone for this request. (required)

1870

instance: string, Name of the instance scoping this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1871

queryPath: string, Specifies the guest attributes path to be queried.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1872

variableKey: string, Specifies the key for the guest attributes entry.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1873

1874

Returns:

1875

An object of the form:

1876

1877

{ # A guest attributes entry.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1878

"kind": "compute#guestAttributes", # [Output Only] Type of the resource. Always compute#guestAttributes for guest attributes entry.

1879

"queryPath": "A String", # The path to be queried. This can be the default namespace ('/') or a nested namespace ('/\/') or a specified key ('/\/\')

1880

"queryValue": { # Array of guest attribute namespace/key/value tuples. # [Output Only] The value of the requested queried path.

1881

"items": [

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1882

{ # A guest attributes namespace/key/value entry.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1883

"key": "A String", # Key for the guest attribute entry.

1884

"namespace": "A String", # Namespace for the guest attribute entry.

1885

"value": "A String", # Value for the guest attribute entry.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1886

},

1887

],

1888

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1889

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

1890

"variableKey": "A String", # The key to search for.

1891

"variableValue": "A String", # [Output Only] The value found for the requested key.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1896

<code class="details" id="getIamPolicy">getIamPolicy(project, zone, resource, optionsRequestedPolicyVersion=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1897

<pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists.

1898

1899

Args:

1900

project: string, Project ID for this request. (required)

1901

zone: string, The name of the zone for this request. (required)

1902

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1903

optionsRequestedPolicyVersion: integer, Requested IAM Policy version.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1904

1905

Returns:

1906

An object of the form:

1907

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1908

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1909

#

1910

#

1911

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1912

# A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1913

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1914

# For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1915

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1916

# **JSON example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1917

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1918

# { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1919

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1920

# **YAML example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1921

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1922

# bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1923

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1924

# For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1925

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1926

{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.

1927

#

1928

# If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.

1929

#

1930

# Example Policy with multiple AuditConfigs:

1931

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1932

# { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1933

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1934

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1935

"auditLogConfigs": [ # The configuration for logging of each type of permission.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1936

{ # Provides the configuration for logging a type of permissions. Example:

1937

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1938

# { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1939

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1940

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

1941

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

1942

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1943

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1944

"ignoreChildExemptions": True or False,

1945

"logType": "A String", # The log type that this config enables.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1946

},

1947

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"exemptedMembers": [

"A String",

],

"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1952

},

1953

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1954

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1955

{ # Associates `members` with a `role`.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1956

"bindingId": "A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1957

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding.

1958

#

1959

# If the condition evaluates to `true`, then this binding applies to the current request.

1960

#

1961

# If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.

1962

#

1963

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1964

#

1965

# Example (Comparison):

1966

#

1967

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

1968

#

1969

# Example (Equality):

1970

#

1971

# title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'"

1976

#

1977

# Example (Data Manipulation):

1978

#

1979

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

1980

#

1981

# The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

1982

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

1983

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

1984

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

1985

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

1986

},

1987

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1988

#

1989

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

1990

#

1991

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

1992

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1993

# * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

#

#

#

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

1998

#

1999

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

2000

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2001

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding.

2002

#

2003

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding.

2004

#

2005

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.

2006

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2007

#

2008

#

2009

# * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2010

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2011

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2012

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2013

},

2014

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2015

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.

2016

#

2017

# **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

2018

"iamOwned": True or False,

2019

"rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.

2020

{ # A rule to be applied in a Policy.

2021

"action": "A String", # Required

2022

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

2023

{ # A condition to be met.

2024

"iam": "A String", # Trusted attributes supplied by the IAM system.

2025

"op": "A String", # An operator to apply the subject with.

2026

"svc": "A String", # Trusted attributes discharged by the service.

2027

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

2028

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

2034

"ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.

2035

"A String",

2036

],

2037

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

2038

{ # Specifies what kind of log the caller must write

2039

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

2040

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

2041

"permissionType": "A String", # The type of the permission that was checked.

2042

},

2043

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

2044

},

2045

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

2046

#

2047

# Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended.

2048

#

2049

# Field names correspond to IAM request parameters and field values are their respective values.

2050

#

2051

# Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields.

2052

#

2053

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

2054

"customFields": [ # Custom fields.

2055

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

2056

"name": "A String", # Name is the field name.

2057

"value": "A String", # Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext.

2058

},

2059

],

2060

"field": "A String", # The field value to attribute.

2061

"metric": "A String", # The metric to update.

2062

},

2063

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

2064

"logMode": "A String",

},

},

],

"notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.

2069

"A String",

2070

],

2071

"permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.

"A String",

],

},

],

"version": 42, # Specifies the format of the policy.

2077

#

2078

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

2079

#

2080

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

2081

#

2082

# * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions

2083

#

2084

# **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

2085

#

2086

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

2087

#

2088

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2093

<code class="details" id="getScreenshot">getScreenshot(project, zone, instance)</code>

2094

<pre>Returns the screenshot from the specified instance.

2095

2096

Args:

2097

project: string, Project ID for this request. (required)

2098

zone: string, The name of the zone for this request. (required)

2099

instance: string, Name of the instance scoping this request. (required)

2100

2101

Returns:

2102

An object of the form:

2103

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2104

{ # An instance's screenshot.

2105

"contents": "A String", # [Output Only] The Base64-encoded screenshot data.

2106

"kind": "compute#screenshot", # [Output Only] Type of the resource. Always compute#screenshot for the screenshots.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2111

<code class="details" id="getSerialPortOutput">getSerialPortOutput(project, zone, instance, port=None, start=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2112

<pre>Returns the last 1 MB of serial port output from the specified instance.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2113

2114

Args:

2115

project: string, Project ID for this request. (required)

2116

zone: string, The name of the zone for this request. (required)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2117

instance: string, Name of the instance for this request. (required)

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2118

port: integer, Specifies which COM or serial port to retrieve data from.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2119

start: string, Specifies the starting byte position of the output to return. To start with the first byte of output to the specified port, omit this field or set it to `0`.

2120

2121

If the output for that byte position is available, this field matches the `start` parameter sent with the request. If the amount of serial console output exceeds the size of the buffer (1 MB), the oldest output is discarded and is no longer available. If the requested start position refers to discarded output, the start position is adjusted to the oldest output still available, and the adjusted start position is returned as the `start` property value.

2122

2123

You can also provide a negative start position, which translates to the most recent number of bytes written to the serial port. For example, -3 is interpreted as the most recent 3 bytes written to the serial console.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2124

2125

Returns:

2126

An object of the form:

2127

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2128

{ # An instance's serial console output.

2129

"contents": "A String", # [Output Only] The contents of the console output.

2130

"kind": "compute#serialPortOutput", # [Output Only] Type of the resource. Always compute#serialPortOutput for serial port output.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2131

"next": "A String", # [Output Only] The position of the next byte of content, regardless of whether the content exists, following the output returned in the `contents` property. Use this value in the next request as the start parameter.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2132

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2133

"start": "A String", # The starting byte position of the output that was returned. This should match the start parameter sent with the request. If the serial console output exceeds the size of the buffer (1 MB), older output is overwritten by newer content. The output start value will indicate the byte position of the output that was returned, which might be different than the `start` value that was specified in the request.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2138

<code class="details" id="getShieldedInstanceIdentity">getShieldedInstanceIdentity(project, zone, instance)</code>

2139

<pre>Returns the Shielded Instance Identity of an instance

2140

2141

Args:

2142

project: string, Project ID for this request. (required)

2143

zone: string, The name of the zone for this request. (required)

2144

instance: string, Name or id of the instance scoping this request. (required)

2145

2146

Returns:

2147

An object of the form:

2148

2149

{ # A shielded Instance identity entry.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2150

"encryptionKey": { # A Shielded Instance Identity Entry. # An Endorsement Key (EK) made by the RSA 2048 algorithm issued to the Shielded Instance's vTPM.

2151

"ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.

2152

"ekPub": "A String", # A PEM-encoded public key.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2153

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2154

"kind": "compute#shieldedInstanceIdentity", # [Output Only] Type of the resource. Always compute#shieldedInstanceIdentity for shielded Instance identity entry.

2155

"signingKey": { # A Shielded Instance Identity Entry. # An Attestation Key (AK) made by the RSA 2048 algorithm issued to the Shielded Instance's vTPM.

2156

"ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.

2157

"ekPub": "A String", # A PEM-encoded public key.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

}</pre>

</div>

<code class="details" id="getShieldedVmIdentity">getShieldedVmIdentity(project, zone, instance)</code>

2164

<pre>Returns the Shielded VM Identity of an instance

2165

2166

Args:

2167

project: string, Project ID for this request. (required)

2168

zone: string, The name of the zone for this request. (required)

2169

instance: string, Name of the instance scoping this request. (required)

2170

2171

Returns:

2172

An object of the form:

2173

2174

{ # A shielded VM identity entry.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2175

"encryptionKey": { # A Shielded Instance Identity Entry. # An Endorsement Key (EK) issued to the Shielded VM's vTPM.

2176

"ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.

2177

"ekPub": "A String", # A PEM-encoded public key.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2178

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2179

"kind": "compute#shieldedVmIdentity", # [Output Only] Type of the resource. Always compute#shieldedVmIdentity for shielded VM identity entry.

2180

"signingKey": { # A Shielded Instance Identity Entry. # An Attestation Key (AK) issued to the Shielded VM's vTPM.

2181

"ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.

2182

"ekPub": "A String", # A PEM-encoded public key.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2188

<code class="details" id="insert">insert(project, zone, body=None, requestId=None, sourceInstanceTemplate=None, sourceMachineImage=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2189

<pre>Creates an instance resource in the specified project using the data included in the request.

2190

2191

Args:

2192

project: string, Project ID for this request. (required)

2193

zone: string, The name of the zone for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2194

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2195

The object takes the form of:

2196

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2197

{ # Represents an Instance resource.

2198

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2199

# An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. (== resource_for {$api_version}.instances ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2200

"canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2201

"confidentialInstanceConfig": { # A set of Confidential Instance options.

2202

"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.

2203

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2204

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

2205

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

2206

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

2207

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2208

"disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2209

{ # An instance-attached disk resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2210

"autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).

2211

"boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

2212

"deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.

2213

#

2214

# If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2215

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2216

#

2217

# If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.

2218

#

2219

# If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.

2220

#

2221

# If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.

2222

#

2223

# Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2224

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2225

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

2226

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2227

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2228

#

2229

# The key must meet the following requirements before you can provide it to Compute Engine:

2230

# - The key is wrapped using a RSA public key certificate provided by Google.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2231

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2232

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2233

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2234

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2235

"diskSizeGb": "A String", # The size of the disk in GB.

2236

"guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

2237

{ # Guest OS features.

2238

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

2239

},

2240

],

2241

"index": 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.

2242

"initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2243

#

2244

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

2245

#

2246

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2247

"description": "A String", # An optional description. Provide this property when creating the disk.

2248

"diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created.

2249

"diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB.

2250

"diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2251

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

2252

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2253

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2254

# Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:

2255

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType

2256

# - projects/project/zones/zone/diskTypes/diskType

2257

# - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2258

"guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2259

#

2260

# Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

2261

{ # Guest OS features.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2262

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2263

},

2264

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2265

"labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.

2266

"a_key": "A String",

2267

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2268

"multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2269

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

2270

"resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name.

2271

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2272

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2273

"sourceImage": "A String", # The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2274

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2275

# To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image:

2276

# projects/debian-cloud/global/images/family/debian-9

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2277

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2278

#

2279

# Alternatively, use a specific version of a public operating system image:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2280

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2281

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2282

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2283

# To create a disk with a custom image that you created, specify the image name in the following format:

2284

# global/images/my-custom-image

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2285

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2286

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2287

# You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:

2288

# global/images/family/my-image-family

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2289

#

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2290

#

2291

# If the source image is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2292

"sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2293

#

2294

# Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.

2295

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2296

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

2297

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2298

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2299

#

2300

# The key must meet the following requirements before you can provide it to Compute Engine:

2301

# - The key is wrapped using a RSA public key certificate provided by Google.

2302

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

2303

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2304

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

2305

},

2306

"sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD.

2307

#

2308

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

2309

# global/snapshots/my-backup

2310

#

2311

#

2312

# If the source snapshot is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2313

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2314

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2315

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

2316

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2317

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

2318

#

2319

# The key must meet the following requirements before you can provide it to Compute Engine:

2320

# - The key is wrapped using a RSA public key certificate provided by Google.

2321

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

2322

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

2323

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2324

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2325

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2326

"interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.

2327

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

2328

"licenses": [ # [Output Only] Any valid publicly visible licenses.

2329

"A String",

2330

],

2331

"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.

2332

"shieldedInstanceInitialState": { # Initial State for shielded instance, these are public keys which are safe to store in public # [Output Only] shielded vm initial state stored on disk

2333

"dbs": [ # The Key Database (db).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2334

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2335

"content": "A String", # The raw content in the secure keys file.

2336

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2337

},

2338

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2339

"dbxs": [ # The forbidden key database (dbx).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2340

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2341

"content": "A String", # The raw content in the secure keys file.

2342

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2343

},

2344

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2345

"keks": [ # The Key Exchange Key (KEK).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2346

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2347

"content": "A String", # The raw content in the secure keys file.

2348

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2349

},

2350

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2351

"pk": { # The Platform Key (PK).

2352

"content": "A String", # The raw content in the secure keys file.

2353

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2354

},

2355

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2356

"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2357

#

2358

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

2359

#

2360

# Note that for InstanceTemplate, specify the disk name, not the URL for the disk.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2361

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2362

},

2363

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2364

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

2365

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

2366

},

2367

"eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.

2368

"fingerprint": "A String", # Specifies a fingerprint for this resource, which is essentially a hash of the instance's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance. You must always provide an up-to-date fingerprint hash in order to update the instance.

2369

#

2370

# To see the latest fingerprint, make get() request to the instance.

2371

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

2372

{ # A specification of the type and number of accelerator cards attached to the instance.

2373

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

2374

"acceleratorType": "A String", # Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.

2375

},

2376

],

2377

"hostname": "A String", # Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.

2378

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

2379

"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.

2380

"labelFingerprint": "A String", # A fingerprint for this request, which is essentially a hash of the label's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.

2381

#

2382

# To see the latest fingerprint, make get() request to the instance.

2383

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

2384

"a_key": "A String",

2385

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2386

"lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format.

2387

"lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format.

2388

"lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2389

"machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:

2390

# zones/us-central1-f/machineTypes/n1-standard-1

2391

#

2392

#

2393

# To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):

2394

# zones/zone/machineTypes/custom-CPUS-MEMORY

2395

#

2396

#

2397

# For example: zones/us-central1-f/machineTypes/custom-4-5120

2398

#

2399

# For a full list of restrictions, read the Specifications for custom machine types.

2400

"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

2401

"fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet.

2402

#

2403

# To see the latest fingerprint, make a get() request to retrieve the resource.

2404

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

2405

{

2406

"key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.

2407

"value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).

2408

},

2409

],

2410

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

2411

},

2412

"minCpuPlatform": "A String", # Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge".

2413

"name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

2414

"networkInterfaces": [ # An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance.

2415

{ # A network interface resource attached to an instance.

2416

"accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.

2417

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

2418

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

2419

"name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.

2420

"natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.

2421

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

2422

#

2423

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

2424

#

2425

# If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.

2426

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

2427

"setPublicPtr": True or False, # Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name.

2428

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

2429

},

2430

],

2431

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

2432

{ # An alias IP range attached to an instance's network interface.

2433

"ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4), a netmask (such as /24) or a CIDR-formatted string (such as 10.1.2.0/24).

2434

"subnetworkRangeName": "A String", # The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used.

2435

},

2436

],

2437

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface, otherwise the request will fail with error 412 conditionNotMet.

2438

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

2439

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

2440

"name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc.

2441

"network": "A String", # URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred.

2442

#

2443

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

2444

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

2445

# - projects/project/global/networks/network

2446

# - global/networks/default

2447

"networkIP": "A String", # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.

2448

"subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:

2449

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

2450

# - regions/region/subnetworks/subnetwork

2451

},

2452

],

2453

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.

2454

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.

2455

"consumeReservationType": "A String", # Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples.

2456

"key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value.

2457

"values": [ # Corresponds to the label values of a reservation resource.

"A String",

],

},

"resourcePolicies": [ # Resource policies applied to this instance.

2462

"A String",

2463

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2464

"scheduling": { # Sets the scheduling options for an Instance. NextID: 13 # Sets the scheduling options for this instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2465

"automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.

2466

#

2467

# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

2468

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

2469

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

2470

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

2471

"key": "A String", # Corresponds to the label key of Node resource.

2472

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

2473

"values": [ # Corresponds to the label values of Node resource.

"A String",

],

},

],

"onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2479

"preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2480

},

2481

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

2482

"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

2483

#

2484

# Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.

2485

{ # A service account.

2486

"email": "A String", # Email address of the service account.

2487

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

2493

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

2494

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

2495

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

2496

},

2497

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

2498

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

2499

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2500

"shieldedVmConfig": { # A set of Shielded VM options. # Deprecating, please use shielded_instance_config.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2501

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

2502

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

2503

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

2504

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2505

"shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured. # Deprecating, please use shielded_instance_integrity_policy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2506

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

2507

},

2508

"sourceMachineImage": "A String", # Source machine image

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2509

"sourceMachineImageEncryptionKey": { # Source GMI encryption key when creating an instance from GMI.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2510

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2511

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

2512

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2513

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

2514

#

2515

# The key must meet the following requirements before you can provide it to Compute Engine:

2516

# - The key is wrapped using a RSA public key certificate provided by Google.

2517

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

2518

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

2519

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

2520

},

2521

"startRestricted": True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2522

"status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2523

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

2524

"tags": { # A set of instance tags. # Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the 'tags.items' field.

2525

"fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the tags' contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags.

2526

#

2527

# To see the latest fingerprint, make get() request to the instance.

2528

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

"A String",

],

},

"zone": "A String", # [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2533

}

2534

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2535

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.

2536

2537

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.

2538

2539

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2540

sourceInstanceTemplate: string, Specifies instance template to create the instance.

2541

2542

This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to an instance template:

2543

- https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate

2544

- projects/project/global/instanceTemplates/instanceTemplate

2545

- global/instanceTemplates/instanceTemplate

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2546

sourceMachineImage: string, Specifies the machine image to use to create the instance.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2547

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2548

This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to a machine image:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2549

- https://www.googleapis.com/compute/v1/projects/project/global/global/machineImages/machineImage

2550

- projects/project/global/global/machineImages/machineImage

2551

- global/machineImages/machineImage

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2552

2553

Returns:

2554

An object of the form:

2555

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2556

{ # Represents an Operation resource.

2557

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2558

# Google Compute Engine has three Operation resources:

2559

#

2560

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2561

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2562

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2563

#

2564

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2565

# - For global operations, use the `globalOperations` resource.

2566

# - For regional operations, use the `regionOperations` resource.

2567

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2568

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2569

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2570

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2571

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2572

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2573

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2574

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2575

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2576

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2577

"code": "A String", # [Output Only] The error type identifier for this error.

2578

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2579

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2580

},

2581

],

2582

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2583

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2584

"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.

2585

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2586

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2587

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2588

"name": "A String", # [Output Only] Name of the operation.

2589

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2590

"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.

2591

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2592

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2617

<code class="details" id="list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2618

<pre>Retrieves the list of instances contained within the specified zone.

2619

2620

Args:

2621

project: string, Project ID for this request. (required)

2622

zone: string, The name of the zone for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2623

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]

2624

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2625

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]

2626

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2627

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]

2628

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2629

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) ```

2630

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`)

2631

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

2632

2633

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.

2634

2635

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

2636

pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2637

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2638

2639

Returns:

2640

An object of the form:

2641

2642

{ # Contains a list of instances.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2643

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

2644

"items": [ # A list of Instance resources.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2645

{ # Represents an Instance resource.

2646

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2647

# An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. (== resource_for {$api_version}.instances ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2648

"canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2649

"confidentialInstanceConfig": { # A set of Confidential Instance options.

2650

"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.

2651

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2652

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

2653

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

2654

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

2655

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2656

"disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2657

{ # An instance-attached disk resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2658

"autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).

2659

"boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

2660

"deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.

2661

#

2662

# If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2663

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2664

#

2665

# If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.

2666

#

2667

# If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.

2668

#

2669

# If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.

2670

#

2671

# Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2672

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2673

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

2674

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2675

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2676

#

2677

# The key must meet the following requirements before you can provide it to Compute Engine:

2678

# - The key is wrapped using a RSA public key certificate provided by Google.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2679

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2680

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2681

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2682

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2683

"diskSizeGb": "A String", # The size of the disk in GB.

2684

"guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

2685

{ # Guest OS features.

2686

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

2687

},

2688

],

2689

"index": 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.

2690

"initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2691

#

2692

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

2693

#

2694

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2695

"description": "A String", # An optional description. Provide this property when creating the disk.

2696

"diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created.

2697

"diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB.

2698

"diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2699

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

2700

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2701

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2702

# Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:

2703

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType

2704

# - projects/project/zones/zone/diskTypes/diskType

2705

# - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2706

"guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2707

#

2708

# Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

2709

{ # Guest OS features.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2710

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2711

},

2712

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2713

"labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.

2714

"a_key": "A String",

2715

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2716

"multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2717

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

2718

"resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name.

2719

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2720

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2721

"sourceImage": "A String", # The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2722

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2723

# To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image:

2724

# projects/debian-cloud/global/images/family/debian-9

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2725

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2726

#

2727

# Alternatively, use a specific version of a public operating system image:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2728

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2729

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2730

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2731

# To create a disk with a custom image that you created, specify the image name in the following format:

2732

# global/images/my-custom-image

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2733

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2734

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2735

# You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:

2736

# global/images/family/my-image-family

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2737

#

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2738

#

2739

# If the source image is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2740

"sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2741

#

2742

# Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.

2743

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2744

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

2745

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2746

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2747

#

2748

# The key must meet the following requirements before you can provide it to Compute Engine:

2749

# - The key is wrapped using a RSA public key certificate provided by Google.

2750

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

2751

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2752

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

2753

},

2754

"sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD.

2755

#

2756

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

2757

# global/snapshots/my-backup

2758

#

2759

#

2760

# If the source snapshot is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2761

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2762

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2763

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

2764

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2765

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

2766

#

2767

# The key must meet the following requirements before you can provide it to Compute Engine:

2768

# - The key is wrapped using a RSA public key certificate provided by Google.

2769

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

2770

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

2771

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2772

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2773

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2774

"interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.

2775

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

2776

"licenses": [ # [Output Only] Any valid publicly visible licenses.

2777

"A String",

2778

],

2779

"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.

2780

"shieldedInstanceInitialState": { # Initial State for shielded instance, these are public keys which are safe to store in public # [Output Only] shielded vm initial state stored on disk

2781

"dbs": [ # The Key Database (db).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2782

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2783

"content": "A String", # The raw content in the secure keys file.

2784

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2785

},

2786

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2787

"dbxs": [ # The forbidden key database (dbx).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2788

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2789

"content": "A String", # The raw content in the secure keys file.

2790

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2791

},

2792

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2793

"keks": [ # The Key Exchange Key (KEK).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2794

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2795

"content": "A String", # The raw content in the secure keys file.

2796

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2797

},

2798

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2799

"pk": { # The Platform Key (PK).

2800

"content": "A String", # The raw content in the secure keys file.

2801

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2802

},

2803

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2804

"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2805

#

2806

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

2807

#

2808

# Note that for InstanceTemplate, specify the disk name, not the URL for the disk.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2809

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2810

},

2811

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2812

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

2813

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

2814

},

2815

"eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.

2816

"fingerprint": "A String", # Specifies a fingerprint for this resource, which is essentially a hash of the instance's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance. You must always provide an up-to-date fingerprint hash in order to update the instance.

2817

#

2818

# To see the latest fingerprint, make get() request to the instance.

2819

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

2820

{ # A specification of the type and number of accelerator cards attached to the instance.

2821

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

2822

"acceleratorType": "A String", # Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.

2823

},

2824

],

2825

"hostname": "A String", # Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.

2826

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

2827

"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.

2828

"labelFingerprint": "A String", # A fingerprint for this request, which is essentially a hash of the label's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.

2829

#

2830

# To see the latest fingerprint, make get() request to the instance.

2831

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

2832

"a_key": "A String",

2833

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2834

"lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format.

2835

"lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format.

2836

"lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2837

"machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:

2838

# zones/us-central1-f/machineTypes/n1-standard-1

2839

#

2840

#

2841

# To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):

2842

# zones/zone/machineTypes/custom-CPUS-MEMORY

2843

#

2844

#

2845

# For example: zones/us-central1-f/machineTypes/custom-4-5120

2846

#

2847

# For a full list of restrictions, read the Specifications for custom machine types.

2848

"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

2849

"fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet.

2850

#

2851

# To see the latest fingerprint, make a get() request to retrieve the resource.

2852

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

2853

{

2854

"key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.

2855

"value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).

2856

},

2857

],

2858

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

2859

},

2860

"minCpuPlatform": "A String", # Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge".

2861

"name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

2862

"networkInterfaces": [ # An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance.

2863

{ # A network interface resource attached to an instance.

2864

"accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.

2865

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

2866

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

2867

"name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.

2868

"natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.

2869

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

2870

#

2871

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

2872

#

2873

# If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.

2874

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

2875

"setPublicPtr": True or False, # Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name.

2876

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

2877

},

2878

],

2879

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

2880

{ # An alias IP range attached to an instance's network interface.

2881

"ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4), a netmask (such as /24) or a CIDR-formatted string (such as 10.1.2.0/24).

2882

"subnetworkRangeName": "A String", # The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used.

2883

},

2884

],

2885

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface, otherwise the request will fail with error 412 conditionNotMet.

2886

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

2887

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

2888

"name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc.

2889

"network": "A String", # URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred.

2890

#

2891

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

2892

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

2893

# - projects/project/global/networks/network

2894

# - global/networks/default

2895

"networkIP": "A String", # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.

2896

"subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:

2897

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

2898

# - regions/region/subnetworks/subnetwork

2899

},

2900

],

2901

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.

2902

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.

2903

"consumeReservationType": "A String", # Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples.

2904

"key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value.

2905

"values": [ # Corresponds to the label values of a reservation resource.

"A String",

],

},

"resourcePolicies": [ # Resource policies applied to this instance.

2910

"A String",

2911

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2912

"scheduling": { # Sets the scheduling options for an Instance. NextID: 13 # Sets the scheduling options for this instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2913

"automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.

2914

#

2915

# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

2916

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

2917

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

2918

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

2919

"key": "A String", # Corresponds to the label key of Node resource.

2920

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

2921

"values": [ # Corresponds to the label values of Node resource.

"A String",

],

},

],

"onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2927

"preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2928

},

2929

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

2930

"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

2931

#

2932

# Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.

2933

{ # A service account.

2934

"email": "A String", # Email address of the service account.

2935

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

2941

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

2942

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

2943

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

2944

},

2945

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

2946

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

2947

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2948

"shieldedVmConfig": { # A set of Shielded VM options. # Deprecating, please use shielded_instance_config.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2949

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

2950

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

2951

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

2952

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2953

"shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured. # Deprecating, please use shielded_instance_integrity_policy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2954

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

2955

},

2956

"sourceMachineImage": "A String", # Source machine image

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2957

"sourceMachineImageEncryptionKey": { # Source GMI encryption key when creating an instance from GMI.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2958

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2959

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

2960

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2961

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

2962

#

2963

# The key must meet the following requirements before you can provide it to Compute Engine:

2964

# - The key is wrapped using a RSA public key certificate provided by Google.

2965

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

2966

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

2967

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

2968

},

2969

"startRestricted": True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2970

"status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2971

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

2972

"tags": { # A set of instance tags. # Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the 'tags.items' field.

2973

"fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the tags' contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags.

2974

#

2975

# To see the latest fingerprint, make get() request to the instance.

2976

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

"A String",

],

},

"zone": "A String", # [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2981

},

2982

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2983

"kind": "compute#instanceList", # [Output Only] Type of resource. Always compute#instanceList for lists of Instance resources.

2984

"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.

2985

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

2986

"warning": { # [Output Only] Informational warning message.

2987

"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.

2988

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2989

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2990

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2991

"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).

2992

"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]

2993

},

2994

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2995

"message": "A String", # [Output Only] A human-readable description of the warning code.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2996

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3001

<code class="details" id="listReferrers">listReferrers(project, zone, instance, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3002

<pre>Retrieves a list of resources that refer to the VM instance specified in the request. For example, if the VM instance is part of a managed or unmanaged instance group, the referrers list includes the instance group. For more information, read Viewing referrers to VM instances.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3003

3004

Args:

3005

project: string, Project ID for this request. (required)

3006

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3007

instance: string, Name of the target instance scoping this request, or '-' if the request should span over all instances in the container. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3008

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

2017-06-06 18:46:08 -0400

[diff] [blame]

3009

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3010

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3011

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3012

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

2017-06-06 18:46:08 -0400

[diff] [blame]

3013

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3014

To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3015

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`)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3016

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

3017

3018

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.

3019

3020

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3021

pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3022

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3023

3024

Returns:

3025

An object of the form:

3026

3027

{ # Contains a list of instance referrers.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3028

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

3029

"items": [ # A list of Reference resources.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3030

{ # Represents a reference to a resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3031

"kind": "compute#reference", # [Output Only] Type of the resource. Always compute#reference for references.

3032

"referenceType": "A String", # A description of the reference type with no implied semantics. Possible values include:

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3033

# - MEMBER_OF

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3034

"referrer": "A String", # URL of the resource which refers to the target.

3035

"target": "A String", # URL of the resource to which this reference points.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3036

},

3037

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3038

"kind": "compute#instanceListReferrers", # [Output Only] Type of resource. Always compute#instanceListReferrers for lists of Instance referrers.

3039

"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.

3040

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

3041

"warning": { # [Output Only] Informational warning message.

3042

"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.

3043

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

3044

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3045

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3046

"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).

3047

"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]

3048

},

3049

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3050

"message": "A String", # [Output Only] A human-readable description of the warning code.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3051

},

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

}</pre>

</div>

<code class="details" id="listReferrers_next">listReferrers_next(previous_request, previous_response)</code>

3057

<pre>Retrieves the next page of results.

3058

3059

Args:

3060

previous_request: The request for the previous page. (required)

3061

previous_response: The response from the request for the previous page. (required)

3062

3063

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3064

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3065

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]

3070

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

3071

<pre>Retrieves the next page of results.

3072

3073

Args:

3074

previous_request: The request for the previous page. (required)

3075

previous_response: The response from the request for the previous page. (required)

3076

3077

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3078

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3079

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]

3084

<code class="details" id="removeResourcePolicies">removeResourcePolicies(project, zone, instance, body=None, requestId=None)</code>

3085

<pre>Removes resource policies from an instance.

3086

3087

Args:

3088

project: string, Project ID for this request. (required)

3089

zone: string, The name of the zone for this request. (required)

3090

instance: string, The instance name for this request. (required)

3091

body: object, The request body.

3092

The object takes the form of:

3093

3094

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3095

"resourcePolicies": [ # Resource policies to be removed from this instance.

3096

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

],

}

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

3101

3102

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.

3103

3104

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

3105

3106

Returns:

3107

An object of the form:

3108

3109

{ # Represents an Operation resource.

3110

#

3111

# Google Compute Engine has three Operation resources:

3112

#

3113

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

3114

#

3115

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

3116

#

3117

# Operations can be global, regional or zonal.

3118

# - For global operations, use the `globalOperations` resource.

3119

# - For regional operations, use the `regionOperations` resource.

3120

# - For zonal operations, use the `zonalOperations` resource.

3121

#

3122

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3123

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3124

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3125

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3126

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3127

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3128

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3129

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3130

"code": "A String", # [Output Only] The error type identifier for this error.

3131

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3132

"message": "A String", # [Output Only] An optional, human-readable error message.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3133

},

3134

],

3135

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3136

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3137

"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.

3138

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3139

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3140

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3141

"name": "A String", # [Output Only] Name of the operation.

3142

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3143

"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.

3144

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3145

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3146

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3147

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3148

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3149

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3150

"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.

3151

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3152

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3153

{

3154

"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.

3155

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

3156

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

3157

{

3158

"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).

3159

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3160

},

3161

],

3162

"message": "A String", # [Output Only] A human-readable description of the warning code.

3163

},

3164

],

3165

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3170

<code class="details" id="reset">reset(project, zone, instance, requestId=None)</code>

3171

<pre>Performs a reset on the instance. This is a hard reset the VM does not do a graceful shutdown. For more information, see Resetting an instance.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3172

3173

Args:

3174

project: string, Project ID for this request. (required)

3175

zone: string, The name of the zone for this request. (required)

3176

instance: string, Name of the instance scoping this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3177

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.

3178

3179

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.

3180

3181

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]

3182

3183

Returns:

3184

An object of the form:

3185

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3186

{ # Represents an Operation resource.

3187

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3188

# Google Compute Engine has three Operation resources:

3189

#

3190

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

3191

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3192

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

3193

#

3194

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3195

# - For global operations, use the `globalOperations` resource.

3196

# - For regional operations, use the `regionOperations` resource.

3197

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3198

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3199

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3200

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3201

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3202

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3203

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3204

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3205

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3206

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3207

"code": "A String", # [Output Only] The error type identifier for this error.

3208

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3209

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3210

},

3211

],

3212

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3213

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3214

"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.

3215

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3216

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3217

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3218

"name": "A String", # [Output Only] Name of the operation.

3219

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3220

"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.

3221

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3222

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3223

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3224

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3225

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3226

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3227

"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.

3228

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3229

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3230

{

3231

"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.

3232

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

3233

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

3234

{

3235

"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).

3236

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3237

},

3238

],

3239

"message": "A String", # [Output Only] A human-readable description of the warning code.

3240

},

3241

],

3242

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3247

<code class="details" id="resume">resume(project, zone, instance, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3248

<pre>Resumes an instance that was suspended using the instances().suspend method.

3249

3250

Args:

3251

project: string, Project ID for this request. (required)

3252

zone: string, The name of the zone for this request. (required)

3253

instance: string, Name of the instance resource to resume. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3254

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3255

The object takes the form of:

3256

3257

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3258

"disks": [ # Array of disks associated with this instance that are protected with a customer-supplied encryption key.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3259

#

3260

# In order to resume the instance, the disk url and its corresponding key must be provided.

3261

#

3262

# If the disk is not protected with a customer-supplied encryption key it should not be specified.

3263

{

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3264

"diskEncryptionKey": { # Decrypts data associated with the disk with a customer-supplied encryption key.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3265

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3266

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

3267

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3268

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3269

#

3270

# The key must meet the following requirements before you can provide it to Compute Engine:

3271

# - The key is wrapped using a RSA public key certificate provided by Google.

3272

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

3273

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3274

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3275

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3276

"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3277

},

3278

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3279

"instanceEncryptionKey": { # Decrypts data associated with an instance that is protected with a customer-supplied encryption key.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3280

#

3281

# If the instance you are starting is protected with a customer-supplied encryption key, the correct key must be provided otherwise the instance resume will not succeed.

3282

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3283

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

3284

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3285

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

3286

#

3287

# The key must meet the following requirements before you can provide it to Compute Engine:

3288

# - The key is wrapped using a RSA public key certificate provided by Google.

3289

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

3290

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

3291

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

3292

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3293

}

3294

3295

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.

3296

3297

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.

3298

3299

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

3300

3301

Returns:

3302

An object of the form:

3303

3304

{ # Represents an Operation resource.

3305

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3306

# Google Compute Engine has three Operation resources:

3307

#

3308

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

3309

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3310

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

3311

#

3312

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3313

# - For global operations, use the `globalOperations` resource.

3314

# - For regional operations, use the `regionOperations` resource.

3315

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3316

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3317

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3318

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3319

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3320

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3321

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3322

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3323

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3324

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3325

"code": "A String", # [Output Only] The error type identifier for this error.

3326

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3327

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3328

},

3329

],

3330

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3331

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3332

"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.

3333

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3334

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3335

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3336

"name": "A String", # [Output Only] Name of the operation.

3337

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3338

"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.

3339

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3340

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3341

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3342

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3343

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3344

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3345

"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.

3346

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3347

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3348

{

3349

"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.

3350

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

3351

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

3352

{

3353

"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).

3354

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3355

},

3356

],

3357

"message": "A String", # [Output Only] A human-readable description of the warning code.

3358

},

3359

],

3360

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="setDeletionProtection">setDeletionProtection(project, zone, resource, deletionProtection=None, requestId=None)</code>

3366

<pre>Sets deletion protection on the instance.

3367

3368

Args:

3369

project: string, Project ID for this request. (required)

3370

zone: string, The name of the zone for this request. (required)

3371

resource: string, Name or id of the resource for this request. (required)

3372

deletionProtection: boolean, Whether the resource should be protected against deletion.

3373

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.

3374

3375

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.

3376

3377

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

3378

3379

Returns:

3380

An object of the form:

3381

3382

{ # Represents an Operation resource.

3383

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3384

# Google Compute Engine has three Operation resources:

3385

#

3386

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

3387

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3388

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

3389

#

3390

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3391

# - For global operations, use the `globalOperations` resource.

3392

# - For regional operations, use the `regionOperations` resource.

3393

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3394

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3395

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3396

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3397

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3398

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3399

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3400

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3401

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3402

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3403

"code": "A String", # [Output Only] The error type identifier for this error.

3404

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3405

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3406

},

3407

],

3408

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3409

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3410

"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.

3411

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3412

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3413

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3414

"name": "A String", # [Output Only] Name of the operation.

3415

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3416

"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.

3417

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3418

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3419

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3420

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3421

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3422

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3423

"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.

3424

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3425

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3426

{

3427

"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.

3428

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

3429

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

3430

{

3431

"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).

3432

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3433

},

3434

],

3435

"message": "A String", # [Output Only] A human-readable description of the warning code.

3436

},

3437

],

3438

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="setDiskAutoDelete">setDiskAutoDelete(project, zone, instance, autoDelete, deviceName, requestId=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3444

<pre>Sets the auto-delete flag for a disk attached to an instance.

3445

3446

Args:

3447

project: string, Project ID for this request. (required)

3448

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3449

instance: string, The instance name for this request. (required)

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3450

autoDelete: boolean, Whether to auto-delete the disk when the instance is deleted. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3451

deviceName: string, The device name of the disk to modify. Make a get() request on the instance to view currently attached disks and device names. (required)

3452

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.

3453

3454

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.

3455

3456

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]

3457

3458

Returns:

3459

An object of the form:

3460

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3461

{ # Represents an Operation resource.

3462

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3463

# Google Compute Engine has three Operation resources:

3464

#

3465

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

3466

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3467

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

3468

#

3469

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3470

# - For global operations, use the `globalOperations` resource.

3471

# - For regional operations, use the `regionOperations` resource.

3472

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3473

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3474

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3475

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3476

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3477

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3478

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3479

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3480

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3481

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3482

"code": "A String", # [Output Only] The error type identifier for this error.

3483

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3484

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3485

},

3486

],

3487

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3488

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3489

"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.

3490

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3491

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3492

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3493

"name": "A String", # [Output Only] Name of the operation.

3494

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3495

"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.

3496

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3497

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3498

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3499

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3500

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3501

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3502

"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.

3503

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3504

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3505

{

3506

"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.

3507

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

3508

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

3509

{

3510

"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).

3511

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3512

},

3513

],

3514

"message": "A String", # [Output Only] A human-readable description of the warning code.

3515

},

3516

],

3517

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3522

<code class="details" id="setIamPolicy">setIamPolicy(project, zone, resource, body=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3523

<pre>Sets the access control policy on the specified resource. Replaces any existing policy.

3524

3525

Args:

3526

project: string, Project ID for this request. (required)

3527

zone: string, The name of the zone for this request. (required)

3528

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3529

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3530

The object takes the form of:

3531

3532

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3533

"bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings.

3534

{ # Associates `members` with a `role`.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

3535

"bindingId": "A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3536

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding.

3537

#

3538

# If the condition evaluates to `true`, then this binding applies to the current request.

3539

#

3540

# If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.

3541

#

3542

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

3543

#

3544

# Example (Comparison):

3545

#

3546

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

3547

#

3548

# Example (Equality):

3549

#

3550

# title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'"

3555

#

3556

# Example (Data Manipulation):

3557

#

3558

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

3559

#

3560

# The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

3561

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

3562

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

3563

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

3564

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

3565

},

3566

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

3567

#

3568

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

3569

#

3570

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

3571

#

3572

# * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .

#

#

#

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

3577

#

3578

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

3579

#

3580

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding.

3581

#

3582

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding.

3583

#

3584

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.

#

#

#

# * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

3589

"A String",

3590

],

3591

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

3592

},

3593

],

3594

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.

3595

"policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3596

#

3597

#

3598

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3599

# A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3600

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3601

# For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3602

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3603

# **JSON example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3604

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3605

# { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3606

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3607

# **YAML example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3608

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3609

# bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3610

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3611

# For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3612

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3613

{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.

3614

#

3615

# If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.

3616

#

3617

# Example Policy with multiple AuditConfigs:

3618

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3619

# { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3620

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3621

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3622

"auditLogConfigs": [ # The configuration for logging of each type of permission.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3623

{ # Provides the configuration for logging a type of permissions. Example:

3624

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3625

# { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3626

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3627

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

3628

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

3629

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3630

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3631

"ignoreChildExemptions": True or False,

3632

"logType": "A String", # The log type that this config enables.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3633

},

3634

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"exemptedMembers": [

"A String",

],

"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3639

},

3640

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3641

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3642

{ # Associates `members` with a `role`.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

3643

"bindingId": "A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3644

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding.

3645

#

3646

# If the condition evaluates to `true`, then this binding applies to the current request.

3647

#

3648

# If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.

3649

#

3650

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

3651

#

3652

# Example (Comparison):

3653

#

3654

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

3655

#

3656

# Example (Equality):

3657

#

3658

# title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'"

3663

#

3664

# Example (Data Manipulation):

3665

#

3666

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

3667

#

3668

# The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

3669

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

3670

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

3671

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

3672

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

3673

},

3674

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3675

#

3676

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

3677

#

3678

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

3679

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3680

# * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

#

#

#

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

3685

#

3686

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

3687

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3688

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding.

3689

#

3690

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding.

3691

#

3692

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.

3693

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3694

#

3695

#

3696

# * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3697

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3698

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3699

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3700

},

3701

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3702

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.

3703

#

3704

# **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

3705

"iamOwned": True or False,

3706

"rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.

3707

{ # A rule to be applied in a Policy.

3708

"action": "A String", # Required

3709

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

3710

{ # A condition to be met.

3711

"iam": "A String", # Trusted attributes supplied by the IAM system.

3712

"op": "A String", # An operator to apply the subject with.

3713

"svc": "A String", # Trusted attributes discharged by the service.

3714

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

3715

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

3721

"ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.

3722

"A String",

3723

],

3724

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

3725

{ # Specifies what kind of log the caller must write

3726

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

3727

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

3728

"permissionType": "A String", # The type of the permission that was checked.

3729

},

3730

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

3731

},

3732

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

3733

#

3734

# Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended.

3735

#

3736

# Field names correspond to IAM request parameters and field values are their respective values.

3737

#

3738

# Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields.

3739

#

3740

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

3741

"customFields": [ # Custom fields.

3742

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

3743

"name": "A String", # Name is the field name.

3744

"value": "A String", # Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext.

3745

},

3746

],

3747

"field": "A String", # The field value to attribute.

3748

"metric": "A String", # The metric to update.

3749

},

3750

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

3751

"logMode": "A String",

},

},

],

"notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.

3756

"A String",

3757

],

3758

"permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.

3759

"A String",

3760

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3761

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3762

],

3763

"version": 42, # Specifies the format of the policy.

3764

#

3765

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

3766

#

3767

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

3768

#

3769

# * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions

3770

#

3771

# **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

3772

#

3773

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

3774

#

3775

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

3776

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}

Returns:

An object of the form:

3782

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3783

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3784

#

3785

#

3786

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3787

# A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3788

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3789

# For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3790

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3791

# **JSON example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3792

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3793

# { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3794

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3795

# **YAML example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3796

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3797

# bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3798

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3799

# For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3800

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3801

{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.

3802

#

3803

# If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.

3804

#

3805

# Example Policy with multiple AuditConfigs:

3806

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3807

# { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3808

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3809

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3810

"auditLogConfigs": [ # The configuration for logging of each type of permission.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3811

{ # Provides the configuration for logging a type of permissions. Example:

3812

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3813

# { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3814

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3815

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

3816

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

3817

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3818

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3819

"ignoreChildExemptions": True or False,

3820

"logType": "A String", # The log type that this config enables.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3821

},

3822

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"exemptedMembers": [

"A String",

],

"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3827

},

3828

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3829

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3830

{ # Associates `members` with a `role`.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

3831

"bindingId": "A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3832

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding.

3833

#

3834

# If the condition evaluates to `true`, then this binding applies to the current request.

3835

#

3836

# If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.

3837

#

3838

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

3839

#

3840

# Example (Comparison):

3841

#

3842

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

3843

#

3844

# Example (Equality):

3845

#

3846

# title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'"

3851

#

3852

# Example (Data Manipulation):

3853

#

3854

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

3855

#

3856

# The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

3857

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

3858

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

3859

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

3860

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

3861

},

3862

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3863

#

3864

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

3865

#

3866

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

3867

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3868

# * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

#

#

#

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

3873

#

3874

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

3875

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3876

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding.

3877

#

3878

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding.

3879

#

3880

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.

3881

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3882

#

3883

#

3884

# * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3885

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3886

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3887

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3888

},

3889

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3890

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.

3891

#

3892

# **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

3893

"iamOwned": True or False,

3894

"rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.

3895

{ # A rule to be applied in a Policy.

3896

"action": "A String", # Required

3897

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

3898

{ # A condition to be met.

3899

"iam": "A String", # Trusted attributes supplied by the IAM system.

3900

"op": "A String", # An operator to apply the subject with.

3901

"svc": "A String", # Trusted attributes discharged by the service.

3902

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

3903

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

3909

"ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.

3910

"A String",

3911

],

3912

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

3913

{ # Specifies what kind of log the caller must write

3914

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

3915

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

3916

"permissionType": "A String", # The type of the permission that was checked.

3917

},

3918

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

3919

},

3920

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

3921

#

3922

# Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended.

3923

#

3924

# Field names correspond to IAM request parameters and field values are their respective values.

3925

#

3926

# Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields.

3927

#

3928

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

3929

"customFields": [ # Custom fields.

3930

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

3931

"name": "A String", # Name is the field name.

3932

"value": "A String", # Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext.

3933

},

3934

],

3935

"field": "A String", # The field value to attribute.

3936

"metric": "A String", # The metric to update.

3937

},

3938

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

3939

"logMode": "A String",

},

},

],

"notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.

3944

"A String",

3945

],

3946

"permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.

"A String",

],

},

],

"version": 42, # Specifies the format of the policy.

3952

#

3953

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

3954

#

3955

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

3956

#

3957

# * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions

3958

#

3959

# **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

3960

#

3961

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

3962

#

3963

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3968

<code class="details" id="setLabels">setLabels(project, zone, instance, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3969

<pre>Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3970

3971

Args:

3972

project: string, Project ID for this request. (required)

3973

zone: string, The name of the zone for this request. (required)

3974

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3975

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3976

The object takes the form of:

3977

3978

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3979

"labelFingerprint": "A String", # Fingerprint of the previous set of labels for this resource, used to prevent conflicts. Provide the latest fingerprint value when making a request to add or change labels.

3980

"labels": {

3981

"a_key": "A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

},

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3985

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.

3986

3987

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.

3988

3989

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]

3990

3991

Returns:

3992

An object of the form:

3993

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3994

{ # Represents an Operation resource.

3995

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3996

# Google Compute Engine has three Operation resources:

3997

#

3998

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

3999

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4000

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4001

#

4002

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4003

# - For global operations, use the `globalOperations` resource.

4004

# - For regional operations, use the `regionOperations` resource.

4005

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4006

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4007

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4008

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4009

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4010

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4011

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4012

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4013

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

4014

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4015

"code": "A String", # [Output Only] The error type identifier for this error.

4016

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4017

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

4018

},

4019

],

4020

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4021

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4022

"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.

4023

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4024

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4025

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4026

"name": "A String", # [Output Only] Name of the operation.

4027

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4028

"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.

4029

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4030

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4031

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4032

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4033

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4034

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4035

"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.

4036

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4037

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4038

{

4039

"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.

4040

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4041

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4042

{

4043

"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).

4044

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4045

},

4046

],

4047

"message": "A String", # [Output Only] A human-readable description of the warning code.

4048

},

4049

],

4050

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4055

<code class="details" id="setMachineResources">setMachineResources(project, zone, instance, body=None, requestId=None)</code>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

4056

<pre>Changes the number and/or type of accelerator for a stopped instance to the values specified in the request.

4057

4058

Args:

4059

project: string, Project ID for this request. (required)

4060

zone: string, The name of the zone for this request. (required)

4061

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4062

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

4063

The object takes the form of:

4064

4065

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4066

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

4067

{ # A specification of the type and number of accelerator cards attached to the instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4068

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

4069

"acceleratorType": "A String", # Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

},

],

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4074

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.

4075

4076

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.

4077

4078

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

4079

4080

Returns:

4081

An object of the form:

4082

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4083

{ # Represents an Operation resource.

4084

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4085

# Google Compute Engine has three Operation resources:

4086

#

4087

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4088

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4089

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4090

#

4091

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4092

# - For global operations, use the `globalOperations` resource.

4093

# - For regional operations, use the `regionOperations` resource.

4094

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4095

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4096

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4097

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4098

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4099

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4100

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4101

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4102

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4103

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4104

"code": "A String", # [Output Only] The error type identifier for this error.

4105

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4106

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4107

},

4108

],

4109

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4110

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4111

"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.

4112

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4113

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4114

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4115

"name": "A String", # [Output Only] Name of the operation.

4116

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4117

"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.

4118

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4119

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4120

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4121

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4122

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4123

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4124

"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.

4125

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4126

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4127

{

4128

"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.

4129

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4130

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4131

{

4132

"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).

4133

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4134

},

4135

],

4136

"message": "A String", # [Output Only] A human-readable description of the warning code.

4137

},

4138

],

4139

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4144

<code class="details" id="setMachineType">setMachineType(project, zone, instance, body=None, requestId=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4145

<pre>Changes the machine type for a stopped instance to the machine type specified in the request.

4146

4147

Args:

4148

project: string, Project ID for this request. (required)

4149

zone: string, The name of the zone for this request. (required)

4150

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4151

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4152

The object takes the form of:

4153

4154

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4155

"machineType": "A String", # Full or partial URL of the machine type resource. See Machine Types for a full list of machine types. For example: zones/us-central1-f/machineTypes/n1-standard-1

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4156

}

4157

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4158

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.

4159

4160

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.

4161

4162

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]

4163

4164

Returns:

4165

An object of the form:

4166

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4167

{ # Represents an Operation resource.

4168

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4169

# Google Compute Engine has three Operation resources:

4170

#

4171

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4172

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4173

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4174

#

4175

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4176

# - For global operations, use the `globalOperations` resource.

4177

# - For regional operations, use the `regionOperations` resource.

4178

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4179

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4180

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4181

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4182

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4183

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4184

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4185

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4186

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4187

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4188

"code": "A String", # [Output Only] The error type identifier for this error.

4189

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4190

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4191

},

4192

],

4193

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4194

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4195

"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.

4196

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4197

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4198

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4199

"name": "A String", # [Output Only] Name of the operation.

4200

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4201

"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.

4202

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4203

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4204

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4205

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4206

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4207

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4208

"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.

4209

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4210

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4211

{

4212

"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.

4213

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4214

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4215

{

4216

"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).

4217

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4218

},

4219

],

4220

"message": "A String", # [Output Only] A human-readable description of the warning code.

4221

},

4222

],

4223

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4228

<code class="details" id="setMetadata">setMetadata(project, zone, instance, body=None, requestId=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4229

<pre>Sets metadata for the specified instance to the data included in the request.

4230

4231

Args:

4232

project: string, Project ID for this request. (required)

4233

zone: string, The name of the zone for this request. (required)

4234

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4235

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4236

The object takes the form of:

4237

4238

{ # A metadata key/value entry.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4239

"fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4240

#

4241

# To see the latest fingerprint, make a get() request to retrieve the resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4242

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

4243

{

4244

"key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.

4245

"value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).

4246

},

4247

],

4248

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4249

}

4250

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4251

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.

4252

4253

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.

4254

4255

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]

4256

4257

Returns:

4258

An object of the form:

4259

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4260

{ # Represents an Operation resource.

4261

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4262

# Google Compute Engine has three Operation resources:

4263

#

4264

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4265

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4266

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4267

#

4268

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4269

# - For global operations, use the `globalOperations` resource.

4270

# - For regional operations, use the `regionOperations` resource.

4271

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4272

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4273

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4274

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4275

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4276

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4277

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4278

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4279

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4280

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4281

"code": "A String", # [Output Only] The error type identifier for this error.

4282

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4283

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4284

},

4285

],

4286

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4287

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4288

"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.

4289

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4290

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4291

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4292

"name": "A String", # [Output Only] Name of the operation.

4293

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4294

"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.

4295

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4296

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4297

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4298

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4299

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4300

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4301

"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.

4302

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4303

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4304

{

4305

"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.

4306

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4307

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4308

{

4309

"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).

4310

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4311

},

4312

],

4313

"message": "A String", # [Output Only] A human-readable description of the warning code.

4314

},

4315

],

4316

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4321

<code class="details" id="setMinCpuPlatform">setMinCpuPlatform(project, zone, instance, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4322

<pre>Changes the minimum CPU platform that this instance should use. This method can only be called on a stopped instance. For more information, read Specifying a Minimum CPU Platform.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4323

4324

Args:

4325

project: string, Project ID for this request. (required)

4326

zone: string, The name of the zone for this request. (required)

4327

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4328

body: object, The request body.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4329

The object takes the form of:

4330

4331

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4332

"minCpuPlatform": "A String", # Minimum cpu/platform this instance should be started at.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4333

}

4334

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4335

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.

4336

4337

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.

4338

4339

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4340

4341

Returns:

4342

An object of the form:

4343

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4344

{ # Represents an Operation resource.

4345

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4346

# Google Compute Engine has three Operation resources:

4347

#

4348

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4349

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4350

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4351

#

4352

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4353

# - For global operations, use the `globalOperations` resource.

4354

# - For regional operations, use the `regionOperations` resource.

4355

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4356

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4357

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4358

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4359

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4360

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4361

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4362

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4363

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4364

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4365

"code": "A String", # [Output Only] The error type identifier for this error.

4366

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4367

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4368

},

4369

],

4370

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4371

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4372

"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.

4373

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4374

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4375

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4376

"name": "A String", # [Output Only] Name of the operation.

4377

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4378

"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.

4379

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4380

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4381

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4382

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4383

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4384

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4385

"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.

4386

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4387

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4388

{

4389

"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.

4390

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4391

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4392

{

4393

"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).

4394

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4395

},

4396

],

4397

"message": "A String", # [Output Only] A human-readable description of the warning code.

4398

},

4399

],

4400

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4405

<code class="details" id="setName">setName(project, zone, instance, body=None, requestId=None)</code>

4406

<pre>Sets name of an instance.

4407

4408

Args:

4409

project: string, Project ID for this request. (required)

4410

zone: string, The name of the zone for this request. (required)

4411

instance: string, The instance name for this request. (required)

4412

body: object, The request body.

4413

The object takes the form of:

4414

4415

{

4416

"currentName": "A String", # The current name of this resource, used to prevent conflicts. Provide the latest name when making a request to change name.

4417

"name": "A String", # The name to be applied to the instance. Needs to be RFC 1035 compliant.

4418

}

4419

4420

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.

4421

4422

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.

4423

4424

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

4425

4426

Returns:

4427

An object of the form:

4428

4429

{ # Represents an Operation resource.

4430

#

4431

# Google Compute Engine has three Operation resources:

4432

#

4433

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4434

#

4435

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4436

#

4437

# Operations can be global, regional or zonal.

4438

# - For global operations, use the `globalOperations` resource.

4439

# - For regional operations, use the `regionOperations` resource.

4440

# - For zonal operations, use the `zonalOperations` resource.

4441

#

4442

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

4443

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4444

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4445

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4446

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4447

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4448

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

4449

{

4450

"code": "A String", # [Output Only] The error type identifier for this error.

4451

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4452

"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`.

4457

"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.

4458

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4459

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4460

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4461

"name": "A String", # [Output Only] Name of the operation.

4462

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4463

"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.

4464

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4465

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4466

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4467

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4468

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4469

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4470

"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.

4471

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4472

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4473

{

4474

"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.

4475

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4476

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4477

{

4478

"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).

4479

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4480

},

4481

],

4482

"message": "A String", # [Output Only] A human-readable description of the warning code.

4483

},

4484

],

4485

"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]

4490

<code class="details" id="setScheduling">setScheduling(project, zone, instance, body=None, requestId=None)</code>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4491

<pre>Sets an instance's scheduling options. You can only call this method on a stopped instance, that is, a VM instance that is in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4492

4493

Args:

4494

project: string, Project ID for this request. (required)

4495

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4496

instance: string, Instance name for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4497

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4498

The object takes the form of:

4499

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4500

{ # Sets the scheduling options for an Instance. NextID: 13

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4501

"automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4502

#

4503

# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4504

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

4505

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4506

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4507

"key": "A String", # Corresponds to the label key of Node resource.

4508

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

4509

"values": [ # Corresponds to the label values of Node resource.

4510

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4511

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4512

},

4513

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4514

"onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4515

"preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4516

}

4517

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4518

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.

4519

4520

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.

4521

4522

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]

4523

4524

Returns:

4525

An object of the form:

4526

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4527

{ # Represents an Operation resource.

4528

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4529

# Google Compute Engine has three Operation resources:

4530

#

4531

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4532

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4533

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4534

#

4535

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4536

# - For global operations, use the `globalOperations` resource.

4537

# - For regional operations, use the `regionOperations` resource.

4538

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4539

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4540

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4541

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4542

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4543

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4544

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4545

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4546

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4547

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4548

"code": "A String", # [Output Only] The error type identifier for this error.

4549

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4550

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4551

},

4552

],

4553

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4554

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4555

"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.

4556

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4557

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4558

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4559

"name": "A String", # [Output Only] Name of the operation.

4560

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4561

"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.

4562

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4563

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4564

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4565

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4566

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4567

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4568

"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.

4569

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4570

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4571

{

4572

"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.

4573

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4574

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4575

{

4576

"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).

4577

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4578

},

4579

],

4580

"message": "A String", # [Output Only] A human-readable description of the warning code.

4581

},

4582

],

4583

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4588

<code class="details" id="setServiceAccount">setServiceAccount(project, zone, instance, body=None, requestId=None)</code>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

4589

<pre>Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

4590

4591

Args:

4592

project: string, Project ID for this request. (required)

4593

zone: string, The name of the zone for this request. (required)

4594

instance: string, Name of the instance resource to start. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4595

body: object, The request body.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

4596

The object takes the form of:

4597

4598

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4599

"email": "A String", # Email address of the service account.

4600

"scopes": [ # The list of scopes to be made available for this service account.

4601

"A String",

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

4602

],

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

4603

}

4604

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4605

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.

4606

4607

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.

4608

4609

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

4610

4611

Returns:

4612

An object of the form:

4613

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4614

{ # Represents an Operation resource.

4615

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4616

# Google Compute Engine has three Operation resources:

4617

#

4618

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4619

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4620

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4621

#

4622

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4623

# - For global operations, use the `globalOperations` resource.

4624

# - For regional operations, use the `regionOperations` resource.

4625

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4626

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4627

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4628

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4629

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4630

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4631

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4632

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4633

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

4634

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4635

"code": "A String", # [Output Only] The error type identifier for this error.

4636

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4637

"message": "A String", # [Output Only] An optional, human-readable error message.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

4638

},

4639

],

4640

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4641

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4642

"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.

4643

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4644

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4645

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4646

"name": "A String", # [Output Only] Name of the operation.

4647

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4648

"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.

4649

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4650

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4651

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4652

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4653

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4654

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4655

"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.

4656

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4657

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4658

{

4659

"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.

4660

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4661

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4662

{

4663

"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).

4664

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4665

},

4666

],

4667

"message": "A String", # [Output Only] A human-readable description of the warning code.

4668

},

4669

],

4670

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4675

<code class="details" id="setShieldedInstanceIntegrityPolicy">setShieldedInstanceIntegrityPolicy(project, zone, instance, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4676

<pre>Sets the Shielded Instance integrity policy for an instance. You can only use this method on a running instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

4677

4678

Args:

4679

project: string, Project ID for this request. (required)

4680

zone: string, The name of the zone for this request. (required)

4681

instance: string, Name or id of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4682

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4683

The object takes the form of:

4684

4685

{ # The policy describes the baseline against which Instance boot integrity is measured.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4686

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4687

}

4688

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4689

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.

4690

4691

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.

4692

4693

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]

4694

4695

Returns:

4696

An object of the form:

4697

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4698

{ # Represents an Operation resource.

4699

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4700

# Google Compute Engine has three Operation resources:

4701

#

4702

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4703

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4704

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4705

#

4706

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4707

# - For global operations, use the `globalOperations` resource.

4708

# - For regional operations, use the `regionOperations` resource.

4709

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4710

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4711

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4712

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4713

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4714

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4715

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4716

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4717

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4718

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4719

"code": "A String", # [Output Only] The error type identifier for this error.

4720

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4721

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4722

},

4723

],

4724

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4725

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4726

"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.

4727

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4728

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4729

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4730

"name": "A String", # [Output Only] Name of the operation.

4731

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4732

"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.

4733

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4734

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4735

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4736

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4737

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4738

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4739

"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.

4740

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4741

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4742

{

4743

"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.

4744

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4745

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4746

{

4747

"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).

4748

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4749

},

4750

],

4751

"message": "A String", # [Output Only] A human-readable description of the warning code.

4752

},

4753

],

4754

"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="setShieldedVmIntegrityPolicy">setShieldedVmIntegrityPolicy(project, zone, instance, body=None, requestId=None)</code>

4760

<pre>Sets the Shielded VM integrity policy for a VM instance. You can only use this method on a running VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

4761

4762

Args:

4763

project: string, Project ID for this request. (required)

4764

zone: string, The name of the zone for this request. (required)

4765

instance: string, Name of the instance scoping this request. (required)

4766

body: object, The request body.

4767

The object takes the form of:

4768

4769

{ # The policy describes the baseline against which VM instance boot integrity is measured.

4770

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

4771

}

4772

4773

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.

4774

4775

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.

4776

4777

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

4778

4779

Returns:

4780

An object of the form:

4781

4782

{ # Represents an Operation resource.

4783

#

4784

# Google Compute Engine has three Operation resources:

4785

#

4786

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4787

#

4788

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4789

#

4790

# Operations can be global, regional or zonal.

4791

# - For global operations, use the `globalOperations` resource.

4792

# - For regional operations, use the `regionOperations` resource.

4793

# - For zonal operations, use the `zonalOperations` resource.

4794

#

4795

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

4796

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4797

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4798

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4799

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4800

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4801

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

4802

{

4803

"code": "A String", # [Output Only] The error type identifier for this error.

4804

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4805

"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`.

4810

"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.

4811

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4812

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4813

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4814

"name": "A String", # [Output Only] Name of the operation.

4815

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4816

"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.

4817

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4818

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4819

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4820

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4821

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4822

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4823

"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.

4824

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4825

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4826

{

4827

"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.

4828

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4829

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4830

{

4831

"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).

4832

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4833

},

4834

],

4835

"message": "A String", # [Output Only] A human-readable description of the warning code.

4836

},

4837

],

4838

"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="setTags">setTags(project, zone, instance, body=None, requestId=None)</code>

4844

<pre>Sets network tags for the specified instance to the data included in the request.

4845

4846

Args:

4847

project: string, Project ID for this request. (required)

4848

zone: string, The name of the zone for this request. (required)

4849

instance: string, Name of the instance scoping this request. (required)

4850

body: object, The request body.

4851

The object takes the form of:

4852

4853

{ # A set of instance tags.

4854

"fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the tags' contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags.

4855

#

4856

# To see the latest fingerprint, make get() request to the instance.

4857

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

"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.

4863

4864

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.

4865

4866

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

4867

4868

Returns:

4869

An object of the form:

4870

4871

{ # Represents an Operation resource.

4872

#

4873

# Google Compute Engine has three Operation resources:

4874

#

4875

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4876

#

4877

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4878

#

4879

# Operations can be global, regional or zonal.

4880

# - For global operations, use the `globalOperations` resource.

4881

# - For regional operations, use the `regionOperations` resource.

4882

# - For zonal operations, use the `zonalOperations` resource.

4883

#

4884

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

4885

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4886

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4887

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4888

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4889

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4890

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

4891

{

4892

"code": "A String", # [Output Only] The error type identifier for this error.

4893

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4894

"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`.

4899

"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.

4900

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4901

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4902

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4903

"name": "A String", # [Output Only] Name of the operation.

4904

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4905

"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.

4906

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4907

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4908

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4909

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4910

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4911

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4912

"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.

4913

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4914

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4915

{

4916

"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.

4917

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4918

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4919

{

4920

"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).

4921

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4922

},

4923

],

4924

"message": "A String", # [Output Only] A human-readable description of the warning code.

4925

},

4926

],

4927

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4932

<code class="details" id="simulateMaintenanceEvent">simulateMaintenanceEvent(project, zone, instance)</code>

4933

<pre>Simulates a maintenance event on the instance.

4934

4935

Args:

4936

project: string, Project ID for this request. (required)

4937

zone: string, The name of the zone for this request. (required)

4938

instance: string, Name of the instance scoping this request. (required)

4939

4940

Returns:

4941

An object of the form:

4942

4943

{ # Represents an Operation resource.

4944

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4945

# Google Compute Engine has three Operation resources:

4946

#

4947

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4948

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4949

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4950

#

4951

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4952

# - For global operations, use the `globalOperations` resource.

4953

# - For regional operations, use the `regionOperations` resource.

4954

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4955

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4956

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4957

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4958

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4959

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4960

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4961

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4962

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4963

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4964

"code": "A String", # [Output Only] The error type identifier for this error.

4965

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4966

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4967

},

4968

],

4969

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4970

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4971

"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.

4972

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4973

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4974

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4975

"name": "A String", # [Output Only] Name of the operation.

4976

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4977

"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.

4978

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4979

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4980

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4981

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4982

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4983

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4984

"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.

4985

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4986

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4987

{

4988

"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.

4989

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4990

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4991

{

4992

"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).

4993

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4994

},

4995

],

4996

"message": "A String", # [Output Only] A human-readable description of the warning code.

4997

},

4998

],

4999

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="start">start(project, zone, instance, requestId=None)</code>

5005

<pre>Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5006

5007

Args:

5008

project: string, Project ID for this request. (required)

5009

zone: string, The name of the zone for this request. (required)

5010

instance: string, Name of the instance resource to start. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5011

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.

5012

5013

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.

5014

5015

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]

5016

5017

Returns:

5018

An object of the form:

5019

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5020

{ # Represents an Operation resource.

5021

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5022

# Google Compute Engine has three Operation resources:

5023

#

5024

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5025

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5026

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5027

#

5028

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5029

# - For global operations, use the `globalOperations` resource.

5030

# - For regional operations, use the `regionOperations` resource.

5031

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5032

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5033

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5034

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5035

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5036

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5037

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5038

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5039

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5040

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5041

"code": "A String", # [Output Only] The error type identifier for this error.

5042

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5043

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5044

},

5045

],

5046

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5047

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5048

"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.

5049

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5050

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5051

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5052

"name": "A String", # [Output Only] Name of the operation.

5053

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5054

"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.

5055

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5056

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5057

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5058

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5059

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5060

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5061

"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.

5062

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5063

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5064

{

5065

"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.

5066

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5067

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5068

{

5069

"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).

5070

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5071

},

5072

],

5073

"message": "A String", # [Output Only] A human-readable description of the warning code.

5074

},

5075

],

5076

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5081

<code class="details" id="startWithEncryptionKey">startWithEncryptionKey(project, zone, instance, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5082

<pre>Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5083

5084

Args:

5085

project: string, Project ID for this request. (required)

5086

zone: string, The name of the zone for this request. (required)

5087

instance: string, Name of the instance resource to start. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5088

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5089

The object takes the form of:

5090

5091

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5092

"disks": [ # Array of disks associated with this instance that are protected with a customer-supplied encryption key.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5093

#

5094

# In order to start the instance, the disk url and its corresponding key must be provided.

5095

#

5096

# If the disk is not protected with a customer-supplied encryption key it should not be specified.

5097

{

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5098

"diskEncryptionKey": { # Decrypts data associated with the disk with a customer-supplied encryption key.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5099

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

5100

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

5101

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

5102

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5103

#

5104

# The key must meet the following requirements before you can provide it to Compute Engine:

5105

# - The key is wrapped using a RSA public key certificate provided by Google.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5106

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5107

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5108

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5109

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5110

"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

},

],

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5115

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.

5116

5117

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.

5118

5119

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]

5120

5121

Returns:

5122

An object of the form:

5123

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5124

{ # Represents an Operation resource.

5125

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5126

# Google Compute Engine has three Operation resources:

5127

#

5128

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5129

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5130

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5131

#

5132

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5133

# - For global operations, use the `globalOperations` resource.

5134

# - For regional operations, use the `regionOperations` resource.

5135

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5136

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5137

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5138

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5139

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5140

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5141

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5142

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5143

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5144

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5145

"code": "A String", # [Output Only] The error type identifier for this error.

5146

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5147

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5148

},

5149

],

5150

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5151

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5152

"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.

5153

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5154

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5155

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5156

"name": "A String", # [Output Only] Name of the operation.

5157

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5158

"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.

5159

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5160

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5161

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5162

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5163

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5164

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5165

"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.

5166

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5167

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5168

{

5169

"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.

5170

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5171

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5172

{

5173

"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).

5174

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5175

},

5176

],

5177

"message": "A String", # [Output Only] A human-readable description of the warning code.

5178

},

5179

],

5180

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5185

<code class="details" id="stop">stop(project, zone, instance, requestId=None)</code>

5186

<pre>Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur VM usage charges while they are stopped. However, resources that the VM is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5187

5188

Args:

5189

project: string, Project ID for this request. (required)

5190

zone: string, The name of the zone for this request. (required)

5191

instance: string, Name of the instance resource to stop. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5192

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.

5193

5194

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.

5195

5196

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]

5197

5198

Returns:

5199

An object of the form:

5200

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5201

{ # Represents an Operation resource.

5202

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5203

# Google Compute Engine has three Operation resources:

5204

#

5205

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5206

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5207

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5208

#

5209

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5210

# - For global operations, use the `globalOperations` resource.

5211

# - For regional operations, use the `regionOperations` resource.

5212

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5213

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5214

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5215

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5216

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5217

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5218

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5219

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5220

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5221

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5222

"code": "A String", # [Output Only] The error type identifier for this error.

5223

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5224

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5225

},

5226

],

5227

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5228

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5229

"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.

5230

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5231

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5232

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5233

"name": "A String", # [Output Only] Name of the operation.

5234

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5235

"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.

5236

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5237

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5238

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5239

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5240

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5241

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5242

"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.

5243

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5244

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5245

{

5246

"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.

5247

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5248

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5249

{

5250

"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).

5251

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5252

},

5253

],

5254

"message": "A String", # [Output Only] A human-readable description of the warning code.

5255

},

5256

],

5257

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="suspend">suspend(project, zone, instance, discardLocalSsd=None, requestId=None)</code>

5263

<pre>This method suspends a running instance, saving its state to persistent storage, and allows you to resume the instance at a later time. Suspended instances incur reduced per-minute, virtual machine usage charges while they are suspended. Any resources the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted.

5264

5265

Args:

5266

project: string, Project ID for this request. (required)

5267

zone: string, The name of the zone for this request. (required)

5268

instance: string, Name of the instance resource to suspend. (required)

5269

discardLocalSsd: boolean, If true, discard the contents of any attached localSSD partitions. Default value is false (== preserve localSSD data).

5270

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.

5271

5272

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.

5273

5274

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

5275

5276

Returns:

5277

An object of the form:

5278

5279

{ # Represents an Operation resource.

5280

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5281

# Google Compute Engine has three Operation resources:

5282

#

5283

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5284

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5285

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5286

#

5287

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5288

# - For global operations, use the `globalOperations` resource.

5289

# - For regional operations, use the `regionOperations` resource.

5290

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5291

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5292

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5293

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5294

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5295

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5296

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5297

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5298

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5299

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5300

"code": "A String", # [Output Only] The error type identifier for this error.

5301

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5302

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5303

},

5304

],

5305

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5306

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5307

"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.

5308

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5309

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5310

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5311

"name": "A String", # [Output Only] Name of the operation.

5312

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5313

"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.

5314

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5315

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5316

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5317

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5318

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5319

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5320

"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.

5321

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5322

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5323

{

5324

"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.

5325

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5326

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5327

{

5328

"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).

5329

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5330

},

5331

],

5332

"message": "A String", # [Output Only] A human-readable description of the warning code.

5333

},

5334

],

5335

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5340

<code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5341

<pre>Returns permissions that a caller has on the specified resource.

5342

5343

Args:

5344

project: string, Project ID for this request. (required)

5345

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5346

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5347

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5348

The object takes the form of:

5349

5350

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5351

"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.

5352

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

],

}

Returns:

An object of the form:

5359

5360

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5361

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.

5362

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

],

}</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5367

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5368

<code class="details" id="update">update(project, zone, instance, body=None, minimalAction=None, mostDisruptiveAllowedAction=None, requestId=None)</code>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5369

<pre>Updates an instance only if the necessary resources are available. This method can update only a specific set of instance properties. See Updating a running instance for a list of updatable instance properties.

5370

5371

Args:

5372

project: string, Project ID for this request. (required)

5373

zone: string, The name of the zone for this request. (required)

5374

instance: string, Name of the instance resource to update. (required)

5375

body: object, The request body.

5376

The object takes the form of:

5377

5378

{ # Represents an Instance resource.

5379

#

5380

# An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. (== resource_for {$api_version}.instances ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5381

"canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5382

"confidentialInstanceConfig": { # A set of Confidential Instance options.

5383

"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.

5384

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5385

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

5386

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

5387

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

5388

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

5389

"disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5390

{ # An instance-attached disk resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5391

"autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).

5392

"boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

5393

"deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.

5394

#

5395

# If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5396

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5397

#

5398

# If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.

5399

#

5400

# If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.

5401

#

5402

# If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.

5403

#

5404

# Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5405

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

5406

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

5407

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

5408

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5409

#

5410

# The key must meet the following requirements before you can provide it to Compute Engine:

5411

# - The key is wrapped using a RSA public key certificate provided by Google.

5412

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

5413

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5414

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5415

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5416

"diskSizeGb": "A String", # The size of the disk in GB.

5417

"guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

5418

{ # Guest OS features.

5419

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

5420

},

5421

],

5422

"index": 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.

5423

"initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5424

#

5425

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

5426

#

5427

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5428

"description": "A String", # An optional description. Provide this property when creating the disk.

5429

"diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created.

5430

"diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB.

5431

"diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5432

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

5433

#

5434

#

5435

# Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:

5436

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType

5437

# - projects/project/zones/zone/diskTypes/diskType

5438

# - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5439

"guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5440

#

5441

# Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

5442

{ # Guest OS features.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5443

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5444

},

5445

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5446

"labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.

5447

"a_key": "A String",

5448

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5449

"multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5450

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

5451

"resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name.

5452

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5453

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5454

"sourceImage": "A String", # The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5455

#

5456

# To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image:

5457

# projects/debian-cloud/global/images/family/debian-9

5458

#

5459

#

5460

# Alternatively, use a specific version of a public operating system image:

5461

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

5462

#

5463

#

5464

# To create a disk with a custom image that you created, specify the image name in the following format:

5465

# global/images/my-custom-image

5466

#

5467

#

5468

# You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:

5469

# global/images/family/my-image-family

5470

#

5471

#

5472

# If the source image is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5473

"sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5474

#

5475

# Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.

5476

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

5477

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

5478

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

5479

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5480

#

5481

# The key must meet the following requirements before you can provide it to Compute Engine:

5482

# - The key is wrapped using a RSA public key certificate provided by Google.

5483

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

5484

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5485

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

5486

},

5487

"sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD.

5488

#

5489

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

5490

# global/snapshots/my-backup

5491

#

5492

#

5493

# If the source snapshot is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5494

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5495

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

5496

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

5497

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

5498

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

5499

#

5500

# The key must meet the following requirements before you can provide it to Compute Engine:

5501

# - The key is wrapped using a RSA public key certificate provided by Google.

5502

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

5503

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

5504

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5505

},

5506

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5507

"interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.

5508

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

5509

"licenses": [ # [Output Only] Any valid publicly visible licenses.

5510

"A String",

5511

],

5512

"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.

5513

"shieldedInstanceInitialState": { # Initial State for shielded instance, these are public keys which are safe to store in public # [Output Only] shielded vm initial state stored on disk

5514

"dbs": [ # The Key Database (db).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5515

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5516

"content": "A String", # The raw content in the secure keys file.

5517

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5518

},

5519

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5520

"dbxs": [ # The forbidden key database (dbx).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5521

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5522

"content": "A String", # The raw content in the secure keys file.

5523

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5524

},

5525

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5526

"keks": [ # The Key Exchange Key (KEK).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5527

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5528

"content": "A String", # The raw content in the secure keys file.

5529

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5530

},

5531

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5532

"pk": { # The Platform Key (PK).

5533

"content": "A String", # The raw content in the secure keys file.

5534

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5535

},

5536

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5537

"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5538

#

5539

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

5540

#

5541

# Note that for InstanceTemplate, specify the disk name, not the URL for the disk.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5542

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5543

},

5544

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5545

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

5546

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

5547

},

5548

"eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.

5549

"fingerprint": "A String", # Specifies a fingerprint for this resource, which is essentially a hash of the instance's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance. You must always provide an up-to-date fingerprint hash in order to update the instance.

5550

#

5551

# To see the latest fingerprint, make get() request to the instance.

5552

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

5553

{ # A specification of the type and number of accelerator cards attached to the instance.

5554

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

5555

"acceleratorType": "A String", # Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.

5556

},

5557

],

5558

"hostname": "A String", # Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.

5559

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

5560

"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.

5561

"labelFingerprint": "A String", # A fingerprint for this request, which is essentially a hash of the label's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.

5562

#

5563

# To see the latest fingerprint, make get() request to the instance.

5564

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

5565

"a_key": "A String",

5566

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

5567

"lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format.

5568

"lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format.

5569

"lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5570

"machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:

5571

# zones/us-central1-f/machineTypes/n1-standard-1

5572

#

5573

#

5574

# To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):

5575

# zones/zone/machineTypes/custom-CPUS-MEMORY

5576

#

5577

#

5578

# For example: zones/us-central1-f/machineTypes/custom-4-5120

5579

#

5580

# For a full list of restrictions, read the Specifications for custom machine types.

5581

"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

5582

"fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet.

5583

#

5584

# To see the latest fingerprint, make a get() request to retrieve the resource.

5585

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

5586

{

5587

"key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.

5588

"value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).

5589

},

5590

],

5591

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

5592

},

5593

"minCpuPlatform": "A String", # Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge".

5594

"name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

5595

"networkInterfaces": [ # An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance.

5596

{ # A network interface resource attached to an instance.

5597

"accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.

5598

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

5599

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

5600

"name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.

5601

"natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.

5602

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

5603

#

5604

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

5605

#

5606

# If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.

5607

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

5608

"setPublicPtr": True or False, # Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name.

5609

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

5610

},

5611

],

5612

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

5613

{ # An alias IP range attached to an instance's network interface.

5614

"ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4), a netmask (such as /24) or a CIDR-formatted string (such as 10.1.2.0/24).

5615

"subnetworkRangeName": "A String", # The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used.

5616

},

5617

],

5618

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface, otherwise the request will fail with error 412 conditionNotMet.

5619

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

5620

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

5621

"name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc.

5622

"network": "A String", # URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred.

5623

#

5624

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

5625

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

5626

# - projects/project/global/networks/network

5627

# - global/networks/default

5628

"networkIP": "A String", # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.

5629

"subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:

5630

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

5631

# - regions/region/subnetworks/subnetwork

5632

},

5633

],

5634

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.

5635

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.

5636

"consumeReservationType": "A String", # Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples.

5637

"key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value.

5638

"values": [ # Corresponds to the label values of a reservation resource.

"A String",

],

},

"resourcePolicies": [ # Resource policies applied to this instance.

5643

"A String",

5644

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5645

"scheduling": { # Sets the scheduling options for an Instance. NextID: 13 # Sets the scheduling options for this instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5646

"automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.

5647

#

5648

# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

5649

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

5650

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

5651

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

5652

"key": "A String", # Corresponds to the label key of Node resource.

5653

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

5654

"values": [ # Corresponds to the label values of Node resource.

"A String",

],

},

],

"onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5660

"preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5661

},

5662

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

5663

"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

5664

#

5665

# Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.

5666

{ # A service account.

5667

"email": "A String", # Email address of the service account.

5668

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

5674

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

5675

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

5676

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

5677

},

5678

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

5679

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

5680

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5681

"shieldedVmConfig": { # A set of Shielded VM options. # Deprecating, please use shielded_instance_config.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5682

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

5683

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

5684

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

5685

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5686

"shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured. # Deprecating, please use shielded_instance_integrity_policy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5687

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

5688

},

5689

"sourceMachineImage": "A String", # Source machine image

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5690

"sourceMachineImageEncryptionKey": { # Source GMI encryption key when creating an instance from GMI.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5691

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

5692

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

5693

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

5694

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

5695

#

5696

# The key must meet the following requirements before you can provide it to Compute Engine:

5697

# - The key is wrapped using a RSA public key certificate provided by Google.

5698

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

5699

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

5700

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

5701

},

5702

"startRestricted": True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

5703

"status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5704

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

5705

"tags": { # A set of instance tags. # Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the 'tags.items' field.

5706

"fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the tags' contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags.

5707

#

5708

# To see the latest fingerprint, make get() request to the instance.

5709

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

"A String",

],

},

"zone": "A String", # [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5714

}

5715

5716

minimalAction: string, Specifies the action to take when updating an instance even if the updated properties do not require it. If not specified, then Compute Engine acts based on the minimum action that the updated properties require.

Allowed values

INVALID -

NO_EFFECT -

REFRESH -

RESTART -

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5722

mostDisruptiveAllowedAction: string, Specifies the most disruptive action that can be taken on the instance as part of the update. Compute Engine returns an error if the instance properties require a more disruptive action as part of the instance update. Valid options from lowest to highest are NO_EFFECT, REFRESH, and RESTART.

Allowed values

INVALID -

NO_EFFECT -

REFRESH -

RESTART -

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5728

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.

5729

5730

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.

5731

5732

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5733

5734

Returns:

5735

An object of the form:

5736

5737

{ # Represents an Operation resource.

5738

#

5739

# Google Compute Engine has three Operation resources:

5740

#

5741

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5742

#

5743

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5744

#

5745

# Operations can be global, regional or zonal.

5746

# - For global operations, use the `globalOperations` resource.

5747

# - For regional operations, use the `regionOperations` resource.

5748

# - For zonal operations, use the `zonalOperations` resource.

5749

#

5750

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5751

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5752

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5753

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5754

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5755

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5756

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5757

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5758

"code": "A String", # [Output Only] The error type identifier for this error.

5759

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5760

"message": "A String", # [Output Only] An optional, human-readable error message.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5761

},

5762

],

5763

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5764

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5765

"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.

5766

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5767

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5768

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5769

"name": "A String", # [Output Only] Name of the operation.

5770

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5771

"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.

5772

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5773

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5774

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5775

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5776

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5777

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5778

"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.

5779

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5780

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5781

{

5782

"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.

5783

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5784

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5785

{

5786

"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).

5787

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5788

},

5789

],

5790

"message": "A String", # [Output Only] A human-readable description of the warning code.

5791

},

5792

],

5793

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="updateAccessConfig">updateAccessConfig(project, zone, instance, networkInterface, body=None, requestId=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5799

<pre>Updates the specified access config from an instance's network interface with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5800

5801

Args:

5802

project: string, Project ID for this request. (required)

5803

zone: string, The name of the zone for this request. (required)

5804

instance: string, The instance name for this request. (required)

5805

networkInterface: string, The name of the network interface where the access config is attached. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5806

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5807

The object takes the form of:

5808

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5809

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

5810

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

5811

"name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.

5812

"natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.

5813

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5814

#

5815

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

5816

#

5817

# If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5818

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

5819

"setPublicPtr": True or False, # Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name.

5820

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5821

}

5822

5823

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.

5824

5825

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.

5826

5827

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

5828

5829

Returns:

5830

An object of the form:

5831

5832

{ # Represents an Operation resource.

5833

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5834

# Google Compute Engine has three Operation resources:

5835

#

5836

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5837

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5838

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5839

#

5840

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5841

# - For global operations, use the `globalOperations` resource.

5842

# - For regional operations, use the `regionOperations` resource.

5843

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5844

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5845

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5846

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5847

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5848

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5849

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5850

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5851

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5852

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5853

"code": "A String", # [Output Only] The error type identifier for this error.

5854

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5855

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5856

},

5857

],

5858

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5859

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5860

"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.

5861

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5862

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5863

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5864

"name": "A String", # [Output Only] Name of the operation.

5865

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5866

"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.

5867

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5868

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5869

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5870

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5871

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5872

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5873

"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.

5874

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5875

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5876

{

5877

"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.

5878

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5879

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5880

{

5881

"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).

5882

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5883

},

5884

],

5885

"message": "A String", # [Output Only] A human-readable description of the warning code.

5886

},

5887

],

5888

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5893

<code class="details" id="updateDisplayDevice">updateDisplayDevice(project, zone, instance, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5894

<pre>Updates the Display config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

5895

5896

Args:

5897

project: string, Project ID for this request. (required)

5898

zone: string, The name of the zone for this request. (required)

5899

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5900

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5901

The object takes the form of:

5902

5903

{ # A set of Display Device options

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5904

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5905

}

5906

5907

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.

5908

5909

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.

5910

5911

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

5912

5913

Returns:

5914

An object of the form:

5915

5916

{ # Represents an Operation resource.

5917

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5918

# Google Compute Engine has three Operation resources:

5919

#

5920

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5921

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5922

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5923

#

5924

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5925

# - For global operations, use the `globalOperations` resource.

5926

# - For regional operations, use the `regionOperations` resource.

5927

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5928

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5929

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5930

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5931

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5932

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5933

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5934

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5935

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5936

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5937

"code": "A String", # [Output Only] The error type identifier for this error.

5938

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5939

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5940

},

5941

],

5942

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5943

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5944

"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.

5945

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5946

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5947

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5948

"name": "A String", # [Output Only] Name of the operation.

5949

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5950

"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.

5951

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5952

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5953

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5954

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5955

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5956

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5957

"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.

5958

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5959

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5960

{

5961

"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.

5962

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5963

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5964

{

5965

"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).

5966

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5967

},

5968

],

5969

"message": "A String", # [Output Only] A human-readable description of the warning code.

5970

},

5971

],

5972

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5977

<code class="details" id="updateNetworkInterface">updateNetworkInterface(project, zone, instance, networkInterface, body=None, requestId=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5978

<pre>Updates an instance's network interface. This method follows PATCH semantics.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5979

5980

Args:

5981

project: string, Project ID for this request. (required)

5982

zone: string, The name of the zone for this request. (required)

5983

instance: string, The instance name for this request. (required)

5984

networkInterface: string, The name of the network interface to update. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5985

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5986

The object takes the form of:

5987

5988

{ # A network interface resource attached to an instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5989

"accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.

5990

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

5991

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

5992

"name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.

5993

"natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.

5994

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5995

#

5996

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

5997

#

5998

# If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5999

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

6000

"setPublicPtr": True or False, # Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name.

6001

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6002

},

6003

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6004

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

6005

{ # An alias IP range attached to an instance's network interface.

6006

"ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4), a netmask (such as /24) or a CIDR-formatted string (such as 10.1.2.0/24).

6007

"subnetworkRangeName": "A String", # The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used.

6008

},

6009

],

6010

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface, otherwise the request will fail with error 412 conditionNotMet.

6011

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

6012

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

6013

"name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc.

6014

"network": "A String", # URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6015

#

6016

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

6017

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

6018

# - projects/project/global/networks/network

6019

# - global/networks/default

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6020

"networkIP": "A String", # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.

6021

"subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:

6022

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

6023

# - regions/region/subnetworks/subnetwork

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6024

}

6025

6026

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.

6027

6028

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.

6029

6030

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

6031

6032

Returns:

6033

An object of the form:

6034

6035

{ # Represents an Operation resource.

6036

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6037

# Google Compute Engine has three Operation resources:

6038

#

6039

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6040

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6041

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6042

#

6043

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6044

# - For global operations, use the `globalOperations` resource.

6045

# - For regional operations, use the `regionOperations` resource.

6046

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6047

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6048

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6049

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6050

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6051

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6052

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6053

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6054

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6055

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6056

"code": "A String", # [Output Only] The error type identifier for this error.

6057

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6058

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6059

},

6060

],

6061

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6062

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6063

"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.

6064

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6065

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6066

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6067

"name": "A String", # [Output Only] Name of the operation.

6068

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6069

"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.

6070

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6071

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6072

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6073

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6074

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6075

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6076

"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.

6077

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6078

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6079

{

6080

"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.

6081

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6082

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6083

{

6084

"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).

6085

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6086

},

6087

],

6088

"message": "A String", # [Output Only] A human-readable description of the warning code.

6089

},

6090

],

6091

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6096

<code class="details" id="updateShieldedInstanceConfig">updateShieldedInstanceConfig(project, zone, instance, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6097

<pre>Updates the Shielded Instance config for an instance. You can only use this method on a stopped instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

6098

6099

Args:

6100

project: string, Project ID for this request. (required)

6101

zone: string, The name of the zone for this request. (required)

6102

instance: string, Name or id of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6103

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6104

The object takes the form of:

6105

6106

{ # A set of Shielded Instance options.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6107

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

6108

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

6109

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6110

}

6111

6112

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.

6113

6114

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.

6115

6116

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

6117

6118

Returns:

6119

An object of the form:

6120

6121

{ # Represents an Operation resource.

6122

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6123

# Google Compute Engine has three Operation resources:

6124

#

6125

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6126

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6127

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6128

#

6129

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6130

# - For global operations, use the `globalOperations` resource.

6131

# - For regional operations, use the `regionOperations` resource.

6132

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6133

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6134

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6135

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6136

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6137

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6138

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6139

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6140

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6141

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6142

"code": "A String", # [Output Only] The error type identifier for this error.

6143

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6144

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6145

},

6146

],

6147

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6148

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6149

"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.

6150

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6151

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6152

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6153

"name": "A String", # [Output Only] Name of the operation.

6154

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6155

"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.

6156

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6157

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6158

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6159

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6160

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6161

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6162

"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.

6163

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6164

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6165

{

6166

"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.

6167

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6168

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6169

{

6170

"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).

6171

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6172

},

6173

],

6174

"message": "A String", # [Output Only] A human-readable description of the warning code.

6175

},

6176

],

6177

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6182

<code class="details" id="updateShieldedVmConfig">updateShieldedVmConfig(project, zone, instance, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6183

<pre>Updates the Shielded VM config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

6184

6185

Args:

6186

project: string, Project ID for this request. (required)

6187

zone: string, The name of the zone for this request. (required)

6188

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6189

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6190

The object takes the form of:

6191

6192

{ # A set of Shielded VM options.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6193

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

6194

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

6195

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6196

}

6197

6198

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.

6199

6200

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.

6201

6202

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

6203

6204

Returns:

6205

An object of the form:

6206

6207

{ # Represents an Operation resource.

6208

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6209

# Google Compute Engine has three Operation resources:

6210

#

6211

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6212

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6213

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6214

#

6215

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6216

# - For global operations, use the `globalOperations` resource.

6217

# - For regional operations, use the `regionOperations` resource.

6218

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6219

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6220

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6221

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6222

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6223

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6224

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6225

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6226

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6227

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6228

"code": "A String", # [Output Only] The error type identifier for this error.

6229

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6230

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6231

},

6232

],

6233

},

Bu Sun Kim