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-07-22 17:02:09 -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 instance group, the referrers list includes the managed 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

},

632

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

633

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

634

#

635

#

636

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

637

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

638

#

639

#

640

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

641

#

642

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

643

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

644

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

645

#

646

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

647

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

648

{

649

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

650

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

651

},

652

],

653

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

654

},

655

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

656

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

657

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

658

{ # A network interface resource attached to an instance.

659

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

660

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

661

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

662

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

663

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

664

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

665

#

666

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

667

#

668

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

669

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

670

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

671

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

672

},

673

],

674

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

675

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

676

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

677

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

678

},

679

],

680

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

681

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

682

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

683

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

684

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

685

#

686

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

687

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

688

# - projects/project/global/networks/network

689

# - global/networks/default

690

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

691

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

692

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

693

# - regions/region/subnetworks/subnetwork

694

},

695

],

696

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

697

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

698

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

699

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

700

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

"A String",

],

},

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

705

"A String",

706

],

Dmitry Frenkel

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

[diff] [blame]

707

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

708

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

709

#

710

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

711

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

712

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

713

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

714

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

715

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

716

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

722

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

723

},

724

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

725

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

726

#

727

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

728

{ # A service account.

729

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

730

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

"A String",

],

},

],

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

736

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

737

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

738

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

739

},

740

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

741

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

742

},

Dmitry Frenkel

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

[diff] [blame]

743

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

744

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

745

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

746

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

747

},

Dmitry Frenkel

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

[diff] [blame]

748

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

749

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

750

},

751

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

Dmitry Frenkel

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

[diff] [blame]

752

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

Bu Sun Kim

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

[diff] [blame]

753

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

754

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

755

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

756

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

757

#

758

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

759

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

760

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

761

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

762

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

763

},

764

"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-07-22 17:02:09 -0700

[diff] [blame]

765

"status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED.

Bu Sun Kim

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

[diff] [blame]

766

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

767

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

768

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

769

#

770

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

771

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

776

},

777

],

Bu Sun Kim

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

[diff] [blame]

778

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

779

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

780

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

781

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

Sai Cheemalapati

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

[diff] [blame]

782

{

Bu Sun Kim

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

[diff] [blame]

783

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

784

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

Sai Cheemalapati

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

[diff] [blame]

785

},

786

],

Bu Sun Kim

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

[diff] [blame]

787

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

Sai Cheemalapati

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

[diff] [blame]

788

},

789

},

790

},

Bu Sun Kim

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

[diff] [blame]

791

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

792

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

793

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

Dmitry Frenkel

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

[diff] [blame]

794

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

795

"A String",

796

],

Bu Sun Kim

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

[diff] [blame]

797

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

798

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

799

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

800

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

Bu Sun Kim

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

[diff] [blame]

801

{

Bu Sun Kim

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

[diff] [blame]

802

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

803

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

804

},

805

],

Bu Sun Kim

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

[diff] [blame]

806

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

807

},

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>

813

<pre>Retrieves the next page of results.

814

815

Args:

816

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

817

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

818

819

Returns:

Bu Sun Kim

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

[diff] [blame]

820

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

Sai Cheemalapati

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

[diff] [blame]

821

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]

826

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

827

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

828

829

Args:

830

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

831

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

832

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

Dan O'Meara

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

[diff] [blame]

833

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

834

The object takes the form of:

835

836

{ # An instance-attached disk resource.

Bu Sun Kim

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

[diff] [blame]

837

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

838

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

839

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

840

#

841

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

842

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

Sai Cheemalapati

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

[diff] [blame]

843

#

844

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

845

#

846

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

847

#

848

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

849

#

850

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

851

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

852

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

853

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

854

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

855

#

856

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

857

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

858

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

859

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

Bu Sun Kim

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

[diff] [blame]

860

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

861

},

Bu Sun Kim

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

[diff] [blame]

862

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

863

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

864

{ # Guest OS features.

865

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

866

},

867

],

868

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

869

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

870

#

871

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

872

#

873

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

874

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

875

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

876

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

877

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

878

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

879

#

Bu Sun Kim

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

[diff] [blame]

880

#

Sai Cheemalapati

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

[diff] [blame]

881

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

882

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

883

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

884

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

885

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

886

#

887

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

888

{ # Guest OS features.

Bu Sun Kim

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

[diff] [blame]

889

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

890

},

891

],

Bu Sun Kim

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

[diff] [blame]

892

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

893

"a_key": "A String",

894

},

Bu Sun Kim

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

[diff] [blame]

895

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

896

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

897

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

898

"A String",

Bu Sun Kim

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

[diff] [blame]

899

],

Bu Sun Kim

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

[diff] [blame]

900

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

901

#

Bu Sun Kim

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

[diff] [blame]

902

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

903

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

Sai Cheemalapati

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

[diff] [blame]

904

#

Sai Cheemalapati

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

[diff] [blame]

905

#

906

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

Bu Sun Kim

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

[diff] [blame]

907

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

Sai Cheemalapati

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

[diff] [blame]

908

#

Sai Cheemalapati

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

[diff] [blame]

909

#

Bu Sun Kim

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

[diff] [blame]

910

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

911

# global/images/my-custom-image

Sai Cheemalapati

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

[diff] [blame]

912

#

Sai Cheemalapati

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

[diff] [blame]

913

#

Bu Sun Kim

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

[diff] [blame]

914

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

915

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

Sai Cheemalapati

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

[diff] [blame]

916

#

Jon Wayne Parrott

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

[diff] [blame]

917

#

918

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

Dmitry Frenkel

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

[diff] [blame]

919

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

920

#

921

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

922

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

923

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

924

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

925

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

926

#

927

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

928

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

929

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

930

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

Bu Sun Kim

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

[diff] [blame]

931

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

932

},

933

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

934

#

935

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

936

# global/snapshots/my-backup

937

#

938

#

939

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

Dmitry Frenkel

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

[diff] [blame]

940

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

Bu Sun Kim

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

[diff] [blame]

941

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

942

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

943

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

944

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

945

#

946

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

947

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

948

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

949

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

950

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

951

},

Sai Cheemalapati

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

[diff] [blame]

952

},

Bu Sun Kim

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

[diff] [blame]

953

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

954

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

955

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

956

"A String",

957

],

958

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

959

"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

960

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

Dan O'Meara

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

[diff] [blame]

961

{

Bu Sun Kim

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

[diff] [blame]

962

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

963

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

Dan O'Meara

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

[diff] [blame]

964

},

965

],

Bu Sun Kim

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

[diff] [blame]

966

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

Dan O'Meara

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

[diff] [blame]

967

{

Bu Sun Kim

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

[diff] [blame]

968

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

969

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

Dan O'Meara

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

[diff] [blame]

970

},

971

],

Bu Sun Kim

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

[diff] [blame]

972

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

Dan O'Meara

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

[diff] [blame]

973

{

Bu Sun Kim

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

[diff] [blame]

974

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

975

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

Dan O'Meara

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

[diff] [blame]

976

},

977

],

Bu Sun Kim

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

[diff] [blame]

978

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

979

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

980

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

Dan O'Meara

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

[diff] [blame]

981

},

982

},

Bu Sun Kim

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

[diff] [blame]

983

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

984

#

985

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

986

#

987

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

988

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

989

}

990

Dmitry Frenkel

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

[diff] [blame]

991

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]

992

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.

993

994

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.

995

996

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]

997

998

Returns:

999

An object of the form:

1000

Bu Sun Kim

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

[diff] [blame]

1001

{ # Represents an Operation resource.

1002

#

Dan O'Meara

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

[diff] [blame]

1003

# Google Compute Engine has three Operation resources:

1004

#

1005

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

1006

#

Bu Sun Kim

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

[diff] [blame]

1007

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

1008

#

1009

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

1010

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

1011

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

1012

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

Bu Sun Kim

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

[diff] [blame]

1013

#

Dan O'Meara

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

[diff] [blame]

1014

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

1015

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

1016

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

1017

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

1018

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

1019

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

1020

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

Sai Cheemalapati

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

[diff] [blame]

1021

{

Bu Sun Kim

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

[diff] [blame]

1022

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

1023

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

1024

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

Sai Cheemalapati

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

[diff] [blame]

1025

},

1026

],

1027

},

Bu Sun Kim

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

[diff] [blame]

1028

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

1029

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

1030

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

1031

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

1032

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

1033

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

1034

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

1035

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

1036

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

1037

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

1038

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

1039

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

1040

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

1041

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

1042

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

1043

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

1044

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

1045

{

1046

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

1047

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

1048

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

1049

{

1050

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

1051

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

1052

},

1053

],

1054

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

1055

},

1056

],

1057

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

1062

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

1063

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

1067

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

Sai Cheemalapati

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

[diff] [blame]

1068

<pre>Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance.

1069

1070

Args:

1071

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

1072

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

1073

instance: string, Name of the instance resource to delete. (required)

Bu Sun Kim

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

[diff] [blame]

1074

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.

1075

1076

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.

1077

1078

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]

1079

1080

Returns:

1081

An object of the form:

1082

Bu Sun Kim

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

[diff] [blame]

1083

{ # Represents an Operation resource.

1084

#

Dan O'Meara

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

[diff] [blame]

1085

# Google Compute Engine has three Operation resources:

1086

#

1087

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

1088

#

Bu Sun Kim

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

[diff] [blame]

1089

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

1090

#

1091

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

1092

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

1093

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

1094

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

Bu Sun Kim

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

[diff] [blame]

1095

#

Dan O'Meara

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

[diff] [blame]

1096

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

1097

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

1098

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

1099

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

1100

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

1101

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

1102

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

Sai Cheemalapati

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

[diff] [blame]

1103

{

Bu Sun Kim

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

[diff] [blame]

1104

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

1105

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

1106

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

Sai Cheemalapati

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

[diff] [blame]

1107

},

1108

],

1109

},

Bu Sun Kim

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

[diff] [blame]

1110

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

1111

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

1112

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

1113

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

1114

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

1115

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

1116

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

1117

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

1118

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

1119

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

1120

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

1121

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

1122

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

1123

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

1124

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

1125

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

1126

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

1127

{

1128

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

1129

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

1130

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

1131

{

1132

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

1133

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

1134

},

1135

],

1136

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

1137

},

1138

],

1139

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

1144

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

1145

<pre>Deletes an access config from an instance's network interface.

Sai Cheemalapati

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

[diff] [blame]

1146

1147

Args:

1148

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

1149

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

1150

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

1151

accessConfig: string, The name of the access config to delete. (required)

1152

networkInterface: string, The name of the network interface. (required)

Bu Sun Kim

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

[diff] [blame]

1153

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.

1154

1155

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.

1156

1157

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]

1158

1159

Returns:

1160

An object of the form:

1161

Bu Sun Kim

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

[diff] [blame]

1162

{ # Represents an Operation resource.

1163

#

Dan O'Meara

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

[diff] [blame]

1164

# Google Compute Engine has three Operation resources:

1165

#

1166

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

1167

#

Bu Sun Kim

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

[diff] [blame]

1168

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

1169

#

1170

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

1171

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

1172

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

1173

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

Bu Sun Kim

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

[diff] [blame]

1174

#

Dan O'Meara

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

[diff] [blame]

1175

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

1176

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

1177

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

1178

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

1179

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

1180

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

1181

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

Sai Cheemalapati

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

[diff] [blame]

1182

{

Bu Sun Kim

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

[diff] [blame]

1183

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

1184

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

1185

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

Sai Cheemalapati

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

[diff] [blame]

1186

},

1187

],

1188

},

Bu Sun Kim

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

[diff] [blame]

1189

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

1190

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

1191

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

1192

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

1193

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

1194

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

1195

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

1196

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

1197

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

1198

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

1199

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

1200

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

1201

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

1202

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

1203

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

1204

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

1205

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

1206

{

1207

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

1208

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

1209

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

1210

{

1211

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

1212

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

1213

},

1214

],

1215

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

1216

},

1217

],

1218

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

1223

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

Sai Cheemalapati

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

[diff] [blame]

1224

<pre>Detaches a disk from an instance.

1225

1226

Args:

1227

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

1228

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

Bu Sun Kim

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

[diff] [blame]

1229

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

1230

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)

1231

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.

1232

1233

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.

1234

1235

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]

1236

1237

Returns:

1238

An object of the form:

1239

Bu Sun Kim

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

[diff] [blame]

1240

{ # Represents an Operation resource.

1241

#

Dan O'Meara

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

[diff] [blame]

1242

# Google Compute Engine has three Operation resources:

1243

#

1244

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

1245

#

Bu Sun Kim

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

[diff] [blame]

1246

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

1247

#

1248

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

1249

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

1250

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

1251

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

Bu Sun Kim

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

[diff] [blame]

1252

#

Dan O'Meara

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

[diff] [blame]

1253

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

1254

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

1255

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

1256

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

1257

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

1258

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

1259

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

Sai Cheemalapati

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

[diff] [blame]

1260

{

Bu Sun Kim

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

[diff] [blame]

1261

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

1262

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

1263

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

Sai Cheemalapati

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

[diff] [blame]

1264

},

1265

],

1266

},

Bu Sun Kim

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

[diff] [blame]

1267

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

1268

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

1269

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

1270

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

1271

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

1272

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

1273

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

1274

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

1275

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

1276

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

1277

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

1278

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

1279

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

1280

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

1281

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

1282

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

1283

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

1284

{

1285

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

1286

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

1287

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

1288

{

1289

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

1290

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

1291

},

1292

],

1293

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

1294

},

1295

],

1296

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

1302

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

1303

1304

Args:

1305

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

1306

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

1307

instance: string, Name of the instance resource to return. (required)

1308

1309

Returns:

1310

An object of the form:

1311

Bu Sun Kim

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

[diff] [blame]

1312

{ # Represents an Instance resource.

1313

#

Dan O'Meara

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

[diff] [blame]

1314

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

1315

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

1316

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

1317

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

1318

},

Bu Sun Kim

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

[diff] [blame]

1319

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

1320

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

1321

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

1322

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

1323

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

1324

{ # An instance-attached disk resource.

Bu Sun Kim

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

[diff] [blame]

1325

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

1326

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

1327

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

1328

#

1329

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

1330

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

Sai Cheemalapati

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

[diff] [blame]

1331

#

1332

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

1333

#

1334

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

1335

#

1336

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

1337

#

1338

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

1339

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

1340

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

1341

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

1342

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

1343

#

1344

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

1345

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

1346

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

1347

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

Bu Sun Kim

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

[diff] [blame]

1348

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

1349

},

Bu Sun Kim

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

[diff] [blame]

1350

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

1351

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

1352

{ # Guest OS features.

1353

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

1354

},

1355

],

1356

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

1357

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

1358

#

1359

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

1360

#

1361

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

1362

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

1363

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

1364

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

1365

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

1366

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

1367

#

Bu Sun Kim

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

[diff] [blame]

1368

#

Sai Cheemalapati

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

[diff] [blame]

1369

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

1370

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

1371

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

1372

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

1373

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

1374

#

1375

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

1376

{ # Guest OS features.

Bu Sun Kim

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

[diff] [blame]

1377

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

1378

},

1379

],

Bu Sun Kim

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

[diff] [blame]

1380

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

1381

"a_key": "A String",

1382

},

Bu Sun Kim

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

[diff] [blame]

1383

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

1384

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

1385

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

1386

"A String",

Bu Sun Kim

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

[diff] [blame]

1387

],

Bu Sun Kim

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

[diff] [blame]

1388

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

1389

#

Bu Sun Kim

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

[diff] [blame]

1390

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

1391

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

Sai Cheemalapati

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

[diff] [blame]

1392

#

Sai Cheemalapati

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

[diff] [blame]

1393

#

1394

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

Bu Sun Kim

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

[diff] [blame]

1395

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

Sai Cheemalapati

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

[diff] [blame]

1396

#

Sai Cheemalapati

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

[diff] [blame]

1397

#

Bu Sun Kim

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

[diff] [blame]

1398

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

1399

# global/images/my-custom-image

Sai Cheemalapati

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

[diff] [blame]

1400

#

Sai Cheemalapati

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

[diff] [blame]

1401

#

Bu Sun Kim

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

[diff] [blame]

1402

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

1403

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

Sai Cheemalapati

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

[diff] [blame]

1404

#

Jon Wayne Parrott

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

[diff] [blame]

1405

#

1406

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

Dmitry Frenkel

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

[diff] [blame]

1407

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

1408

#

1409

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

1410

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

1411

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

1412

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

1413

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

1414

#

1415

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

1416

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

1417

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

1418

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

Bu Sun Kim

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

[diff] [blame]

1419

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

1420

},

1421

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

1422

#

1423

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

1424

# global/snapshots/my-backup

1425

#

1426

#

1427

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

Dmitry Frenkel

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

[diff] [blame]

1428

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

Bu Sun Kim

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

[diff] [blame]

1429

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

1430

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

1431

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

1432

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

1433

#

1434

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

1435

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

1436

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

1437

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

1438

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

1439

},

Sai Cheemalapati

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

[diff] [blame]

1440

},

Bu Sun Kim

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

[diff] [blame]

1441

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

1442

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

1443

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

1444

"A String",

1445

],

1446

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

1447

"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

1448

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

Dan O'Meara

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

[diff] [blame]

1449

{

Bu Sun Kim

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

[diff] [blame]

1450

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

1451

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

Dan O'Meara

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

[diff] [blame]

1452

},

1453

],

Bu Sun Kim

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

[diff] [blame]

1454

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

Dan O'Meara

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

[diff] [blame]

1455

{

Bu Sun Kim

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

[diff] [blame]

1456

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

1457

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

Dan O'Meara

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

[diff] [blame]

1458

},

1459

],

Bu Sun Kim

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

[diff] [blame]

1460

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

Dan O'Meara

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

[diff] [blame]

1461

{

Bu Sun Kim

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

[diff] [blame]

1462

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

1463

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

Dan O'Meara

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

[diff] [blame]

1464

},

1465

],

Bu Sun Kim

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

[diff] [blame]

1466

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

1467

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

1468

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

Dan O'Meara

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

[diff] [blame]

1469

},

1470

},

Bu Sun Kim

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

[diff] [blame]

1471

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

1472

#

1473

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

1474

#

1475

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

1476

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

1477

},

1478

],

Bu Sun Kim

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

[diff] [blame]

1479

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

1480

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

1481

},

1482

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

1483

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

1484

#

1485

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

1486

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

1487

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

1488

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

1489

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

1490

},

1491

],

1492

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

1493

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

1494

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

1495

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

1496

#

1497

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

1498

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

1499

"a_key": "A String",

1500

},

1501

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

1502

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

1503

#

1504

#

1505

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

1506

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

1507

#

1508

#

1509

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

1510

#

1511

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

1512

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

1513

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

1514

#

1515

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

1516

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

1517

{

1518

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

1519

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

1520

},

1521

],

1522

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

1523

},

1524

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

1525

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

1526

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

1527

{ # A network interface resource attached to an instance.

1528

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

1529

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

1530

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

1531

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

1532

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

1533

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

1534

#

1535

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

1536

#

1537

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

1538

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

1539

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

1540

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

1541

},

1542

],

1543

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

1544

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

1545

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

1546

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

1547

},

1548

],

1549

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

1550

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

1551

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

1552

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

1553

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

1554

#

1555

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

1556

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

1557

# - projects/project/global/networks/network

1558

# - global/networks/default

1559

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

1560

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

1561

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

1562

# - regions/region/subnetworks/subnetwork

1563

},

1564

],

1565

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

1566

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

1567

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

1568

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

1569

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

"A String",

],

},

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

1574

"A String",

1575

],

Dmitry Frenkel

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

[diff] [blame]

1576

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

1577

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

1578

#

1579

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

1580

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

1581

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

1582

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

1583

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

1584

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

1585

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

1591

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

1592

},

1593

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

1594

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

1595

#

1596

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

1597

{ # A service account.

1598

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

1599

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

"A String",

],

},

],

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

1605

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

1606

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

1607

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

1608

},

1609

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

1610

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

1611

},

Dmitry Frenkel

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

[diff] [blame]

1612

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

1613

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

1614

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

1615

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

1616

},

Dmitry Frenkel

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

[diff] [blame]

1617

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

1618

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

1619

},

1620

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

Dmitry Frenkel

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

[diff] [blame]

1621

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

Bu Sun Kim

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

[diff] [blame]

1622

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

1623

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

1624

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

1625

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

1626

#

1627

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

1628

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

1629

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

1630

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

1631

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

1632

},

1633

"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-07-22 17:02:09 -0700

[diff] [blame]

1634

"status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED.

Bu Sun Kim

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

[diff] [blame]

1635

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

1636

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

1637

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

1638

#

1639

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

1640

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

1649

<code class="details" id="getEffectiveFirewalls">getEffectiveFirewalls(project, zone, instance, networkInterface)</code>

1650

<pre>Returns effective firewalls applied to an interface of the instance.

1651

1652

Args:

1653

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

1654

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

1655

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

1656

networkInterface: string, The name of the network interface to get the effective firewalls. (required)

1657

1658

Returns:

1659

An object of the form:

1660

1661

{

Bu Sun Kim

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

[diff] [blame]

1662

"firewalls": [ # Effective firewalls on the instance.

1663

{ # Represents a Firewall Rule resource.

1664

#

1665

# Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules.

1666

"allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

1667

{

1668

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

1669

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

1670

#

1671

# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

"A String",

],

},

],

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

1677

"denied": [ # The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.

1678

{

1679

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

1680

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

1681

#

1682

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

1688

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

1689

"A String",

1690

],

1691

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

1692

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

1693

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

1694

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

1695

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

1696

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

1697

"enable": True or False, # This field denotes whether to enable logging for a particular firewall rule.

1698

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

1699

},

1700

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

1701

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

1702

# global/networks/default

1703

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

1704

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

1705

# - projects/myproject/global/networks/my-network

1706

# - global/networks/default

1707

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

1708

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

1709

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

1710

"A String",

1711

],

1712

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

1713

"A String",

1714

],

1715

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

1716

"A String",

1717

],

1718

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

1719

"A String",

1720

],

1721

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

1727

{ # A pruned SecurityPolicy containing ID and any applicable firewall rules.

Bu Sun Kim

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

[diff] [blame]

1728

"id": "A String", # The unique identifier for the security policy. This identifier is defined by the server.

1729

"rules": [ # The rules that apply to the network.

Dan O'Meara

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

[diff] [blame]

1730

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

1731

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

1732

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

1733

"direction": "A String", # The direction in which this rule applies. This field may only be specified when versioned_expr is set to FIREWALL.

1734

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

1735

#

1736

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

1737

"kind": "compute#securityPolicyRule", # [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules

1738

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

1739

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

1740

"destIpRanges": [ # CIDR IP address range.

Dan O'Meara

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

[diff] [blame]

1741

#

1742

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

1743

"A String",

Dan O'Meara

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

[diff] [blame]

1744

],

Bu Sun Kim

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

[diff] [blame]

1745

"layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.

Dan O'Meara

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

[diff] [blame]

1746

#

1747

# This field may only be specified when versioned_expr is set to FIREWALL.

1748

{

Bu Sun Kim

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

[diff] [blame]

1749

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

1750

"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]

1751

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1752

# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1753

#

1754

# 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]

1755

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1756

],

1757

},

1758

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1759

"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]

1760

"A String",

1761

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1762

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1763

"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.

1764

#

1765

# Example (Comparison):

1766

#

1767

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

1768

#

1769

# Example (Equality):

1770

#

1771

# 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'"

1776

#

1777

# Example (Data Manipulation):

1778

#

1779

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

1780

#

1781

# 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.

1782

"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.

1783

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

1784

"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.

1785

"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.

1786

},

1787

"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]

1788

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1789

"preview": True or False, # If set to true, the specified action is not enforced.

1790

"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.

1791

"ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall security policy rule.

1792

"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.

1793

#

1794

# This field may only be specified when versioned_expr is set to FIREWALL.

1795

"A String",

1796

],

1797

"targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.

1798

"A String",

1799

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1800

},

1801

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1802

},

1803

],

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]

1808

<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]

1809

<pre>Returns the specified guest attributes entry.

1810

1811

Args:

1812

project: string, Project ID for this request. (required)

1813

zone: string, The name of the zone for this request. (required)

1814

instance: string, Name of the instance scoping this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1815

queryPath: string, Specifies the guest attributes path to be queried.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1816

variableKey: string, Specifies the key for the guest attributes entry.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1817

1818

Returns:

1819

An object of the form:

1820

1821

{ # A guest attributes entry.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1822

"kind": "compute#guestAttributes", # [Output Only] Type of the resource. Always compute#guestAttributes for guest attributes entry.

1823

"queryPath": "A String", # The path to be queried. This can be the default namespace ('/') or a nested namespace ('/\/') or a specified key ('/\/\')

1824

"queryValue": { # Array of guest attribute namespace/key/value tuples. # [Output Only] The value of the requested queried path.

1825

"items": [

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1826

{ # A guest attributes namespace/key/value entry.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1827

"key": "A String", # Key for the guest attribute entry.

1828

"namespace": "A String", # Namespace for the guest attribute entry.

1829

"value": "A String", # Value for the guest attribute entry.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1830

},

1831

],

1832

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1833

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

1834

"variableKey": "A String", # The key to search for.

1835

"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]

1840

<code class="details" id="getIamPolicy">getIamPolicy(project, zone, resource, optionsRequestedPolicyVersion=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1841

<pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists.

1842

1843

Args:

1844

project: string, Project ID for this request. (required)

1845

zone: string, The name of the zone for this request. (required)

1846

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1847

optionsRequestedPolicyVersion: integer, Requested IAM Policy version.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1848

1849

Returns:

1850

An object of the form:

1851

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1852

{ # 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]

1853

#

1854

#

1855

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1856

# 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]

1857

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1858

# 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]

1859

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1860

# **JSON example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1861

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1862

# { "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]

1863

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1864

# **YAML example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1865

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1866

# 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]

1867

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1868

# 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]

1869

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1870

{ # 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.

1871

#

1872

# 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.

1873

#

1874

# Example Policy with multiple AuditConfigs:

1875

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1876

# { "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]

1877

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1878

# 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]

1879

"auditLogConfigs": [ # The configuration for logging of each type of permission.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1880

{ # Provides the configuration for logging a type of permissions. Example:

1881

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1882

# { "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]

1883

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1884

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

1885

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

1886

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1887

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1888

"ignoreChildExemptions": True or False,

1889

"logType": "A String", # The log type that this config enables.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1890

},

1891

],

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]

1896

},

1897

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1898

"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]

1899

{ # Associates `members` with a `role`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1900

"bindingId": "A String", # A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1901

"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.

1902

#

1903

# If the condition evaluates to `true`, then this binding applies to the current request.

1904

#

1905

# 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.

1906

#

1907

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1908

#

1909

# Example (Comparison):

1910

#

1911

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

1912

#

1913

# Example (Equality):

1914

#

1915

# 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'"

1920

#

1921

# Example (Data Manipulation):

1922

#

1923

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

1924

#

1925

# 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.

1926

"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.

1927

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

1928

"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.

1929

"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.

1930

},

1931

"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]

1932

#

1933

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

1934

#

1935

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

1936

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1937

# * `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`.

1942

#

1943

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

1944

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1945

# * `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.

1946

#

1947

# * `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.

1948

#

1949

# * `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.

1950

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1951

#

1952

#

1953

# * `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]

1954

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1955

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1956

"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]

1957

},

1958

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1959

"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.

1960

#

1961

# **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.

1962

"iamOwned": True or False,

1963

"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.

1964

{ # A rule to be applied in a Policy.

1965

"action": "A String", # Required

1966

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

1967

{ # A condition to be met.

1968

"iam": "A String", # Trusted attributes supplied by the IAM system.

1969

"op": "A String", # An operator to apply the subject with.

1970

"svc": "A String", # Trusted attributes discharged by the service.

1971

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

1972

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

1978

"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.

1979

"A String",

1980

],

1981

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

1982

{ # Specifies what kind of log the caller must write

1983

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

1984

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

1985

"permissionType": "A String", # The type of the permission that was checked.

1986

},

1987

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

1988

},

1989

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

1990

#

1991

# 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.

1992

#

1993

# Field names correspond to IAM request parameters and field values are their respective values.

1994

#

1995

# 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.

1996

#

1997

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

1998

"customFields": [ # Custom fields.

1999

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

2000

"name": "A String", # Name is the field name.

2001

"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.

2002

},

2003

],

2004

"field": "A String", # The field value to attribute.

2005

"metric": "A String", # The metric to update.

2006

},

2007

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

2008

"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.

2013

"A String",

2014

],

2015

"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.

2021

#

2022

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

2023

#

2024

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

2025

#

2026

# * 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

2027

#

2028

# **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.

2029

#

2030

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

2031

#

2032

# 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]

2037

<code class="details" id="getScreenshot">getScreenshot(project, zone, instance)</code>

2038

<pre>Returns the screenshot from the specified instance.

2039

2040

Args:

2041

project: string, Project ID for this request. (required)

2042

zone: string, The name of the zone for this request. (required)

2043

instance: string, Name of the instance scoping this request. (required)

2044

2045

Returns:

2046

An object of the form:

2047

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2048

{ # An instance's screenshot.

2049

"contents": "A String", # [Output Only] The Base64-encoded screenshot data.

2050

"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]

2055

<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]

2056

<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]

2057

2058

Args:

2059

project: string, Project ID for this request. (required)

2060

zone: string, The name of the zone for this request. (required)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2061

instance: string, Name of the instance for this request. (required)

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2062

port: integer, Specifies which COM or serial port to retrieve data from.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2063

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`.

2064

2065

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.

2066

2067

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]

2068

2069

Returns:

2070

An object of the form:

2071

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2072

{ # An instance's serial console output.

2073

"contents": "A String", # [Output Only] The contents of the console output.

2074

"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]

2075

"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]

2076

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2077

"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]

2082

<code class="details" id="getShieldedInstanceIdentity">getShieldedInstanceIdentity(project, zone, instance)</code>

2083

<pre>Returns the Shielded Instance Identity of an instance

2084

2085

Args:

2086

project: string, Project ID for this request. (required)

2087

zone: string, The name of the zone for this request. (required)

2088

instance: string, Name or id of the instance scoping this request. (required)

2089

2090

Returns:

2091

An object of the form:

2092

2093

{ # A shielded Instance identity entry.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2094

"encryptionKey": { # A Shielded Instance Identity Entry. # An Endorsement Key (EK) made by the RSA 2048 algorithm issued to the Shielded Instance's vTPM.

2095

"ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.

2096

"ekPub": "A String", # A PEM-encoded public key.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2097

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2098

"kind": "compute#shieldedInstanceIdentity", # [Output Only] Type of the resource. Always compute#shieldedInstanceIdentity for shielded Instance identity entry.

2099

"signingKey": { # A Shielded Instance Identity Entry. # An Attestation Key (AK) made by the RSA 2048 algorithm issued to the Shielded Instance's vTPM.

2100

"ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.

2101

"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>

2108

<pre>Returns the Shielded VM Identity of an instance

2109

2110

Args:

2111

project: string, Project ID for this request. (required)

2112

zone: string, The name of the zone for this request. (required)

2113

instance: string, Name of the instance scoping this request. (required)

2114

2115

Returns:

2116

An object of the form:

2117

2118

{ # A shielded VM identity entry.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2119

"encryptionKey": { # A Shielded Instance Identity Entry. # An Endorsement Key (EK) issued to the Shielded VM's vTPM.

2120

"ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.

2121

"ekPub": "A String", # A PEM-encoded public key.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2122

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2123

"kind": "compute#shieldedVmIdentity", # [Output Only] Type of the resource. Always compute#shieldedVmIdentity for shielded VM identity entry.

2124

"signingKey": { # A Shielded Instance Identity Entry. # An Attestation Key (AK) issued to the Shielded VM's vTPM.

2125

"ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.

2126

"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]

2132

<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]

2133

<pre>Creates an instance resource in the specified project using the data included in the request.

2134

2135

Args:

2136

project: string, Project ID for this request. (required)

2137

zone: string, The name of the zone for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2138

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2139

The object takes the form of:

2140

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2141

{ # Represents an Instance resource.

2142

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2143

# 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]

2144

"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]

2145

"confidentialInstanceConfig": { # A set of Confidential Instance options.

2146

"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.

2147

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2148

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

2149

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

2150

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

2151

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2152

"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]

2153

{ # An instance-attached disk resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2154

"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).

2155

"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.

2156

"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.

2157

#

2158

# 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]

2159

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2160

#

2161

# 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.

2162

#

2163

# 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.

2164

#

2165

# 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.

2166

#

2167

# 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]

2168

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2169

"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.

2170

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2171

"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]

2172

#

2173

# The key must meet the following requirements before you can provide it to Compute Engine:

2174

# - 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]

2175

# - 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]

2176

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2177

"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]

2178

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2179

"diskSizeGb": "A String", # The size of the disk in GB.

2180

"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.

2181

{ # Guest OS features.

2182

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

2183

},

2184

],

2185

"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.

2186

"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]

2187

#

2188

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

2189

#

2190

# 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]

2191

"description": "A String", # An optional description. Provide this property when creating the disk.

2192

"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.

2193

"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.

2194

"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]

2195

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

2196

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2197

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2198

# 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:

2199

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType

2200

# - projects/project/zones/zone/diskTypes/diskType

2201

# - 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]

2202

"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]

2203

#

2204

# Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

2205

{ # Guest OS features.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2206

"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]

2207

},

2208

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2209

"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.

2210

"a_key": "A String",

2211

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2212

"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]

2213

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

2214

"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.

2215

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2216

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2217

"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]

2218

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2219

# 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:

2220

# projects/debian-cloud/global/images/family/debian-9

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2221

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2222

#

2223

# Alternatively, use a specific version of a public operating system image:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2224

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2225

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2226

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2227

# To create a disk with a custom image that you created, specify the image name in the following format:

2228

# global/images/my-custom-image

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2229

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2230

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2231

# 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:

2232

# global/images/family/my-image-family

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2233

#

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2234

#

2235

# If the source image is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2236

"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]

2237

#

2238

# 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.

2239

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2240

"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.

2241

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2242

"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]

2243

#

2244

# The key must meet the following requirements before you can provide it to Compute Engine:

2245

# - The key is wrapped using a RSA public key certificate provided by Google.

2246

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

2247

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2248

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

2249

},

2250

"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.

2251

#

2252

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

2253

# global/snapshots/my-backup

2254

#

2255

#

2256

# If the source snapshot is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2257

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2258

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2259

"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.

2260

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2261

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

2262

#

2263

# The key must meet the following requirements before you can provide it to Compute Engine:

2264

# - The key is wrapped using a RSA public key certificate provided by Google.

2265

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

2266

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

2267

"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]

2268

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2269

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2270

"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.

2271

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

2272

"licenses": [ # [Output Only] Any valid publicly visible licenses.

2273

"A String",

2274

],

2275

"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.

2276

"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

2277

"dbs": [ # The Key Database (db).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2278

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2279

"content": "A String", # The raw content in the secure keys file.

2280

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2281

},

2282

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2283

"dbxs": [ # The forbidden key database (dbx).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2284

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2285

"content": "A String", # The raw content in the secure keys file.

2286

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2287

},

2288

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2289

"keks": [ # The Key Exchange Key (KEK).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2290

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2291

"content": "A String", # The raw content in the secure keys file.

2292

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2293

},

2294

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2295

"pk": { # The Platform Key (PK).

2296

"content": "A String", # The raw content in the secure keys file.

2297

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2298

},

2299

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2300

"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]

2301

#

2302

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

2303

#

2304

# 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]

2305

"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]

2306

},

2307

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2308

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

2309

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

2310

},

2311

"eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.

2312

"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.

2313

#

2314

# To see the latest fingerprint, make get() request to the instance.

2315

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

2316

{ # A specification of the type and number of accelerator cards attached to the instance.

2317

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

2318

"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.

2319

},

2320

],

2321

"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.

2322

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

2323

"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.

2324

"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.

2325

#

2326

# To see the latest fingerprint, make get() request to the instance.

2327

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

2328

"a_key": "A String",

2329

},

2330

"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:

2331

# zones/us-central1-f/machineTypes/n1-standard-1

2332

#

2333

#

2334

# 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):

2335

# zones/zone/machineTypes/custom-CPUS-MEMORY

2336

#

2337

#

2338

# For example: zones/us-central1-f/machineTypes/custom-4-5120

2339

#

2340

# For a full list of restrictions, read the Specifications for custom machine types.

2341

"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

2342

"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.

2343

#

2344

# To see the latest fingerprint, make a get() request to retrieve the resource.

2345

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

2346

{

2347

"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.

2348

"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).

2349

},

2350

],

2351

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

2352

},

2353

"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".

2354

"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.

2355

"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.

2356

{ # A network interface resource attached to an instance.

2357

"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.

2358

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

2359

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

2360

"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.

2361

"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.

2362

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

2363

#

2364

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

2365

#

2366

# 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.

2367

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

2368

"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.

2369

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

2370

},

2371

],

2372

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

2373

{ # An alias IP range attached to an instance's network interface.

2374

"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).

2375

"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.

2376

},

2377

],

2378

"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.

2379

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

2380

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

2381

"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.

2382

"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.

2383

#

2384

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

2385

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

2386

# - projects/project/global/networks/network

2387

# - global/networks/default

2388

"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.

2389

"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:

2390

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

2391

# - regions/region/subnetworks/subnetwork

2392

},

2393

],

2394

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.

2395

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.

2396

"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.

2397

"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.

2398

"values": [ # Corresponds to the label values of a reservation resource.

"A String",

],

},

"resourcePolicies": [ # Resource policies applied to this instance.

2403

"A String",

2404

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2405

"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]

2406

"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.

2407

#

2408

# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

2409

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

2410

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

2411

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

2412

"key": "A String", # Corresponds to the label key of Node resource.

2413

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

2414

"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]

2420

"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]

2421

},

2422

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

2423

"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

2424

#

2425

# 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.

2426

{ # A service account.

2427

"email": "A String", # Email address of the service account.

2428

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

2434

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

2435

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

2436

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

2437

},

2438

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

2439

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

2440

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2441

"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]

2442

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

2443

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

2444

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

2445

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2446

"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]

2447

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

2448

},

2449

"sourceMachineImage": "A String", # Source machine image

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2450

"sourceMachineImageEncryptionKey": { # Source GMI encryption key when creating an instance from GMI.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2451

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2452

"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.

2453

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2454

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

2455

#

2456

# The key must meet the following requirements before you can provide it to Compute Engine:

2457

# - The key is wrapped using a RSA public key certificate provided by Google.

2458

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

2459

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

2460

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

2461

},

2462

"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-07-22 17:02:09 -0700

[diff] [blame]

2463

"status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2464

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

2465

"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.

2466

"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.

2467

#

2468

# To see the latest fingerprint, make get() request to the instance.

2469

"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]

2474

}

2475

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2476

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.

2477

2478

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.

2479

2480

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]

2481

sourceInstanceTemplate: string, Specifies instance template to create the instance.

2482

2483

This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to an instance template:

2484

- https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate

2485

- projects/project/global/instanceTemplates/instanceTemplate

2486

- global/instanceTemplates/instanceTemplate

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2487

sourceMachineImage: string, Specifies instance machine to create the instance.

2488

2489

This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to an instance template:

2490

- https://www.googleapis.com/compute/v1/projects/project/global/global/machineImages/machineImage

2491

- projects/project/global/global/machineImages/machineImage

2492

- global/machineImages/machineImage

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2493

2494

Returns:

2495

An object of the form:

2496

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2497

{ # Represents an Operation resource.

2498

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2499

# Google Compute Engine has three Operation resources:

2500

#

2501

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2502

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2503

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2504

#

2505

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2506

# - For global operations, use the `globalOperations` resource.

2507

# - For regional operations, use the `regionOperations` resource.

2508

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2509

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2510

# 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]

2511

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2512

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2513

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2514

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2515

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2516

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2517

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2518

"code": "A String", # [Output Only] The error type identifier for this error.

2519

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2520

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2521

},

2522

],

2523

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2524

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2525

"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.

2526

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2527

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2528

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2529

"name": "A String", # [Output Only] Name of the operation.

2530

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2531

"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.

2532

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2533

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2534

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2535

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2536

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2537

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2538

"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.

2539

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2540

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2541

{

2542

"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.

2543

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2544

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2545

{

2546

"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).

2547

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2548

},

2549

],

2550

"message": "A String", # [Output Only] A human-readable description of the warning code.

2551

},

2552

],

2553

"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]

2558

<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]

2559

<pre>Retrieves the list of instances contained within the specified zone.

2560

2561

Args:

2562

project: string, Project ID for this request. (required)

2563

zone: string, The name of the zone for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2564

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]

2565

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2566

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]

2567

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2568

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]

2569

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2570

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) ```

2571

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`)

2572

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

2573

2574

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.

2575

2576

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

2577

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]

2578

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]

2579

2580

Returns:

2581

An object of the form:

2582

2583

{ # Contains a list of instances.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2584

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

2585

"items": [ # A list of Instance resources.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2586

{ # Represents an Instance resource.

2587

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2588

# 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]

2589

"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]

2590

"confidentialInstanceConfig": { # A set of Confidential Instance options.

2591

"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.

2592

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2593

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

2594

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

2595

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

2596

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2597

"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]

2598

{ # An instance-attached disk resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2599

"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).

2600

"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.

2601

"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.

2602

#

2603

# 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]

2604

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2605

#

2606

# 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.

2607

#

2608

# 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.

2609

#

2610

# 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.

2611

#

2612

# 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]

2613

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2614

"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.

2615

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2616

"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]

2617

#

2618

# The key must meet the following requirements before you can provide it to Compute Engine:

2619

# - 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]

2620

# - 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]

2621

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2622

"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]

2623

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2624

"diskSizeGb": "A String", # The size of the disk in GB.

2625

"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.

2626

{ # Guest OS features.

2627

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

2628

},

2629

],

2630

"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.

2631

"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]

2632

#

2633

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

2634

#

2635

# 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]

2636

"description": "A String", # An optional description. Provide this property when creating the disk.

2637

"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.

2638

"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.

2639

"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]

2640

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

2641

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2642

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2643

# 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:

2644

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType

2645

# - projects/project/zones/zone/diskTypes/diskType

2646

# - 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]

2647

"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]

2648

#

2649

# Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

2650

{ # Guest OS features.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2651

"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]

2652

},

2653

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2654

"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.

2655

"a_key": "A String",

2656

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2657

"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]

2658

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

2659

"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.

2660

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2661

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2662

"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]

2663

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2664

# 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:

2665

# projects/debian-cloud/global/images/family/debian-9

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2666

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2667

#

2668

# Alternatively, use a specific version of a public operating system image:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2669

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2670

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2671

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2672

# To create a disk with a custom image that you created, specify the image name in the following format:

2673

# global/images/my-custom-image

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2674

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2675

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2676

# 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:

2677

# global/images/family/my-image-family

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2678

#

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2679

#

2680

# If the source image is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2681

"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]

2682

#

2683

# 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.

2684

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2685

"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.

2686

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2687

"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]

2688

#

2689

# The key must meet the following requirements before you can provide it to Compute Engine:

2690

# - The key is wrapped using a RSA public key certificate provided by Google.

2691

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

2692

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2693

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

2694

},

2695

"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.

2696

#

2697

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

2698

# global/snapshots/my-backup

2699

#

2700

#

2701

# If the source snapshot is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2702

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2703

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2704

"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.

2705

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2706

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

2707

#

2708

# The key must meet the following requirements before you can provide it to Compute Engine:

2709

# - The key is wrapped using a RSA public key certificate provided by Google.

2710

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

2711

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

2712

"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]

2713

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2714

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2715

"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.

2716

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

2717

"licenses": [ # [Output Only] Any valid publicly visible licenses.

2718

"A String",

2719

],

2720

"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.

2721

"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

2722

"dbs": [ # The Key Database (db).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2723

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2724

"content": "A String", # The raw content in the secure keys file.

2725

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2726

},

2727

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2728

"dbxs": [ # The forbidden key database (dbx).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2729

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2730

"content": "A String", # The raw content in the secure keys file.

2731

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2732

},

2733

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2734

"keks": [ # The Key Exchange Key (KEK).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2735

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2736

"content": "A String", # The raw content in the secure keys file.

2737

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2738

},

2739

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2740

"pk": { # The Platform Key (PK).

2741

"content": "A String", # The raw content in the secure keys file.

2742

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2743

},

2744

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2745

"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]

2746

#

2747

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

2748

#

2749

# 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]

2750

"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]

2751

},

2752

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2753

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

2754

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

2755

},

2756

"eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.

2757

"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.

2758

#

2759

# To see the latest fingerprint, make get() request to the instance.

2760

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

2761

{ # A specification of the type and number of accelerator cards attached to the instance.

2762

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

2763

"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.

2764

},

2765

],

2766

"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.

2767

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

2768

"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.

2769

"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.

2770

#

2771

# To see the latest fingerprint, make get() request to the instance.

2772

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

2773

"a_key": "A String",

2774

},

2775

"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:

2776

# zones/us-central1-f/machineTypes/n1-standard-1

2777

#

2778

#

2779

# 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):

2780

# zones/zone/machineTypes/custom-CPUS-MEMORY

2781

#

2782

#

2783

# For example: zones/us-central1-f/machineTypes/custom-4-5120

2784

#

2785

# For a full list of restrictions, read the Specifications for custom machine types.

2786

"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

2787

"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.

2788

#

2789

# To see the latest fingerprint, make a get() request to retrieve the resource.

2790

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

2791

{

2792

"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.

2793

"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).

2794

},

2795

],

2796

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

2797

},

2798

"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".

2799

"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.

2800

"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.

2801

{ # A network interface resource attached to an instance.

2802

"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.

2803

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

2804

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

2805

"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.

2806

"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.

2807

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

2808

#

2809

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

2810

#

2811

# 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.

2812

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

2813

"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.

2814

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

2815

},

2816

],

2817

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

2818

{ # An alias IP range attached to an instance's network interface.

2819

"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).

2820

"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.

2821

},

2822

],

2823

"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.

2824

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

2825

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

2826

"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.

2827

"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.

2828

#

2829

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

2830

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

2831

# - projects/project/global/networks/network

2832

# - global/networks/default

2833

"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.

2834

"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:

2835

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

2836

# - regions/region/subnetworks/subnetwork

2837

},

2838

],

2839

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.

2840

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.

2841

"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.

2842

"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.

2843

"values": [ # Corresponds to the label values of a reservation resource.

"A String",

],

},

"resourcePolicies": [ # Resource policies applied to this instance.

2848

"A String",

2849

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2850

"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]

2851

"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.

2852

#

2853

# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

2854

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

2855

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

2856

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

2857

"key": "A String", # Corresponds to the label key of Node resource.

2858

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

2859

"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]

2865

"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]

2866

},

2867

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

2868

"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

2869

#

2870

# 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.

2871

{ # A service account.

2872

"email": "A String", # Email address of the service account.

2873

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

2879

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

2880

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

2881

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

2882

},

2883

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

2884

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

2885

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2886

"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]

2887

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

2888

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

2889

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

2890

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2891

"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]

2892

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

2893

},

2894

"sourceMachineImage": "A String", # Source machine image

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2895

"sourceMachineImageEncryptionKey": { # Source GMI encryption key when creating an instance from GMI.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2896

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2897

"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.

2898

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2899

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

2900

#

2901

# The key must meet the following requirements before you can provide it to Compute Engine:

2902

# - The key is wrapped using a RSA public key certificate provided by Google.

2903

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

2904

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

2905

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

2906

},

2907

"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-07-22 17:02:09 -0700

[diff] [blame]

2908

"status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2909

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

2910

"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.

2911

"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.

2912

#

2913

# To see the latest fingerprint, make get() request to the instance.

2914

"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]

2919

},

2920

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2921

"kind": "compute#instanceList", # [Output Only] Type of resource. Always compute#instanceList for lists of Instance resources.

2922

"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.

2923

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

2924

"warning": { # [Output Only] Informational warning message.

2925

"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.

2926

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2927

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2928

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2929

"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).

2930

"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]

2931

},

2932

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2933

"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]

2934

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2939

<code class="details" id="listReferrers">listReferrers(project, zone, instance, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2940

<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 instance group, the referrers list includes the managed instance group. For more information, read Viewing Referrers to VM Instances.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2941

2942

Args:

2943

project: string, Project ID for this request. (required)

2944

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2945

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]

2946

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]

2947

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2948

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]

2949

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2950

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]

2951

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2952

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]

2953

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]

2954

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

2955

2956

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.

2957

2958

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2959

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]

2960

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]

2961

2962

Returns:

2963

An object of the form:

2964

2965

{ # Contains a list of instance referrers.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2966

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

2967

"items": [ # A list of Reference resources.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2968

{ # Represents a reference to a resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2969

"kind": "compute#reference", # [Output Only] Type of the resource. Always compute#reference for references.

2970

"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]

2971

# - MEMBER_OF

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2972

"referrer": "A String", # URL of the resource which refers to the target.

2973

"target": "A String", # URL of the resource to which this reference points.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2974

},

2975

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2976

"kind": "compute#instanceListReferrers", # [Output Only] Type of resource. Always compute#instanceListReferrers for lists of Instance referrers.

2977

"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.

2978

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

2979

"warning": { # [Output Only] Informational warning message.

2980

"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.

2981

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2982

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2983

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2984

"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).

2985

"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]

2986

},

2987

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2988

"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]

2989

},

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>

2995

<pre>Retrieves the next page of results.

2996

2997

Args:

2998

previous_request: The request for the previous page. (required)

2999

previous_response: The response from the request for the previous page. (required)

3000

3001

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3002

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3003

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]

3008

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

3009

<pre>Retrieves the next page of results.

3010

3011

Args:

3012

previous_request: The request for the previous page. (required)

3013

previous_response: The response from the request for the previous page. (required)

3014

3015

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3016

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3017

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]

3022

<code class="details" id="removeResourcePolicies">removeResourcePolicies(project, zone, instance, body=None, requestId=None)</code>

3023

<pre>Removes resource policies from an instance.

3024

3025

Args:

3026

project: string, Project ID for this request. (required)

3027

zone: string, The name of the zone for this request. (required)

3028

instance: string, The instance name for this request. (required)

3029

body: object, The request body.

3030

The object takes the form of:

3031

3032

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3033

"resourcePolicies": [ # Resource policies to be removed from this instance.

3034

"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.

3039

3040

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.

3041

3042

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

3043

3044

Returns:

3045

An object of the form:

3046

3047

{ # Represents an Operation resource.

3048

#

3049

# Google Compute Engine has three Operation resources:

3050

#

3051

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

3052

#

3053

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

3054

#

3055

# Operations can be global, regional or zonal.

3056

# - For global operations, use the `globalOperations` resource.

3057

# - For regional operations, use the `regionOperations` resource.

3058

# - For zonal operations, use the `zonalOperations` resource.

3059

#

3060

# 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]

3061

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3062

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3063

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3064

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3065

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3066

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3067

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3068

"code": "A String", # [Output Only] The error type identifier for this error.

3069

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3070

"message": "A String", # [Output Only] An optional, human-readable error message.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3071

},

3072

],

3073

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3074

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3075

"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.

3076

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3077

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3078

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3079

"name": "A String", # [Output Only] Name of the operation.

3080

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3081

"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.

3082

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3083

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3084

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3085

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3086

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3087

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3088

"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.

3089

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3090

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3091

{

3092

"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.

3093

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

3094

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

3095

{

3096

"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).

3097

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3098

},

3099

],

3100

"message": "A String", # [Output Only] A human-readable description of the warning code.

3101

},

3102

],

3103

"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]

3108

<code class="details" id="reset">reset(project, zone, instance, requestId=None)</code>

3109

<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]

3110

3111

Args:

3112

project: string, Project ID for this request. (required)

3113

zone: string, The name of the zone for this request. (required)

3114

instance: string, Name of the instance scoping this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3115

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.

3116

3117

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.

3118

3119

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]

3120

3121

Returns:

3122

An object of the form:

3123

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3124

{ # Represents an Operation resource.

3125

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3126

# Google Compute Engine has three Operation resources:

3127

#

3128

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

3129

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3130

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

3131

#

3132

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3133

# - For global operations, use the `globalOperations` resource.

3134

# - For regional operations, use the `regionOperations` resource.

3135

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3136

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3137

# 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]

3138

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3139

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3140

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3141

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3142

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3143

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3144

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3145

"code": "A String", # [Output Only] The error type identifier for this error.

3146

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3147

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3148

},

3149

],

3150

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3151

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3152

"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.

3153

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3154

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3155

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3156

"name": "A String", # [Output Only] Name of the operation.

3157

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3158

"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.

3159

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3160

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3161

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3162

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3163

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3164

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3165

"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.

3166

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3167

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3168

{

3169

"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.

3170

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

3171

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

3172

{

3173

"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).

3174

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3175

},

3176

],

3177

"message": "A String", # [Output Only] A human-readable description of the warning code.

3178

},

3179

],

3180

"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]

3185

<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]

3186

<pre>Resumes an instance that was suspended using the instances().suspend method.

3187

3188

Args:

3189

project: string, Project ID for this request. (required)

3190

zone: string, The name of the zone for this request. (required)

3191

instance: string, Name of the instance resource to resume. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3192

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3193

The object takes the form of:

3194

3195

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3196

"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]

3197

#

3198

# In order to resume the instance, the disk url and its corresponding key must be provided.

3199

#

3200

# If the disk is not protected with a customer-supplied encryption key it should not be specified.

3201

{

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3202

"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]

3203

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3204

"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.

3205

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3206

"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]

3207

#

3208

# The key must meet the following requirements before you can provide it to Compute Engine:

3209

# - The key is wrapped using a RSA public key certificate provided by Google.

3210

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

3211

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3212

"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]

3213

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3214

"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]

3215

},

3216

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3217

"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]

3218

#

3219

# 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.

3220

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3221

"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.

3222

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3223

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

3224

#

3225

# The key must meet the following requirements before you can provide it to Compute Engine:

3226

# - The key is wrapped using a RSA public key certificate provided by Google.

3227

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

3228

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

3229

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

3230

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3231

}

3232

3233

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.

3234

3235

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.

3236

3237

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

3238

3239

Returns:

3240

An object of the form:

3241

3242

{ # Represents an Operation resource.

3243

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3244

# Google Compute Engine has three Operation resources:

3245

#

3246

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

3247

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3248

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

3249

#

3250

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3251

# - For global operations, use the `globalOperations` resource.

3252

# - For regional operations, use the `regionOperations` resource.

3253

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3254

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3255

# 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]

3256

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3257

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3258

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3259

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3260

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3261

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3262

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3263

"code": "A String", # [Output Only] The error type identifier for this error.

3264

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3265

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3266

},

3267

],

3268

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3269

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3270

"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.

3271

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3272

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3273

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3274

"name": "A String", # [Output Only] Name of the operation.

3275

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3276

"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.

3277

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3278

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3279

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3280

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3281

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3282

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3283

"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.

3284

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3285

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3286

{

3287

"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.

3288

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

3289

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

3290

{

3291

"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).

3292

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3293

},

3294

],

3295

"message": "A String", # [Output Only] A human-readable description of the warning code.

3296

},

3297

],

3298

"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>

3304

<pre>Sets deletion protection on the instance.

3305

3306

Args:

3307

project: string, Project ID for this request. (required)

3308

zone: string, The name of the zone for this request. (required)

3309

resource: string, Name or id of the resource for this request. (required)

3310

deletionProtection: boolean, Whether the resource should be protected against deletion.

3311

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.

3312

3313

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.

3314

3315

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

3316

3317

Returns:

3318

An object of the form:

3319

3320

{ # Represents an Operation resource.

3321

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3322

# Google Compute Engine has three Operation resources:

3323

#

3324

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

3325

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3326

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

3327

#

3328

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3329

# - For global operations, use the `globalOperations` resource.

3330

# - For regional operations, use the `regionOperations` resource.

3331

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3332

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3333

# 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]

3334

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3335

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3336

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3337

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3338

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3339

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3340

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3341

"code": "A String", # [Output Only] The error type identifier for this error.

3342

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3343

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3344

},

3345

],

3346

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3347

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3348

"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.

3349

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3350

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3351

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3352

"name": "A String", # [Output Only] Name of the operation.

3353

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3354

"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.

3355

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3356

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3357

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3358

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3359

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3360

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3361

"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.

3362

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3363

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3364

{

3365

"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.

3366

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

3367

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

3368

{

3369

"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).

3370

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3371

},

3372

],

3373

"message": "A String", # [Output Only] A human-readable description of the warning code.

3374

},

3375

],

3376

"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]

3382

<pre>Sets the auto-delete flag for a disk attached to an instance.

3383

3384

Args:

3385

project: string, Project ID for this request. (required)

3386

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3387

instance: string, The instance name for this request. (required)

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3388

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]

3389

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)

3390

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.

3391

3392

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.

3393

3394

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]

3395

3396

Returns:

3397

An object of the form:

3398

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3399

{ # Represents an Operation resource.

3400

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3401

# Google Compute Engine has three Operation resources:

3402

#

3403

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

3404

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3405

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

3406

#

3407

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3408

# - For global operations, use the `globalOperations` resource.

3409

# - For regional operations, use the `regionOperations` resource.

3410

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3411

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3412

# 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]

3413

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3414

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3415

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3416

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3417

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3418

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3419

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3420

"code": "A String", # [Output Only] The error type identifier for this error.

3421

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3422

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3423

},

3424

],

3425

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3426

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3427

"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.

3428

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3429

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3430

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3431

"name": "A String", # [Output Only] Name of the operation.

3432

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3433

"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.

3434

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3435

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3436

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3437

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3438

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3439

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3440

"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.

3441

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3442

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3443

{

3444

"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.

3445

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

3446

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

3447

{

3448

"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).

3449

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3450

},

3451

],

3452

"message": "A String", # [Output Only] A human-readable description of the warning code.

3453

},

3454

],

3455

"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]

3460

<code class="details" id="setIamPolicy">setIamPolicy(project, zone, resource, body=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3461

<pre>Sets the access control policy on the specified resource. Replaces any existing policy.

3462

3463

Args:

3464

project: string, Project ID for this request. (required)

3465

zone: string, The name of the zone for this request. (required)

3466

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3467

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3468

The object takes the form of:

3469

3470

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3471

"bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings.

3472

{ # Associates `members` with a `role`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3473

"bindingId": "A String", # A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3474

"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.

3475

#

3476

# If the condition evaluates to `true`, then this binding applies to the current request.

3477

#

3478

# 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.

3479

#

3480

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

3481

#

3482

# Example (Comparison):

3483

#

3484

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

3485

#

3486

# Example (Equality):

3487

#

3488

# 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'"

3493

#

3494

# Example (Data Manipulation):

3495

#

3496

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

3497

#

3498

# 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.

3499

"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.

3500

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

3501

"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.

3502

"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.

3503

},

3504

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

3505

#

3506

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

3507

#

3508

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

3509

#

3510

# * `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`.

3515

#

3516

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

3517

#

3518

# * `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.

3519

#

3520

# * `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.

3521

#

3522

# * `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`.

3527

"A String",

3528

],

3529

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

3530

},

3531

],

3532

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.

3533

"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]

3534

#

3535

#

3536

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3537

# 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]

3538

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3539

# 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]

3540

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3541

# **JSON example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3542

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3543

# { "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]

3544

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3545

# **YAML example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3546

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3547

# 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]

3548

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3549

# 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]

3550

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3551

{ # 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.

3552

#

3553

# 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.

3554

#

3555

# Example Policy with multiple AuditConfigs:

3556

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3557

# { "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]

3558

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3559

# 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]

3560

"auditLogConfigs": [ # The configuration for logging of each type of permission.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3561

{ # Provides the configuration for logging a type of permissions. Example:

3562

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3563

# { "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]

3564

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3565

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

3566

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

3567

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3568

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3569

"ignoreChildExemptions": True or False,

3570

"logType": "A String", # The log type that this config enables.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3571

},

3572

],

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]

3577

},

3578

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3579

"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]

3580

{ # Associates `members` with a `role`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3581

"bindingId": "A String", # A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3582

"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.

3583

#

3584

# If the condition evaluates to `true`, then this binding applies to the current request.

3585

#

3586

# 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.

3587

#

3588

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

3589

#

3590

# Example (Comparison):

3591

#

3592

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

3593

#

3594

# Example (Equality):

3595

#

3596

# 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'"

3601

#

3602

# Example (Data Manipulation):

3603

#

3604

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

3605

#

3606

# 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.

3607

"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.

3608

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

3609

"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.

3610

"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.

3611

},

3612

"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]

3613

#

3614

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

3615

#

3616

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

3617

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3618

# * `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`.

3623

#

3624

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

3625

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3626

# * `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.

3627

#

3628

# * `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.

3629

#

3630

# * `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.

3631

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3632

#

3633

#

3634

# * `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]

3635

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3636

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3637

"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]

3638

},

3639

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3640

"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.

3641

#

3642

# **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.

3643

"iamOwned": True or False,

3644

"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.

3645

{ # A rule to be applied in a Policy.

3646

"action": "A String", # Required

3647

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

3648

{ # A condition to be met.

3649

"iam": "A String", # Trusted attributes supplied by the IAM system.

3650

"op": "A String", # An operator to apply the subject with.

3651

"svc": "A String", # Trusted attributes discharged by the service.

3652

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

3653

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

3659

"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.

3660

"A String",

3661

],

3662

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

3663

{ # Specifies what kind of log the caller must write

3664

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

3665

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

3666

"permissionType": "A String", # The type of the permission that was checked.

3667

},

3668

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

3669

},

3670

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

3671

#

3672

# 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.

3673

#

3674

# Field names correspond to IAM request parameters and field values are their respective values.

3675

#

3676

# 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.

3677

#

3678

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

3679

"customFields": [ # Custom fields.

3680

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

3681

"name": "A String", # Name is the field name.

3682

"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.

3683

},

3684

],

3685

"field": "A String", # The field value to attribute.

3686

"metric": "A String", # The metric to update.

3687

},

3688

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

3689

"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.

3694

"A String",

3695

],

3696

"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.

3697

"A String",

3698

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3699

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3700

],

3701

"version": 42, # Specifies the format of the policy.

3702

#

3703

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

3704

#

3705

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

3706

#

3707

# * 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

3708

#

3709

# **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.

3710

#

3711

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

3712

#

3713

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

3714

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}

Returns:

An object of the form:

3720

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3721

{ # 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]

3722

#

3723

#

3724

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3725

# 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]

3726

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3727

# 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]

3728

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3729

# **JSON example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3730

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3731

# { "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]

3732

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3733

# **YAML example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3734

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3735

# 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]

3736

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3737

# 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]

3738

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3739

{ # 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.

3740

#

3741

# 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.

3742

#

3743

# Example Policy with multiple AuditConfigs:

3744

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3745

# { "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]

3746

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3747

# 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]

3748

"auditLogConfigs": [ # The configuration for logging of each type of permission.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3749

{ # Provides the configuration for logging a type of permissions. Example:

3750

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3751

# { "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]

3752

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3753

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

3754

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

3755

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3756

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3757

"ignoreChildExemptions": True or False,

3758

"logType": "A String", # The log type that this config enables.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3759

},

3760

],

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]

3765

},

3766

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3767

"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]

3768

{ # Associates `members` with a `role`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3769

"bindingId": "A String", # A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3770

"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.

3771

#

3772

# If the condition evaluates to `true`, then this binding applies to the current request.

3773

#

3774

# 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.

3775

#

3776

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

3777

#

3778

# Example (Comparison):

3779

#

3780

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

3781

#

3782

# Example (Equality):

3783

#

3784

# 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'"

3789

#

3790

# Example (Data Manipulation):

3791

#

3792

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

3793

#

3794

# 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.

3795

"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.

3796

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

3797

"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.

3798

"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.

3799

},

3800

"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]

3801

#

3802

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

3803

#

3804

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

3805

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3806

# * `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`.

3811

#

3812

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

3813

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3814

# * `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.

3815

#

3816

# * `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.

3817

#

3818

# * `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.

3819

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3820

#

3821

#

3822

# * `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]

3823

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3824

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3825

"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]

3826

},

3827

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3828

"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.

3829

#

3830

# **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.

3831

"iamOwned": True or False,

3832

"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.

3833

{ # A rule to be applied in a Policy.

3834

"action": "A String", # Required

3835

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

3836

{ # A condition to be met.

3837

"iam": "A String", # Trusted attributes supplied by the IAM system.

3838

"op": "A String", # An operator to apply the subject with.

3839

"svc": "A String", # Trusted attributes discharged by the service.

3840

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

3841

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

3847

"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.

3848

"A String",

3849

],

3850

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

3851

{ # Specifies what kind of log the caller must write

3852

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

3853

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

3854

"permissionType": "A String", # The type of the permission that was checked.

3855

},

3856

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

3857

},

3858

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

3859

#

3860

# 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.

3861

#

3862

# Field names correspond to IAM request parameters and field values are their respective values.

3863

#

3864

# 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.

3865

#

3866

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

3867

"customFields": [ # Custom fields.

3868

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

3869

"name": "A String", # Name is the field name.

3870

"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.

3871

},

3872

],

3873

"field": "A String", # The field value to attribute.

3874

"metric": "A String", # The metric to update.

3875

},

3876

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

3877

"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.

3882

"A String",

3883

],

3884

"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.

3890

#

3891

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

3892

#

3893

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

3894

#

3895

# * 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

3896

#

3897

# **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.

3898

#

3899

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

3900

#

3901

# 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]

3906

<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]

3907

<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]

3908

3909

Args:

3910

project: string, Project ID for this request. (required)

3911

zone: string, The name of the zone for this request. (required)

3912

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3913

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3914

The object takes the form of:

3915

3916

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3917

"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.

3918

"labels": {

3919

"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]

3923

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.

3924

3925

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.

3926

3927

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]

3928

3929

Returns:

3930

An object of the form:

3931

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3932

{ # Represents an Operation resource.

3933

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3934

# Google Compute Engine has three Operation resources:

3935

#

3936

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

3937

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3938

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

3939

#

3940

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3941

# - For global operations, use the `globalOperations` resource.

3942

# - For regional operations, use the `regionOperations` resource.

3943

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3944

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3945

# 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]

3946

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3947

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3948

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3949

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3950

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3951

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

3952

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3953

"code": "A String", # [Output Only] The error type identifier for this error.

3954

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3955

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

3956

},

3957

],

3958

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3959

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3960

"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.

3961

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3962

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3963

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3964

"name": "A String", # [Output Only] Name of the operation.

3965

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3966

"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.

3967

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3968

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3969

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3970

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3971

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3972

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3973

"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.

3974

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3975

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3976

{

3977

"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.

3978

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

3979

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

3980

{

3981

"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).

3982

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3983

},

3984

],

3985

"message": "A String", # [Output Only] A human-readable description of the warning code.

3986

},

3987

],

3988

"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]

3993

<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]

3994

<pre>Changes the number and/or type of accelerator for a stopped instance to the values specified in the request.

3995

3996

Args:

3997

project: string, Project ID for this request. (required)

3998

zone: string, The name of the zone for this request. (required)

3999

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4000

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

4001

The object takes the form of:

4002

4003

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4004

"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]

4005

{ # 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]

4006

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

4007

"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]

4012

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.

4013

4014

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.

4015

4016

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]

4017

4018

Returns:

4019

An object of the form:

4020

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4021

{ # Represents an Operation resource.

4022

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4023

# Google Compute Engine has three Operation resources:

4024

#

4025

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4026

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4027

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4028

#

4029

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4030

# - For global operations, use the `globalOperations` resource.

4031

# - For regional operations, use the `regionOperations` resource.

4032

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4033

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4034

# 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]

4035

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4036

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4037

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4038

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4039

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4040

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4041

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4042

"code": "A String", # [Output Only] The error type identifier for this error.

4043

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4044

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4045

},

4046

],

4047

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4048

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4049

"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.

4050

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4051

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4052

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4053

"name": "A String", # [Output Only] Name of the operation.

4054

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4055

"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.

4056

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4057

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4058

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4059

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4060

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4061

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4062

"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.

4063

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4064

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4065

{

4066

"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.

4067

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4068

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4069

{

4070

"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).

4071

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4072

},

4073

],

4074

"message": "A String", # [Output Only] A human-readable description of the warning code.

4075

},

4076

],

4077

"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]

4082

<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]

4083

<pre>Changes the machine type for a stopped instance to the machine type specified in the request.

4084

4085

Args:

4086

project: string, Project ID for this request. (required)

4087

zone: string, The name of the zone for this request. (required)

4088

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4089

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4090

The object takes the form of:

4091

4092

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4093

"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]

4094

}

4095

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4096

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.

4097

4098

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.

4099

4100

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]

4101

4102

Returns:

4103

An object of the form:

4104

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4105

{ # Represents an Operation resource.

4106

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4107

# Google Compute Engine has three Operation resources:

4108

#

4109

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4110

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4111

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4112

#

4113

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4114

# - For global operations, use the `globalOperations` resource.

4115

# - For regional operations, use the `regionOperations` resource.

4116

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4117

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4118

# 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]

4119

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4120

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4121

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4122

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4123

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4124

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4125

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4126

"code": "A String", # [Output Only] The error type identifier for this error.

4127

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4128

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4129

},

4130

],

4131

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4132

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4133

"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.

4134

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4135

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4136

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4137

"name": "A String", # [Output Only] Name of the operation.

4138

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4139

"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.

4140

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4141

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4142

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4143

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4144

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4145

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4146

"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.

4147

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4148

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4149

{

4150

"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.

4151

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4152

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4153

{

4154

"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).

4155

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4156

},

4157

],

4158

"message": "A String", # [Output Only] A human-readable description of the warning code.

4159

},

4160

],

4161

"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]

4166

<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]

4167

<pre>Sets metadata for the specified instance to the data included in the request.

4168

4169

Args:

4170

project: string, Project ID for this request. (required)

4171

zone: string, The name of the zone for this request. (required)

4172

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4173

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4174

The object takes the form of:

4175

4176

{ # A metadata key/value entry.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4177

"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]

4178

#

4179

# 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]

4180

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

4181

{

4182

"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.

4183

"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).

4184

},

4185

],

4186

"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]

4187

}

4188

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4189

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.

4190

4191

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.

4192

4193

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]

4194

4195

Returns:

4196

An object of the form:

4197

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4198

{ # Represents an Operation resource.

4199

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4200

# Google Compute Engine has three Operation resources:

4201

#

4202

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4203

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4204

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4205

#

4206

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4207

# - For global operations, use the `globalOperations` resource.

4208

# - For regional operations, use the `regionOperations` resource.

4209

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4210

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4211

# 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]

4212

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4213

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4214

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4215

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4216

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4217

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4218

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4219

"code": "A String", # [Output Only] The error type identifier for this error.

4220

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4221

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4222

},

4223

],

4224

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4225

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4226

"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.

4227

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4228

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4229

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4230

"name": "A String", # [Output Only] Name of the operation.

4231

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4232

"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.

4233

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4234

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4235

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4236

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4237

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4238

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4239

"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.

4240

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4241

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4242

{

4243

"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.

4244

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4245

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4246

{

4247

"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).

4248

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4249

},

4250

],

4251

"message": "A String", # [Output Only] A human-readable description of the warning code.

4252

},

4253

],

4254

"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]

4259

<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]

4260

<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]

4261

4262

Args:

4263

project: string, Project ID for this request. (required)

4264

zone: string, The name of the zone for this request. (required)

4265

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4266

body: object, The request body.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4267

The object takes the form of:

4268

4269

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4270

"minCpuPlatform": "A String", # Minimum cpu/platform this instance should be started at.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4271

}

4272

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4273

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.

4274

4275

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.

4276

4277

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]

4278

4279

Returns:

4280

An object of the form:

4281

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4282

{ # Represents an Operation resource.

4283

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4284

# Google Compute Engine has three Operation resources:

4285

#

4286

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4287

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4288

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4289

#

4290

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4291

# - For global operations, use the `globalOperations` resource.

4292

# - For regional operations, use the `regionOperations` resource.

4293

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4294

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4295

# 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]

4296

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4297

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4298

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4299

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4300

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4301

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4302

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4303

"code": "A String", # [Output Only] The error type identifier for this error.

4304

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4305

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4306

},

4307

],

4308

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4309

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4310

"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.

4311

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4312

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4313

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4314

"name": "A String", # [Output Only] Name of the operation.

4315

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4316

"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.

4317

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4318

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4319

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4320

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4321

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4322

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4323

"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.

4324

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4325

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4326

{

4327

"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.

4328

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4329

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4330

{

4331

"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).

4332

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4333

},

4334

],

4335

"message": "A String", # [Output Only] A human-readable description of the warning code.

4336

},

4337

],

4338

"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]

4343

<code class="details" id="setName">setName(project, zone, instance, body=None, requestId=None)</code>

4344

<pre>Sets name of an instance.

4345

4346

Args:

4347

project: string, Project ID for this request. (required)

4348

zone: string, The name of the zone for this request. (required)

4349

instance: string, The instance name for this request. (required)

4350

body: object, The request body.

4351

The object takes the form of:

4352

4353

{

4354

"currentName": "A String", # The current name of this resource, used to prevent conflicts. Provide the latest name when making a request to change name.

4355

"name": "A String", # The name to be applied to the instance. Needs to be RFC 1035 compliant.

4356

}

4357

4358

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.

4359

4360

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.

4361

4362

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

4363

4364

Returns:

4365

An object of the form:

4366

4367

{ # Represents an Operation resource.

4368

#

4369

# Google Compute Engine has three Operation resources:

4370

#

4371

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4372

#

4373

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4374

#

4375

# Operations can be global, regional or zonal.

4376

# - For global operations, use the `globalOperations` resource.

4377

# - For regional operations, use the `regionOperations` resource.

4378

# - For zonal operations, use the `zonalOperations` resource.

4379

#

4380

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

4381

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4382

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4383

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4384

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4385

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4386

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

4387

{

4388

"code": "A String", # [Output Only] The error type identifier for this error.

4389

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4390

"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`.

4395

"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.

4396

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4397

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4398

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4399

"name": "A String", # [Output Only] Name of the operation.

4400

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4401

"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.

4402

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4403

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4404

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4405

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4406

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4407

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4408

"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.

4409

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4410

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4411

{

4412

"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.

4413

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4414

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4415

{

4416

"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).

4417

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4418

},

4419

],

4420

"message": "A String", # [Output Only] A human-readable description of the warning code.

4421

},

4422

],

4423

"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]

4428

<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]

4429

<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]

4430

4431

Args:

4432

project: string, Project ID for this request. (required)

4433

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4434

instance: string, Instance name for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4435

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4436

The object takes the form of:

4437

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4438

{ # Sets the scheduling options for an Instance. NextID: 13

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4439

"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]

4440

#

4441

# 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]

4442

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

4443

"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]

4444

{ # 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]

4445

"key": "A String", # Corresponds to the label key of Node resource.

4446

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

4447

"values": [ # Corresponds to the label values of Node resource.

4448

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4449

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4450

},

4451

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4452

"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]

4453

"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]

4454

}

4455

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4456

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.

4457

4458

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.

4459

4460

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]

4461

4462

Returns:

4463

An object of the form:

4464

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4465

{ # Represents an Operation resource.

4466

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4467

# Google Compute Engine has three Operation resources:

4468

#

4469

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4470

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4471

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4472

#

4473

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4474

# - For global operations, use the `globalOperations` resource.

4475

# - For regional operations, use the `regionOperations` resource.

4476

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4477

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4478

# 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]

4479

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4480

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4481

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4482

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4483

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4484

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4485

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4486

"code": "A String", # [Output Only] The error type identifier for this error.

4487

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4488

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4489

},

4490

],

4491

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4492

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4493

"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.

4494

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4495

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4496

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4497

"name": "A String", # [Output Only] Name of the operation.

4498

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4499

"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.

4500

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4501

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4502

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4503

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4504

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4505

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4506

"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.

4507

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4508

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4509

{

4510

"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.

4511

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4512

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4513

{

4514

"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).

4515

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4516

},

4517

],

4518

"message": "A String", # [Output Only] A human-readable description of the warning code.

4519

},

4520

],

4521

"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]

4526

<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]

4527

<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]

4528

4529

Args:

4530

project: string, Project ID for this request. (required)

4531

zone: string, The name of the zone for this request. (required)

4532

instance: string, Name of the instance resource to start. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4533

body: object, The request body.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

4534

The object takes the form of:

4535

4536

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4537

"email": "A String", # Email address of the service account.

4538

"scopes": [ # The list of scopes to be made available for this service account.

4539

"A String",

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

4540

],

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

4541

}

4542

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4543

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.

4544

4545

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.

4546

4547

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]

4548

4549

Returns:

4550

An object of the form:

4551

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4552

{ # Represents an Operation resource.

4553

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4554

# Google Compute Engine has three Operation resources:

4555

#

4556

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4557

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4558

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4559

#

4560

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4561

# - For global operations, use the `globalOperations` resource.

4562

# - For regional operations, use the `regionOperations` resource.

4563

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4564

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4565

# 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]

4566

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4567

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4568

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4569

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4570

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4571

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

4572

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4573

"code": "A String", # [Output Only] The error type identifier for this error.

4574

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4575

"message": "A String", # [Output Only] An optional, human-readable error message.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

4576

},

4577

],

4578

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4579

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4580

"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.

4581

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4582

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4583

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4584

"name": "A String", # [Output Only] Name of the operation.

4585

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4586

"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.

4587

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4588

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4589

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4590

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4591

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4592

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4593

"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.

4594

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4595

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4596

{

4597

"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.

4598

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4599

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4600

{

4601

"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).

4602

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4603

},

4604

],

4605

"message": "A String", # [Output Only] A human-readable description of the warning code.

4606

},

4607

],

4608

"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]

4613

<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]

4614

<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.

4615

4616

Args:

4617

project: string, Project ID for this request. (required)

4618

zone: string, The name of the zone for this request. (required)

4619

instance: string, Name or id of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4620

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4621

The object takes the form of:

4622

4623

{ # The policy describes the baseline against which Instance boot integrity is measured.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4624

"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]

4625

}

4626

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4627

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.

4628

4629

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.

4630

4631

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]

4632

4633

Returns:

4634

An object of the form:

4635

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4636

{ # Represents an Operation resource.

4637

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4638

# Google Compute Engine has three Operation resources:

4639

#

4640

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4641

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4642

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4643

#

4644

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4645

# - For global operations, use the `globalOperations` resource.

4646

# - For regional operations, use the `regionOperations` resource.

4647

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4648

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4649

# 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]

4650

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4651

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4652

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4653

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4654

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4655

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4656

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4657

"code": "A String", # [Output Only] The error type identifier for this error.

4658

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4659

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4660

},

4661

],

4662

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4663

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4664

"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.

4665

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4666

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4667

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4668

"name": "A String", # [Output Only] Name of the operation.

4669

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4670

"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.

4671

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4672

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4673

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4674

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4675

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4676

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4677

"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.

4678

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4679

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4680

{

4681

"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.

4682

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4683

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4684

{

4685

"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).

4686

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4687

},

4688

],

4689

"message": "A String", # [Output Only] A human-readable description of the warning code.

4690

},

4691

],

4692

"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>

4698

<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.

4699

4700

Args:

4701

project: string, Project ID for this request. (required)

4702

zone: string, The name of the zone for this request. (required)

4703

instance: string, Name of the instance scoping this request. (required)

4704

body: object, The request body.

4705

The object takes the form of:

4706

4707

{ # The policy describes the baseline against which VM instance boot integrity is measured.

4708

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

4709

}

4710

4711

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.

4712

4713

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.

4714

4715

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

4716

4717

Returns:

4718

An object of the form:

4719

4720

{ # Represents an Operation resource.

4721

#

4722

# Google Compute Engine has three Operation resources:

4723

#

4724

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4725

#

4726

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4727

#

4728

# Operations can be global, regional or zonal.

4729

# - For global operations, use the `globalOperations` resource.

4730

# - For regional operations, use the `regionOperations` resource.

4731

# - For zonal operations, use the `zonalOperations` resource.

4732

#

4733

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

4734

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4735

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4736

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4737

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4738

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4739

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

4740

{

4741

"code": "A String", # [Output Only] The error type identifier for this error.

4742

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4743

"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`.

4748

"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.

4749

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4750

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4751

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4752

"name": "A String", # [Output Only] Name of the operation.

4753

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4754

"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.

4755

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4756

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4757

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4758

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4759

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4760

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4761

"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.

4762

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4763

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4764

{

4765

"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.

4766

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4767

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4768

{

4769

"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).

4770

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4771

},

4772

],

4773

"message": "A String", # [Output Only] A human-readable description of the warning code.

4774

},

4775

],

4776

"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>

4782

<pre>Sets network tags for the specified instance to the data included in the request.

4783

4784

Args:

4785

project: string, Project ID for this request. (required)

4786

zone: string, The name of the zone for this request. (required)

4787

instance: string, Name of the instance scoping this request. (required)

4788

body: object, The request body.

4789

The object takes the form of:

4790

4791

{ # A set of instance tags.

4792

"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.

4793

#

4794

# To see the latest fingerprint, make get() request to the instance.

4795

"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.

4801

4802

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.

4803

4804

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

4805

4806

Returns:

4807

An object of the form:

4808

4809

{ # Represents an Operation resource.

4810

#

4811

# Google Compute Engine has three Operation resources:

4812

#

4813

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4814

#

4815

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4816

#

4817

# Operations can be global, regional or zonal.

4818

# - For global operations, use the `globalOperations` resource.

4819

# - For regional operations, use the `regionOperations` resource.

4820

# - For zonal operations, use the `zonalOperations` resource.

4821

#

4822

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

4823

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4824

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4825

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4826

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4827

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4828

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

4829

{

4830

"code": "A String", # [Output Only] The error type identifier for this error.

4831

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4832

"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`.

4837

"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.

4838

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4839

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4840

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4841

"name": "A String", # [Output Only] Name of the operation.

4842

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4843

"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.

4844

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4845

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4846

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4847

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4848

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4849

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4850

"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.

4851

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4852

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4853

{

4854

"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.

4855

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4856

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4857

{

4858

"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).

4859

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4860

},

4861

],

4862

"message": "A String", # [Output Only] A human-readable description of the warning code.

4863

},

4864

],

4865

"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]

4870

<code class="details" id="simulateMaintenanceEvent">simulateMaintenanceEvent(project, zone, instance)</code>

4871

<pre>Simulates a maintenance event on the instance.

4872

4873

Args:

4874

project: string, Project ID for this request. (required)

4875

zone: string, The name of the zone for this request. (required)

4876

instance: string, Name of the instance scoping this request. (required)

4877

4878

Returns:

4879

An object of the form:

4880

4881

{ # Represents an Operation resource.

4882

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4883

# Google Compute Engine has three Operation resources:

4884

#

4885

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4886

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4887

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4888

#

4889

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4890

# - For global operations, use the `globalOperations` resource.

4891

# - For regional operations, use the `regionOperations` resource.

4892

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4893

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4894

# 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]

4895

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4896

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4897

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4898

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4899

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4900

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4901

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4902

"code": "A String", # [Output Only] The error type identifier for this error.

4903

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4904

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4905

},

4906

],

4907

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4908

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4909

"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.

4910

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4911

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4912

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4913

"name": "A String", # [Output Only] Name of the operation.

4914

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4915

"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.

4916

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4917

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4918

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4919

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4920

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4921

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4922

"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.

4923

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4924

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4925

{

4926

"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.

4927

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4928

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4929

{

4930

"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).

4931

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4932

},

4933

],

4934

"message": "A String", # [Output Only] A human-readable description of the warning code.

4935

},

4936

],

4937

"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>

4943

<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]

4944

4945

Args:

4946

project: string, Project ID for this request. (required)

4947

zone: string, The name of the zone for this request. (required)

4948

instance: string, Name of the instance resource to start. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4949

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.

4950

4951

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.

4952

4953

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]

4954

4955

Returns:

4956

An object of the form:

4957

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4958

{ # Represents an Operation resource.

4959

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4960

# Google Compute Engine has three Operation resources:

4961

#

4962

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4963

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4964

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4965

#

4966

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4967

# - For global operations, use the `globalOperations` resource.

4968

# - For regional operations, use the `regionOperations` resource.

4969

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4970

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4971

# 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]

4972

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4973

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4974

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4975

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4976

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4977

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4978

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4979

"code": "A String", # [Output Only] The error type identifier for this error.

4980

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4981

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4982

},

4983

],

4984

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4985

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4986

"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.

4987

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4988

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4989

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4990

"name": "A String", # [Output Only] Name of the operation.

4991

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4992

"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.

4993

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4994

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4995

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4996

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4997

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4998

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4999

"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.

5000

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5001

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5002

{

5003

"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.

5004

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5005

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5006

{

5007

"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).

5008

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5009

},

5010

],

5011

"message": "A String", # [Output Only] A human-readable description of the warning code.

5012

},

5013

],

5014

"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]

5019

<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]

5020

<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]

5021

5022

Args:

5023

project: string, Project ID for this request. (required)

5024

zone: string, The name of the zone for this request. (required)

5025

instance: string, Name of the instance resource to start. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5026

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5027

The object takes the form of:

5028

5029

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5030

"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]

5031

#

5032

# In order to start the instance, the disk url and its corresponding key must be provided.

5033

#

5034

# If the disk is not protected with a customer-supplied encryption key it should not be specified.

5035

{

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5036

"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]

5037

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

5038

"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.

5039

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

5040

"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]

5041

#

5042

# The key must meet the following requirements before you can provide it to Compute Engine:

5043

# - 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]

5044

# - 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]

5045

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5046

"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]

5047

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5048

"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]

5053

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.

5054

5055

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.

5056

5057

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]

5058

5059

Returns:

5060

An object of the form:

5061

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5062

{ # Represents an Operation resource.

5063

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5064

# Google Compute Engine has three Operation resources:

5065

#

5066

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5067

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5068

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5069

#

5070

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5071

# - For global operations, use the `globalOperations` resource.

5072

# - For regional operations, use the `regionOperations` resource.

5073

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5074

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5075

# 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]

5076

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5077

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5078

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5079

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5080

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5081

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5082

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5083

"code": "A String", # [Output Only] The error type identifier for this error.

5084

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5085

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5086

},

5087

],

5088

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5089

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5090

"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.

5091

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5092

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5093

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5094

"name": "A String", # [Output Only] Name of the operation.

5095

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5096

"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.

5097

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5098

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5099

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5100

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5101

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5102

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5103

"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.

5104

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5105

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5106

{

5107

"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.

5108

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5109

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5110

{

5111

"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).

5112

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5113

},

5114

],

5115

"message": "A String", # [Output Only] A human-readable description of the warning code.

5116

},

5117

],

5118

"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]

5123

<code class="details" id="stop">stop(project, zone, instance, requestId=None)</code>

5124

<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]

5125

5126

Args:

5127

project: string, Project ID for this request. (required)

5128

zone: string, The name of the zone for this request. (required)

5129

instance: string, Name of the instance resource to stop. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5130

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.

5131

5132

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.

5133

5134

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]

5135

5136

Returns:

5137

An object of the form:

5138

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5139

{ # Represents an Operation resource.

5140

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5141

# Google Compute Engine has three Operation resources:

5142

#

5143

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5144

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5145

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5146

#

5147

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5148

# - For global operations, use the `globalOperations` resource.

5149

# - For regional operations, use the `regionOperations` resource.

5150

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5151

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5152

# 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]

5153

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5154

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5155

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5156

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5157

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5158

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5159

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5160

"code": "A String", # [Output Only] The error type identifier for this error.

5161

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5162

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5163

},

5164

],

5165

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5166

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5167

"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.

5168

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5169

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5170

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5171

"name": "A String", # [Output Only] Name of the operation.

5172

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5173

"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.

5174

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5175

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5176

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5177

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5178

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5179

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5180

"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.

5181

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5182

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5183

{

5184

"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.

5185

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5186

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5187

{

5188

"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).

5189

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5190

},

5191

],

5192

"message": "A String", # [Output Only] A human-readable description of the warning code.

5193

},

5194

],

5195

"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>

5201

<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.

5202

5203

Args:

5204

project: string, Project ID for this request. (required)

5205

zone: string, The name of the zone for this request. (required)

5206

instance: string, Name of the instance resource to suspend. (required)

5207

discardLocalSsd: boolean, If true, discard the contents of any attached localSSD partitions. Default value is false (== preserve localSSD data).

5208

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.

5209

5210

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.

5211

5212

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

5213

5214

Returns:

5215

An object of the form:

5216

5217

{ # Represents an Operation resource.

5218

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5219

# Google Compute Engine has three Operation resources:

5220

#

5221

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5222

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5223

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5224

#

5225

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5226

# - For global operations, use the `globalOperations` resource.

5227

# - For regional operations, use the `regionOperations` resource.

5228

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5229

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5230

# 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]

5231

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5232

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5233

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5234

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5235

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5236

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5237

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5238

"code": "A String", # [Output Only] The error type identifier for this error.

5239

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5240

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5241

},

5242

],

5243

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5244

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5245

"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.

5246

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5247

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5248

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5249

"name": "A String", # [Output Only] Name of the operation.

5250

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5251

"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.

5252

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5253

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5254

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5255

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5256

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5257

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5258

"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.

5259

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5260

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5261

{

5262

"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.

5263

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5264

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5265

{

5266

"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).

5267

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5268

},

5269

],

5270

"message": "A String", # [Output Only] A human-readable description of the warning code.

5271

},

5272

],

5273

"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]

5278

<code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5279

<pre>Returns permissions that a caller has on the specified resource.

5280

5281

Args:

5282

project: string, Project ID for this request. (required)

5283

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5284

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5285

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5286

The object takes the form of:

5287

5288

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5289

"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.

5290

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

],

}

Returns:

An object of the form:

5297

5298

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5299

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.

5300

"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]

5305

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5306

<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]

5307

<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.

5308

5309

Args:

5310

project: string, Project ID for this request. (required)

5311

zone: string, The name of the zone for this request. (required)

5312

instance: string, Name of the instance resource to update. (required)

5313

body: object, The request body.

5314

The object takes the form of:

5315

5316

{ # Represents an Instance resource.

5317

#

5318

# 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]

5319

"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]

5320

"confidentialInstanceConfig": { # A set of Confidential Instance options.

5321

"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.

5322

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5323

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

5324

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

5325

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

5326

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

5327

"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]

5328

{ # An instance-attached disk resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5329

"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).

5330

"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.

5331

"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.

5332

#

5333

# 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]

5334

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5335

#

5336

# 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.

5337

#

5338

# 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.

5339

#

5340

# 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.

5341

#

5342

# 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]

5343

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

5344

"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.

5345

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

5346

"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]

5347

#

5348

# The key must meet the following requirements before you can provide it to Compute Engine:

5349

# - The key is wrapped using a RSA public key certificate provided by Google.

5350

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

5351

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5352

"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]

5353

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5354

"diskSizeGb": "A String", # The size of the disk in GB.

5355

"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.

5356

{ # Guest OS features.

5357

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

5358

},

5359

],

5360

"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.

5361

"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]

5362

#

5363

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

5364

#

5365

# 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]

5366

"description": "A String", # An optional description. Provide this property when creating the disk.

5367

"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.

5368

"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.

5369

"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]

5370

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

5371

#

5372

#

5373

# 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:

5374

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType

5375

# - projects/project/zones/zone/diskTypes/diskType

5376

# - 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]

5377

"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]

5378

#

5379

# Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

5380

{ # Guest OS features.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5381

"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]

5382

},

5383

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5384

"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.

5385

"a_key": "A String",

5386

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5387

"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]

5388

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

5389

"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.

5390

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5391

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5392

"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]

5393

#

5394

# 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:

5395

# projects/debian-cloud/global/images/family/debian-9

5396

#

5397

#

5398

# Alternatively, use a specific version of a public operating system image:

5399

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

5400

#

5401

#

5402

# To create a disk with a custom image that you created, specify the image name in the following format:

5403

# global/images/my-custom-image

5404

#

5405

#

5406

# 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:

5407

# global/images/family/my-image-family

5408

#

5409

#

5410

# If the source image is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5411

"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]

5412

#

5413

# 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.

5414

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

5415

"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.

5416

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

5417

"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]

5418

#

5419

# The key must meet the following requirements before you can provide it to Compute Engine:

5420

# - The key is wrapped using a RSA public key certificate provided by Google.

5421

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

5422

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5423

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

5424

},

5425

"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.

5426

#

5427

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

5428

# global/snapshots/my-backup

5429

#

5430

#

5431

# If the source snapshot is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5432

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5433

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

5434

"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.

5435

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

5436

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

5437

#

5438

# The key must meet the following requirements before you can provide it to Compute Engine:

5439

# - The key is wrapped using a RSA public key certificate provided by Google.

5440

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

5441

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

5442

"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]

5443

},

5444

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5445

"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.

5446

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

5447

"licenses": [ # [Output Only] Any valid publicly visible licenses.

5448

"A String",

5449

],

5450

"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.

5451

"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

5452

"dbs": [ # The Key Database (db).

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

"content": "A String", # The raw content in the secure keys file.

5455

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5456

},

5457

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5458

"dbxs": [ # The forbidden key database (dbx).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5459

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5460

"content": "A String", # The raw content in the secure keys file.

5461

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5462

},

5463

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5464

"keks": [ # The Key Exchange Key (KEK).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5465

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5466

"content": "A String", # The raw content in the secure keys file.

5467

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5468

},

5469

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5470

"pk": { # The Platform Key (PK).

5471

"content": "A String", # The raw content in the secure keys file.

5472

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5473

},

5474

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5475

"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]

5476

#

5477

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

5478

#

5479

# 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]

5480

"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]

5481

},

5482

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5483

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

5484

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

5485

},

5486

"eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.

5487

"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.

5488

#

5489

# To see the latest fingerprint, make get() request to the instance.

5490

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

5491

{ # A specification of the type and number of accelerator cards attached to the instance.

5492

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

5493

"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.

5494

},

5495

],

5496

"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.

5497

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

5498

"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.

5499

"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.

5500

#

5501

# To see the latest fingerprint, make get() request to the instance.

5502

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

5503

"a_key": "A String",

5504

},

5505

"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:

5506

# zones/us-central1-f/machineTypes/n1-standard-1

5507

#

5508

#

5509

# 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):

5510

# zones/zone/machineTypes/custom-CPUS-MEMORY

5511

#

5512

#

5513

# For example: zones/us-central1-f/machineTypes/custom-4-5120

5514

#

5515

# For a full list of restrictions, read the Specifications for custom machine types.

5516

"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

5517

"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.

5518

#

5519

# To see the latest fingerprint, make a get() request to retrieve the resource.

5520

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

5521

{

5522

"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.

5523

"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).

5524

},

5525

],

5526

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

5527

},

5528

"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".

5529

"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.

5530

"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.

5531

{ # A network interface resource attached to an instance.

5532

"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.

5533

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

5534

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

5535

"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.

5536

"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.

5537

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

5538

#

5539

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

5540

#

5541

# 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.

5542

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

5543

"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.

5544

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

5545

},

5546

],

5547

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

5548

{ # An alias IP range attached to an instance's network interface.

5549

"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).

5550

"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.

5551

},

5552

],

5553

"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.

5554

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

5555

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

5556

"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.

5557

"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.

5558

#

5559

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

5560

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

5561

# - projects/project/global/networks/network

5562

# - global/networks/default

5563

"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.

5564

"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:

5565

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

5566

# - regions/region/subnetworks/subnetwork

5567

},

5568

],

5569

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.

5570

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.

5571

"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.

5572

"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.

5573

"values": [ # Corresponds to the label values of a reservation resource.

"A String",

],

},

"resourcePolicies": [ # Resource policies applied to this instance.

5578

"A String",

5579

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5580

"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]

5581

"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.

5582

#

5583

# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

5584

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

5585

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

5586

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

5587

"key": "A String", # Corresponds to the label key of Node resource.

5588

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

5589

"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]

5595

"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]

5596

},

5597

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

5598

"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

5599

#

5600

# 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.

5601

{ # A service account.

5602

"email": "A String", # Email address of the service account.

5603

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

5609

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

5610

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

5611

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

5612

},

5613

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

5614

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

5615

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5616

"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]

5617

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

5618

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

5619

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

5620

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5621

"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]

5622

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

5623

},

5624

"sourceMachineImage": "A String", # Source machine image

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5625

"sourceMachineImageEncryptionKey": { # Source GMI encryption key when creating an instance from GMI.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5626

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

5627

"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.

5628

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

5629

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

5630

#

5631

# The key must meet the following requirements before you can provide it to Compute Engine:

5632

# - The key is wrapped using a RSA public key certificate provided by Google.

5633

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

5634

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

5635

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

5636

},

5637

"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-07-22 17:02:09 -0700

[diff] [blame]

5638

"status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5639

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

5640

"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.

5641

"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.

5642

#

5643

# To see the latest fingerprint, make get() request to the instance.

5644

"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]

5649

}

5650

5651

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]

5657

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]

5663

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.

5664

5665

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.

5666

5667

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]

5668

5669

Returns:

5670

An object of the form:

5671

5672

{ # Represents an Operation resource.

5673

#

5674

# Google Compute Engine has three Operation resources:

5675

#

5676

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5677

#

5678

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5679

#

5680

# Operations can be global, regional or zonal.

5681

# - For global operations, use the `globalOperations` resource.

5682

# - For regional operations, use the `regionOperations` resource.

5683

# - For zonal operations, use the `zonalOperations` resource.

5684

#

5685

# 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]

5686

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5687

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5688

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5689

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5690

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5691

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5692

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5693

"code": "A String", # [Output Only] The error type identifier for this error.

5694

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5695

"message": "A String", # [Output Only] An optional, human-readable error message.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5696

},

5697

],

5698

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5699

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5700

"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.

5701

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5702

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5703

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5704

"name": "A String", # [Output Only] Name of the operation.

5705

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5706

"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.

5707

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5708

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5709

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5710

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5711

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5712

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5713

"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.

5714

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5715

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5716

{

5717

"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.

5718

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5719

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5720

{

5721

"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).

5722

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5723

},

5724

],

5725

"message": "A String", # [Output Only] A human-readable description of the warning code.

5726

},

5727

],

5728

"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]

5734

<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]

5735

5736

Args:

5737

project: string, Project ID for this request. (required)

5738

zone: string, The name of the zone for this request. (required)

5739

instance: string, The instance name for this request. (required)

5740

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]

5741

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5742

The object takes the form of:

5743

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5744

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

5745

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

5746

"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.

5747

"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.

5748

"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]

5749

#

5750

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

5751

#

5752

# 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]

5753

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

5754

"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.

5755

"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]

5756

}

5757

5758

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.

5759

5760

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.

5761

5762

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

5763

5764

Returns:

5765

An object of the form:

5766

5767

{ # Represents an Operation resource.

5768

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5769

# Google Compute Engine has three Operation resources:

5770

#

5771

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5772

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5773

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5774

#

5775

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5776

# - For global operations, use the `globalOperations` resource.

5777

# - For regional operations, use the `regionOperations` resource.

5778

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5779

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5780

# 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]

5781

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5782

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5783

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5784

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5785

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5786

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5787

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5788

"code": "A String", # [Output Only] The error type identifier for this error.

5789

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5790

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5791

},

5792

],

5793

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5794

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5795

"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.

5796

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5797

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5798

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5799

"name": "A String", # [Output Only] Name of the operation.

5800

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5801

"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.

5802

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5803

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5804

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5805

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5806

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5807

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5808

"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.

5809

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5810

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5811

{

5812

"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.

5813

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5814

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5815

{

5816

"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).

5817

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5818

},

5819

],

5820

"message": "A String", # [Output Only] A human-readable description of the warning code.

5821

},

5822

],

5823

"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]

5828

<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]

5829

<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.

5830

5831

Args:

5832

project: string, Project ID for this request. (required)

5833

zone: string, The name of the zone for this request. (required)

5834

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5835

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5836

The object takes the form of:

5837

5838

{ # A set of Display Device options

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5839

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5840

}

5841

5842

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.

5843

5844

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.

5845

5846

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

5847

5848

Returns:

5849

An object of the form:

5850

5851

{ # Represents an Operation resource.

5852

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5853

# Google Compute Engine has three Operation resources:

5854

#

5855

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5856

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5857

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5858

#

5859

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5860

# - For global operations, use the `globalOperations` resource.

5861

# - For regional operations, use the `regionOperations` resource.

5862

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5863

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5864

# 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]

5865

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5866

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5867

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5868

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5869

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5870

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5871

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5872

"code": "A String", # [Output Only] The error type identifier for this error.

5873

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5874

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5875

},

5876

],

5877

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5878

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5879

"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.

5880

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5881

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5882

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5883

"name": "A String", # [Output Only] Name of the operation.

5884

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5885

"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.

5886

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5887

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5888

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5889

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5890

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5891

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5892

"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.

5893

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5894

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5895

{

5896

"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.

5897

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5898

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5899

{

5900

"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).

5901

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5902

},

5903

],

5904

"message": "A String", # [Output Only] A human-readable description of the warning code.

5905

},

5906

],

5907

"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]

5912

<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]

5913

<pre>Updates an instance's network interface. This method follows PATCH semantics.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5914

5915

Args:

5916

project: string, Project ID for this request. (required)

5917

zone: string, The name of the zone for this request. (required)

5918

instance: string, The instance name for this request. (required)

5919

networkInterface: string, The name of the network interface to update. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5920

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5921

The object takes the form of:

5922

5923

{ # A network interface resource attached to an instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5924

"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.

5925

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

5926

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

5927

"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.

5928

"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.

5929

"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]

5930

#

5931

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

5932

#

5933

# 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]

5934

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

5935

"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.

5936

"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]

5937

},

5938

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5939

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

5940

{ # An alias IP range attached to an instance's network interface.

5941

"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).

5942

"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.

5943

},

5944

],

5945

"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.

5946

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

5947

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

5948

"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.

5949

"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]

5950

#

5951

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

5952

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

5953

# - projects/project/global/networks/network

5954

# - global/networks/default

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5955

"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.

5956

"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:

5957

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

5958

# - regions/region/subnetworks/subnetwork

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5959

}

5960

5961

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.

5962

5963

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.

5964

5965

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

5966

5967

Returns:

5968

An object of the form:

5969

5970

{ # Represents an Operation resource.

5971

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5972

# Google Compute Engine has three Operation resources:

5973

#

5974

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5975

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5976

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5977

#

5978

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5979

# - For global operations, use the `globalOperations` resource.

5980

# - For regional operations, use the `regionOperations` resource.

5981

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5982

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5983

# 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]

5984

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5985

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5986

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5987

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5988

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5989

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5990

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5991

"code": "A String", # [Output Only] The error type identifier for this error.

5992

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5993

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5994

},

5995

],

5996

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5997

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5998

"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.

5999

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6000

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6001

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6002

"name": "A String", # [Output Only] Name of the operation.

6003

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6004

"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.

6005

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6006

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6007

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6008

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6009

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6010

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6011

"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.

6012

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6013

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6014

{

6015

"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.

6016

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6017

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6018

{

6019

"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).

6020

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6021

},

6022

],

6023

"message": "A String", # [Output Only] A human-readable description of the warning code.

6024

},

6025

],

6026

"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]

6031

<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]

6032

<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.

6033

6034

Args:

6035

project: string, Project ID for this request. (required)

6036

zone: string, The name of the zone for this request. (required)

6037

instance: string, Name or id of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6038

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6039

The object takes the form of:

6040

6041

{ # A set of Shielded Instance options.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6042

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

6043

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

6044

"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]

6045

}

6046

6047

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.

6048

6049

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.

6050

6051

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

6052

6053

Returns:

6054

An object of the form:

6055

6056

{ # Represents an Operation resource.

6057

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6058

# Google Compute Engine has three Operation resources:

6059

#

6060

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6061

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6062

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6063

#

6064

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6065

# - For global operations, use the `globalOperations` resource.

6066

# - For regional operations, use the `regionOperations` resource.

6067

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6068

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6069

# 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]

6070

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6071

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6072

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6073

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6074

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6075

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6076

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6077

"code": "A String", # [Output Only] The error type identifier for this error.

6078

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6079

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6080

},

6081

],

6082

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6083

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6084

"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.

6085

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6086

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6087

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6088

"name": "A String", # [Output Only] Name of the operation.

6089

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6090

"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.

6091

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6092

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6093

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6094

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6095

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6096

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6097

"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.

6098

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6099

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6100

{

6101

"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.

6102

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6103

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6104

{

6105

"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).

6106

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6107

},

6108

],

6109

"message": "A String", # [Output Only] A human-readable description of the warning code.

6110

},

6111

],

6112

"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]

6117

<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]

6118

<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.

6119

6120

Args:

6121

project: string, Project ID for this request. (required)

6122

zone: string, The name of the zone for this request. (required)

6123

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6124

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6125

The object takes the form of:

6126

6127

{ # A set of Shielded VM options.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6128

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

6129

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

6130

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6131

}

6132

6133

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.

6134

6135

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.

6136

6137

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

6138

6139

Returns:

6140

An object of the form:

6141

6142

{ # Represents an Operation resource.

6143

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6144

# Google Compute Engine has three Operation resources:

6145

#

6146

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6147

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6148

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6149

#

6150

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6151

# - For global operations, use the `globalOperations` resource.

6152

# - For regional operations, use the `regionOperations` resource.

6153

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6154

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6155

# 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]

6156

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6157

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6158

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6159

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6160

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6161

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6162

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6163

"code": "A String", # [Output Only] The error type identifier for this error.

6164

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6165

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6166

},

6167

],

6168

},

Bu Sun Kim