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

2020-05-20 12:08:20 -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

Dan O'Meara

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

[diff] [blame]

93

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

94

<p class="firstline">Creates multiple instances. Count specifies the number of instances to create.</p>

95

Sai Cheemalapati

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

[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

Sai Cheemalapati

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

[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

Sai Cheemalapati

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

[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

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>

Sai Cheemalapati

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

[diff] [blame]

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>

Sai Cheemalapati

2016-10-21 13:59:49 -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>

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

Bu Sun Kim

2020-05-20 12:08:20 -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

Bu Sun Kim

2020-05-20 12:08:20 -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

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

[diff] [blame]

136

<p class="firstline">Retrieves the list of referrers to instances contained within the specified zone. 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>

Bu Sun Kim

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

[diff] [blame]

145

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

146

Sai Cheemalapati

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

[diff] [blame]

147

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

Bu Sun Kim

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

[diff] [blame]

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>

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>

Sai Cheemalapati

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

[diff] [blame]

155

Sai Cheemalapati

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

[diff] [blame]

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>

Sai Cheemalapati

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

[diff] [blame]

160

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

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>

Sai Cheemalapati

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

[diff] [blame]

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>

176

Dan O'Meara

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

[diff] [blame]

177

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

Bu Sun Kim

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

[diff] [blame]

178

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

Sai Cheemalapati

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

[diff] [blame]

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>

Sai Cheemalapati

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

[diff] [blame]

181

<p class="firstline">Sets an instance's scheduling options.</p>

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>

Sai Cheemalapati

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

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

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>

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

Sai Cheemalapati

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

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

Bu Sun Kim

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

[diff] [blame]

199

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

Sai Cheemalapati

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

[diff] [blame]

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>

Sai Cheemalapati

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

[diff] [blame]

203

Sai Cheemalapati

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

[diff] [blame]

204

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

Bu Sun Kim

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

[diff] [blame]

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>

Sai Cheemalapati

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

[diff] [blame]

206

Sai Cheemalapati

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

[diff] [blame]

207

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

Sai Cheemalapati

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

[diff] [blame]

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>

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>

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>

Sai Cheemalapati

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

[diff] [blame]

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>

Sai Cheemalapati

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

[diff] [blame]

223

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

Bu Sun Kim

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

[diff] [blame]

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

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

253

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

254

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

255

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

256

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

257

}

258

Bu Sun Kim

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

[diff] [blame]

259

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.

260

261

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.

262

263

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]

264

265

Returns:

266

An object of the form:

267

Bu Sun Kim

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

[diff] [blame]

268

{ # Represents an Operation resource.

269

#

Dan O'Meara

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

[diff] [blame]

270

# Google Compute Engine has three Operation resources:

271

#

272

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

273

#

Bu Sun Kim

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

[diff] [blame]

274

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

275

#

276

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

277

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

278

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

279

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

Bu Sun Kim

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

[diff] [blame]

280

#

Dan O'Meara

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

[diff] [blame]

281

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

282

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

283

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

284

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

285

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

286

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

287

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

Bu Sun Kim

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

[diff] [blame]

288

{

Bu Sun Kim

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

[diff] [blame]

289

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

290

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

291

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

Bu Sun Kim

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

[diff] [blame]

292

},

293

],

294

},

Bu Sun Kim

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

[diff] [blame]

295

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

296

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

297

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

298

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

299

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

300

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

301

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

302

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

303

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

304

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

305

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

306

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

307

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

308

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

309

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

310

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

311

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

312

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

313

{

314

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

315

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

316

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

317

{

318

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

319

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

320

},

321

],

322

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

323

},

324

],

325

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

330

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

Bu Sun Kim

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

[diff] [blame]

331

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

332

333

Args:

334

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

335

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

336

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

Dan O'Meara

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

[diff] [blame]

337

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

338

The object takes the form of:

339

340

{

Bu Sun Kim

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

[diff] [blame]

341

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

342

"A String",

Bu Sun Kim

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

[diff] [blame]

],

}

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

347

348

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.

349

350

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

351

352

Returns:

353

An object of the form:

354

355

{ # Represents an Operation resource.

356

#

Dan O'Meara

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

[diff] [blame]

357

# Google Compute Engine has three Operation resources:

358

#

359

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

360

#

Bu Sun Kim

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

[diff] [blame]

361

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

362

#

363

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

364

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

365

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

366

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

Bu Sun Kim

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

[diff] [blame]

367

#

Dan O'Meara

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

[diff] [blame]

368

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

369

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

370

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

371

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

372

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

373

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

374

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

Sai Cheemalapati

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

[diff] [blame]

375

{

Bu Sun Kim

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

[diff] [blame]

376

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

377

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

378

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

Sai Cheemalapati

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

[diff] [blame]

379

},

380

],

381

},

Bu Sun Kim

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

[diff] [blame]

382

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

383

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

384

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

385

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

386

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

387

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

388

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

389

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

390

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

391

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

392

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

393

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

394

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

395

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

396

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

397

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

398

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

399

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

400

{

401

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

402

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

403

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

404

{

405

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

406

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

407

},

408

],

409

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

410

},

411

],

412

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

417

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

418

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

419

420

Args:

421

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

Dan O'Meara

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

[diff] [blame]

422

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]

423

Dan O'Meara

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

[diff] [blame]

424

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]

425

Dan O'Meara

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

[diff] [blame]

426

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]

427

Bu Sun Kim

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

[diff] [blame]

428

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]

429

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]

430

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

431

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

432

433

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.

434

435

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

436

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.

437

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]

438

439

Returns:

440

An object of the form:

441

442

{

Bu Sun Kim

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

[diff] [blame]

443

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

444

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

445

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

446

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

Bu Sun Kim

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

[diff] [blame]

447

{ # Represents an Instance resource.

448

#

Dan O'Meara

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

[diff] [blame]

449

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

450

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

451

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

452

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

Bu Sun Kim

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

[diff] [blame]

453

},

Bu Sun Kim

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

[diff] [blame]

454

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

455

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

456

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

457

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

458

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

459

{ # An instance-attached disk resource.

Bu Sun Kim

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

[diff] [blame]

460

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

461

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

462

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

463

#

464

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

465

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

Sai Cheemalapati

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

[diff] [blame]

466

#

467

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

468

#

469

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

470

#

471

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

472

#

473

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

474

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

475

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

476

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

477

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

478

#

479

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

480

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

481

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

482

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

Bu Sun Kim

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

[diff] [blame]

483

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

484

},

Bu Sun Kim

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

[diff] [blame]

485

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

486

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

487

{ # Guest OS features.

488

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

489

},

490

],

491

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

492

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

493

#

494

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

495

#

496

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

497

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

498

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

499

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

500

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

501

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

502

#

Bu Sun Kim

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

[diff] [blame]

503

#

Sai Cheemalapati

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

[diff] [blame]

504

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

505

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

506

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

507

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

508

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

509

#

510

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

511

{ # Guest OS features.

Bu Sun Kim

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

[diff] [blame]

512

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

513

},

514

],

Bu Sun Kim

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

[diff] [blame]

515

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

516

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

517

},

Bu Sun Kim

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

[diff] [blame]

518

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

519

"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

520

"A String",

521

],

522

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

523

"A String",

524

],

525

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

526

#

Bu Sun Kim

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

[diff] [blame]

527

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

528

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

Sai Cheemalapati

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

[diff] [blame]

529

#

Sai Cheemalapati

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

[diff] [blame]

530

#

531

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

Bu Sun Kim

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

[diff] [blame]

532

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

Sai Cheemalapati

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

[diff] [blame]

533

#

Sai Cheemalapati

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

[diff] [blame]

534

#

Bu Sun Kim

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

[diff] [blame]

535

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

536

# global/images/my-custom-image

Sai Cheemalapati

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

[diff] [blame]

537

#

Sai Cheemalapati

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

[diff] [blame]

538

#

Bu Sun Kim

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

[diff] [blame]

539

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

540

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

Sai Cheemalapati

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

[diff] [blame]

541

#

Jon Wayne Parrott

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

[diff] [blame]

542

#

543

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

Bu Sun Kim

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

[diff] [blame]

544

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

545

#

546

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

547

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

548

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

549

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

550

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

551

#

552

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

553

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

554

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

555

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

556

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

557

},

558

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

559

#

560

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

561

# global/snapshots/my-backup

562

#

563

#

564

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

565

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

566

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

567

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

568

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

569

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

570

#

571

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

572

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

573

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

574

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

575

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

576

},

577

},

Bu Sun Kim

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

[diff] [blame]

578

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

579

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

580

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

581

"A String",

582

],

583

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

584

"savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to PRESERVED if the LocalSSD data has been saved to a persistent location by customer request. (see the discard_local_ssd option on Stop/Suspend). Read-only in the api.

585

"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

586

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

587

{

588

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

589

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

590

},

591

],

592

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

593

{

594

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

595

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

596

},

597

],

598

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

599

{

600

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

601

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

602

},

603

],

604

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

605

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

606

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

Bu Sun Kim

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

[diff] [blame]

607

},

Bu Sun Kim

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

[diff] [blame]

608

},

609

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

610

#

611

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

612

#

613

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

614

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

615

},

616

],

Bu Sun Kim

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

[diff] [blame]

617

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

618

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

Dan O'Meara

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

[diff] [blame]

619

},

Bu Sun Kim

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

[diff] [blame]

620

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

621

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

622

#

623

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

624

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

625

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

626

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

627

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

628

},

629

],

630

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

631

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

632

"instanceEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts data for an instance with a customer-supplied encryption key.

633

#

634

# If you are creating a new instance, this field encrypts the local SSD and in-memory contents of the instance using a key that you provide.

635

#

636

# If you are restarting an instance protected with a customer-supplied encryption key, you must provide the correct key in order to successfully restart the instance.

637

#

638

# If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key and you do not need to provide a key to start the instance later.

639

#

640

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

641

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

642

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

643

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

644

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

645

#

646

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

647

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

648

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

649

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

650

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

651

},

652

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

653

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

654

#

655

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

656

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

657

"a_key": "A String",

658

},

659

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

660

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

661

#

662

#

663

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

664

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

665

#

666

#

667

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

668

#

669

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

670

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

671

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

672

#

673

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

674

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

675

{

676

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

677

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

678

},

679

],

680

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

681

},

682

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

683

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

684

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

685

{ # A network interface resource attached to an instance.

686

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

687

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

688

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

689

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

690

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

691

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

692

#

693

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

694

#

695

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

696

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

697

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

698

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

699

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

700

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

701

},

702

],

703

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

704

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

705

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

706

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

707

},

708

],

709

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

710

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

711

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

712

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

713

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

714

#

715

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

716

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

717

# - projects/project/global/networks/network

718

# - global/networks/default

719

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

720

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

721

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

722

# - regions/region/subnetworks/subnetwork

723

},

724

],

725

"postKeyRevocationActionType": "A String", # Specifies whether this instance will be shut down on key revocation.

726

"preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api.

727

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

728

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

729

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

730

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

731

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

"A String",

],

},

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

736

"A String",

737

],

738

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

739

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

740

#

741

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

742

"latencyTolerant": True or False, # Defines whether the instance is tolerant of higher cpu latency. This can only be set during instance creation, or when the instance is not currently running. It must not be set if the preemptible option is also set.

743

"locationHint": "A String", # An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.

744

"longTermRelease": True or False, # DEPRECATED, please use maintenance_freeze_duration_hours. TODO(b/154158138): Remove this field. Compute Engine Long Term Release. When specified, VMs that have this policy become long term release (internal: stable fleet) VMs.

745

#

746

# For all VM shapes, this should result in fewer disruptions due to software updates and greater predictability via 1 week extended notifications.

747

#

748

# For GPU VMs, this should also result in an 2 week uptime guarantee. See go/stable-fleet-gpus-design for more details.

749

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

750

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

751

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

752

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

753

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

754

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

760

"preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation, it cannot be set or changed after the instance has been created.

761

},

762

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

763

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

764

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

765

#

766

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

767

{ # A service account.

768

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

769

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

"A String",

],

},

],

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

775

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

776

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

777

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

778

},

779

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

780

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

781

},

782

"shieldedVmConfig": { # A set of Shielded VM options.

783

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

784

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

785

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

786

},

787

"shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured.

788

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

789

},

790

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

791

"sourceMachineImageEncryptionKey": { # Represents a customer-supplied encryption key # Source GMI encryption key when creating an instance from GMI.

792

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

793

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

794

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

795

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

796

#

797

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

798

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

799

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

800

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

801

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

802

},

803

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

804

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

805

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

806

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

807

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

808

#

809

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

810

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

"A String",

],

},

"upcomingMaintenance": { # Upcoming Maintenance notification information. # [Output Only] Specifies upcoming maintenance for the instance.

815

"date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format.

816

"time": "A String", # [Output Only] The time when the maintenance will take place. This value is in RFC3339 text format.

817

"type": "A String", # Defines the type of maintenance.

818

},

819

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

820

},

821

],

Bu Sun Kim

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

[diff] [blame]

822

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

823

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

824

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

825

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

Sai Cheemalapati

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

[diff] [blame]

826

{

Bu Sun Kim

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

[diff] [blame]

827

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

828

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

Sai Cheemalapati

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

[diff] [blame]

829

},

830

],

Bu Sun Kim

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

[diff] [blame]

831

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

Sai Cheemalapati

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

[diff] [blame]

832

},

833

},

834

},

Bu Sun Kim

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

[diff] [blame]

835

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

836

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

837

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

838

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

839

"A String",

840

],

841

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

842

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

843

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

844

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

Bu Sun Kim

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

[diff] [blame]

845

{

Bu Sun Kim

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

[diff] [blame]

846

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

847

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

848

},

849

],

Bu Sun Kim

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

[diff] [blame]

850

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

851

},

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>

857

<pre>Retrieves the next page of results.

858

859

Args:

860

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

861

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

862

863

Returns:

Bu Sun Kim

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

[diff] [blame]

864

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

Sai Cheemalapati

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

[diff] [blame]

865

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]

870

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

871

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

872

873

Args:

874

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

875

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

876

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

Dan O'Meara

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

[diff] [blame]

877

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

878

The object takes the form of:

879

880

{ # An instance-attached disk resource.

Bu Sun Kim

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

[diff] [blame]

881

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

882

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

883

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

884

#

885

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

886

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

Sai Cheemalapati

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

[diff] [blame]

887

#

888

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

889

#

890

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

891

#

892

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

893

#

894

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

895

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

896

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

897

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

898

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

899

#

900

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

901

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

902

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

903

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

Bu Sun Kim

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

[diff] [blame]

904

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

905

},

Bu Sun Kim

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

[diff] [blame]

906

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

907

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

908

{ # Guest OS features.

909

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

910

},

911

],

912

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

913

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

914

#

915

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

916

#

917

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

918

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

919

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

920

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

921

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

922

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

923

#

Bu Sun Kim

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

[diff] [blame]

924

#

Sai Cheemalapati

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

[diff] [blame]

925

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

926

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

927

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

928

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

929

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

930

#

931

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

932

{ # Guest OS features.

Bu Sun Kim

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

[diff] [blame]

933

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

934

},

935

],

Bu Sun Kim

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

[diff] [blame]

936

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

937

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

938

},

Bu Sun Kim

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

[diff] [blame]

939

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

940

"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

941

"A String",

942

],

943

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

944

"A String",

945

],

946

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

947

#

Bu Sun Kim

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

[diff] [blame]

948

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

949

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

Sai Cheemalapati

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

[diff] [blame]

950

#

Sai Cheemalapati

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

[diff] [blame]

951

#

952

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

Bu Sun Kim

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

[diff] [blame]

953

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

Sai Cheemalapati

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

[diff] [blame]

954

#

Sai Cheemalapati

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

[diff] [blame]

955

#

Bu Sun Kim

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

[diff] [blame]

956

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

957

# global/images/my-custom-image

Sai Cheemalapati

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

[diff] [blame]

958

#

Sai Cheemalapati

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

[diff] [blame]

959

#

Bu Sun Kim

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

[diff] [blame]

960

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

961

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

Sai Cheemalapati

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

[diff] [blame]

962

#

Jon Wayne Parrott

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

[diff] [blame]

963

#

964

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

Bu Sun Kim

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

[diff] [blame]

965

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

966

#

967

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

968

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

969

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

970

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

971

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

972

#

973

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

974

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

975

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

976

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

977

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

978

},

979

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

980

#

981

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

982

# global/snapshots/my-backup

983

#

984

#

985

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

986

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

987

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

988

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

989

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

990

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

991

#

992

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

993

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

994

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

995

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

996

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

997

},

998

},

Bu Sun Kim

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

[diff] [blame]

999

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

1000

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

1001

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

1002

"A String",

1003

],

1004

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

1005

"savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to PRESERVED if the LocalSSD data has been saved to a persistent location by customer request. (see the discard_local_ssd option on Stop/Suspend). Read-only in the api.

1006

"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

1007

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

1008

{

1009

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

1010

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

1011

},

1012

],

1013

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

1014

{

1015

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

1016

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

1017

},

1018

],

1019

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

1020

{

1021

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

1022

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

1023

},

1024

],

1025

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

1026

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

1027

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

Bu Sun Kim

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

[diff] [blame]

1028

},

Bu Sun Kim

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

[diff] [blame]

1029

},

1030

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

1031

#

1032

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

1033

#

1034

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

1035

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

1036

}

1037

Bu Sun Kim

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

[diff] [blame]

1038

forceAttach: boolean, Whether to force attach the disk even if it's currently attached to another instance.

Bu Sun Kim

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

[diff] [blame]

1039

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.

1040

1041

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.

1042

1043

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]

1044

1045

Returns:

1046

An object of the form:

1047

Bu Sun Kim

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

[diff] [blame]

1048

{ # Represents an Operation resource.

1049

#

Dan O'Meara

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

[diff] [blame]

1050

# Google Compute Engine has three Operation resources:

1051

#

1052

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

1053

#

Bu Sun Kim

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

[diff] [blame]

1054

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

1055

#

1056

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

1057

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

1058

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

1059

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

Bu Sun Kim

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

[diff] [blame]

1060

#

Dan O'Meara

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

[diff] [blame]

1061

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

1062

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

1063

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

1064

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

1065

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

1066

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

1067

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

Dan O'Meara

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

[diff] [blame]

1068

{

Bu Sun Kim

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

[diff] [blame]

1069

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

1070

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

1071

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

Dan O'Meara

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

[diff] [blame]

1072

},

1073

],

1074

},

Bu Sun Kim

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

[diff] [blame]

1075

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

1076

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

1077

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

1078

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

1079

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

1080

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

1081

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

1082

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

1083

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

1084

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

1085

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

1086

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

1087

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

1088

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

1089

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

1090

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

1091

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

1092

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

1093

{

1094

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

1095

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

1096

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

1097

{

1098

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

1099

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

1100

},

1101

],

1102

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

1103

},

1104

],

1105

"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="bulkInsert">bulkInsert(project, zone, body=None, requestId=None)</code>

1111

<pre>Creates multiple instances. Count specifies the number of instances to create.

1112

1113

Args:

1114

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

1115

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

1116

body: object, The request body.

1117

The object takes the form of:

1118

1119

{

Bu Sun Kim

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

[diff] [blame]

1120

"count": "A String", # The maximum number of instances to create.

1121

"excludedZones": [ # List of zones to exclude for regional requests.

1122

"A String",

Dan O'Meara

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

[diff] [blame]

1123

],

Bu Sun Kim

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

[diff] [blame]

1124

"instance": { # Represents an Instance resource.

Dan O'Meara

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

[diff] [blame]

1125

#

1126

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

1127

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

1128

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

1129

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

Dan O'Meara

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

[diff] [blame]

1130

},

Bu Sun Kim

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

[diff] [blame]

1131

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

1132

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

1133

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

1134

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

1135

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

1136

{ # An instance-attached disk resource.

Bu Sun Kim

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

[diff] [blame]

1137

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

1138

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

1139

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

1140

#

1141

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

1142

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

Dan O'Meara

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

[diff] [blame]

1143

#

1144

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

1145

#

1146

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

1147

#

1148

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

1149

#

1150

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

1151

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

1152

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

1153

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

1154

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

1155

#

1156

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

1157

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

1158

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

1159

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

Bu Sun Kim

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

[diff] [blame]

1160

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

1161

},

Bu Sun Kim

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

[diff] [blame]

1162

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

1163

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

1164

{ # Guest OS features.

1165

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

1166

},

1167

],

1168

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

1169

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

1170

#

1171

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

1172

#

1173

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

1174

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

1175

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

1176

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

1177

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

1178

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

1179

#

1180

#

1181

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

1182

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

1183

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

1184

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

1185

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

1186

#

1187

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

1188

{ # Guest OS features.

Bu Sun Kim

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

[diff] [blame]

1189

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

1190

},

1191

],

Bu Sun Kim

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

[diff] [blame]

1192

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

1193

"a_key": "A String",

Dan O'Meara

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

[diff] [blame]

1194

},

Bu Sun Kim

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

[diff] [blame]

1195

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

1196

"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

1197

"A String",

1198

],

1199

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

1200

"A String",

1201

],

1202

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

1203

#

1204

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

1205

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

1206

#

1207

#

1208

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

1209

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

1210

#

1211

#

1212

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

1213

# global/images/my-custom-image

1214

#

1215

#

1216

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

1217

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

1218

#

1219

#

1220

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

Bu Sun Kim

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

[diff] [blame]

1221

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

1222

#

1223

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

1224

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

1225

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

1226

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

1227

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

1228

#

1229

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

1230

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

1231

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

1232

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

1233

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

1234

},

1235

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

1236

#

1237

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

1238

# global/snapshots/my-backup

1239

#

1240

#

1241

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

1242

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

1243

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

1244

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

1245

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

1246

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

1247

#

1248

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

1249

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

1250

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

1251

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

1252

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

1253

},

1254

},

Bu Sun Kim

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

[diff] [blame]

1255

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

1256

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

1257

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

1258

"A String",

1259

],

1260

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

1261

"savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to PRESERVED if the LocalSSD data has been saved to a persistent location by customer request. (see the discard_local_ssd option on Stop/Suspend). Read-only in the api.

1262

"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

1263

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

1264

{

1265

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

1266

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

1267

},

1268

],

1269

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

1270

{

1271

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

1272

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

1273

},

1274

],

1275

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

1276

{

1277

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

1278

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

1279

},

1280

],

1281

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

1282

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

1283

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

Dan O'Meara

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

[diff] [blame]

1284

},

Bu Sun Kim

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

[diff] [blame]

1285

},

1286

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

1287

#

1288

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

1289

#

1290

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

1291

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

1292

},

1293

],

Bu Sun Kim

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

[diff] [blame]

1294

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

1295

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

Dan O'Meara

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

[diff] [blame]

1296

},

Bu Sun Kim

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

[diff] [blame]

1297

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

1298

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

1299

#

1300

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

1301

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

1302

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

1303

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

1304

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

1305

},

1306

],

1307

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

1308

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

1309

"instanceEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts data for an instance with a customer-supplied encryption key.

1310

#

1311

# If you are creating a new instance, this field encrypts the local SSD and in-memory contents of the instance using a key that you provide.

1312

#

1313

# If you are restarting an instance protected with a customer-supplied encryption key, you must provide the correct key in order to successfully restart the instance.

1314

#

1315

# If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key and you do not need to provide a key to start the instance later.

1316

#

1317

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

1318

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

1319

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

1320

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

1321

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

1322

#

1323

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

1324

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

1325

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

1326

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

1327

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

1328

},

1329

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

1330

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

1331

#

1332

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

1333

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

1334

"a_key": "A String",

1335

},

1336

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

1337

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

1338

#

1339

#

1340

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

1341

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

1342

#

1343

#

1344

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

1345

#

1346

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

1347

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

1348

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

1349

#

1350

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

1351

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

1352

{

1353

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

1354

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

1355

},

1356

],

1357

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

1358

},

1359

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

1360

"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.

1361

"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.

1362

{ # A network interface resource attached to an instance.

1363

"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.

1364

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

1365

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

1366

"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.

1367

"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.

1368

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

1369

#

1370

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

1371

#

1372

# 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.

1373

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

1374

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

1375

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

1376

"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.

1377

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

1378

},

1379

],

1380

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

1381

{ # An alias IP range attached to an instance's network interface.

1382

"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).

1383

"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.

1384

},

1385

],

1386

"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.

1387

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

1388

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

1389

"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.

1390

"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.

1391

#

1392

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

1393

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

1394

# - projects/project/global/networks/network

1395

# - global/networks/default

1396

"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.

1397

"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:

1398

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

1399

# - regions/region/subnetworks/subnetwork

1400

},

1401

],

1402

"postKeyRevocationActionType": "A String", # Specifies whether this instance will be shut down on key revocation.

1403

"preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api.

1404

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.

1405

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.

1406

"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.

1407

"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.

1408

"values": [ # Corresponds to the label values of a reservation resource.

"A String",

],

},

"resourcePolicies": [ # Resource policies applied to this instance.

1413

"A String",

1414

],

1415

"scheduling": { # Sets the scheduling options for an Instance. NextID: 11 # Sets the scheduling options for this instance.

1416

"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.

1417

#

1418

# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

1419

"latencyTolerant": True or False, # Defines whether the instance is tolerant of higher cpu latency. This can only be set during instance creation, or when the instance is not currently running. It must not be set if the preemptible option is also set.

1420

"locationHint": "A String", # An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.

1421

"longTermRelease": True or False, # DEPRECATED, please use maintenance_freeze_duration_hours. TODO(b/154158138): Remove this field. Compute Engine Long Term Release. When specified, VMs that have this policy become long term release (internal: stable fleet) VMs.

1422

#

1423

# For all VM shapes, this should result in fewer disruptions due to software updates and greater predictability via 1 week extended notifications.

1424

#

1425

# For GPU VMs, this should also result in an 2 week uptime guarantee. See go/stable-fleet-gpus-design for more details.

1426

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

1427

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

1428

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

1429

"key": "A String", # Corresponds to the label key of Node resource.

1430

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

1431

"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.

1437

"preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation, it cannot be set or changed after the instance has been created.

1438

},

1439

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

1440

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1441

"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

1442

#

1443

# 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.

1444

{ # A service account.

1445

"email": "A String", # Email address of the service account.

1446

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

1452

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

1453

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

1454

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

1455

},

1456

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

1457

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

1458

},

1459

"shieldedVmConfig": { # A set of Shielded VM options.

1460

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

1461

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

1462

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

1463

},

1464

"shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured.

1465

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

1466

},

1467

"sourceMachineImage": "A String", # Source machine image

1468

"sourceMachineImageEncryptionKey": { # Represents a customer-supplied encryption key # Source GMI encryption key when creating an instance from GMI.

1469

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1470

"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.

1471

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1472

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

1473

#

1474

# The key must meet the following requirements before you can provide it to Compute Engine:

1475

# - The key is wrapped using a RSA public key certificate provided by Google.

1476

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1477

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1478

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

1479

},

1480

"startRestricted": True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.

1481

"status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, STOPPED, SUSPENDING, SUSPENDED, and TERMINATED.

1482

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

1483

"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.

1484

"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.

1485

#

1486

# To see the latest fingerprint, make get() request to the instance.

1487

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

"A String",

],

},

"upcomingMaintenance": { # Upcoming Maintenance notification information. # [Output Only] Specifies upcoming maintenance for the instance.

1492

"date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format.

1493

"time": "A String", # [Output Only] The time when the maintenance will take place. This value is in RFC3339 text format.

1494

"type": "A String", # Defines the type of maintenance.

1495

},

1496

"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]

1497

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1498

"minCount": "A String", # The minimum number of instances to create. If no min_count is specified then count is used as the default value. If min_count instances cannot be created, then no instances will be created.

1499

"predefinedNames": [ # List of predefined names. The number of names provided must be equal to count.

1500

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1501

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1502

"sourceInstanceTemplate": "A String", # Specifies the instance template from which to create the instance. This field is optional. This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to an instance template:

1503

# - https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate

1504

# - projects/project/global/instanceTemplates/instanceTemplate

1505

# - global/instanceTemplates/instanceTemplate

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1506

}

1507

1508

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.

1509

1510

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.

1511

1512

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

1513

1514

Returns:

1515

An object of the form:

1516

1517

{ # Represents an Operation resource.

1518

#

1519

# Google Compute Engine has three Operation resources:

1520

#

1521

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

1522

#

1523

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

1524

#

1525

# Operations can be global, regional or zonal.

1526

# - For global operations, use the `globalOperations` resource.

1527

# - For regional operations, use the `regionOperations` resource.

1528

# - For zonal operations, use the `zonalOperations` resource.

1529

#

1530

# 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]

1531

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1532

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1533

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1534

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1535

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1536

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1537

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1538

"code": "A String", # [Output Only] The error type identifier for this error.

1539

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1540

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1541

},

1542

],

1543

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1544

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1545

"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.

1546

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

1547

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1548

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1549

"name": "A String", # [Output Only] Name of the operation.

1550

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1551

"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.

1552

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

1553

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1554

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1555

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1556

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

1557

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1558

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1559

"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.

1560

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1561

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1562

{

1563

"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.

1564

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1565

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

1566

{

1567

"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).

1568

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1569

},

1570

],

1571

"message": "A String", # [Output Only] A human-readable description of the warning code.

1572

},

1573

],

1574

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1579

<code class="details" id="delete">delete(project, zone, instance, requestId=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1580

<pre>Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance.

1581

1582

Args:

1583

project: string, Project ID for this request. (required)

1584

zone: string, The name of the zone for this request. (required)

1585

instance: string, Name of the instance resource to delete. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1586

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.

1587

1588

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.

1589

1590

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]

1591

1592

Returns:

1593

An object of the form:

1594

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1595

{ # Represents an Operation resource.

1596

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1597

# Google Compute Engine has three Operation resources:

1598

#

1599

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

1600

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1601

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

1602

#

1603

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1604

# - For global operations, use the `globalOperations` resource.

1605

# - For regional operations, use the `regionOperations` resource.

1606

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1607

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1608

# 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]

1609

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1610

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1611

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1612

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1613

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1614

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1615

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1616

"code": "A String", # [Output Only] The error type identifier for this error.

1617

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1618

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1619

},

1620

],

1621

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1622

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1623

"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.

1624

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

1625

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1626

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1627

"name": "A String", # [Output Only] Name of the operation.

1628

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1629

"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.

1630

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

1631

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1632

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1633

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1634

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

1635

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1636

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1637

"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.

1638

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1639

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1640

{

1641

"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.

1642

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1643

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

1644

{

1645

"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).

1646

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1647

},

1648

],

1649

"message": "A String", # [Output Only] A human-readable description of the warning code.

1650

},

1651

],

1652

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1657

<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]

1658

<pre>Deletes an access config from an instance's network interface.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1659

1660

Args:

1661

project: string, Project ID for this request. (required)

1662

zone: string, The name of the zone for this request. (required)

1663

instance: string, The instance name for this request. (required)

1664

accessConfig: string, The name of the access config to delete. (required)

1665

networkInterface: string, The name of the network interface. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1666

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.

1667

1668

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.

1669

1670

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]

1671

1672

Returns:

1673

An object of the form:

1674

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1675

{ # Represents an Operation resource.

1676

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1677

# Google Compute Engine has three Operation resources:

1678

#

1679

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

1680

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1681

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

1682

#

1683

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1684

# - For global operations, use the `globalOperations` resource.

1685

# - For regional operations, use the `regionOperations` resource.

1686

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1687

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1688

# 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]

1689

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1690

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1691

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1692

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1693

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1694

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1695

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1696

"code": "A String", # [Output Only] The error type identifier for this error.

1697

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1698

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1699

},

1700

],

1701

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1702

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1703

"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.

1704

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

1705

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1706

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1707

"name": "A String", # [Output Only] Name of the operation.

1708

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1709

"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.

1710

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

1711

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1712

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1713

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1714

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

1715

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1716

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1717

"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.

1718

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1719

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1720

{

1721

"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.

1722

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1723

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

1724

{

1725

"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).

1726

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1727

},

1728

],

1729

"message": "A String", # [Output Only] A human-readable description of the warning code.

1730

},

1731

],

1732

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1737

<code class="details" id="detachDisk">detachDisk(project, zone, instance, deviceName, requestId=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1738

<pre>Detaches a disk from an instance.

1739

1740

Args:

1741

project: string, Project ID for this request. (required)

1742

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1743

instance: string, Instance name for this request. (required)

1744

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)

1745

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.

1746

1747

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.

1748

1749

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]

1750

1751

Returns:

1752

An object of the form:

1753

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1754

{ # Represents an Operation resource.

1755

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1756

# Google Compute Engine has three Operation resources:

1757

#

1758

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

1759

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1760

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

1761

#

1762

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1763

# - For global operations, use the `globalOperations` resource.

1764

# - For regional operations, use the `regionOperations` resource.

1765

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1766

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1767

# 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]

1768

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1769

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1770

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1771

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1772

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1773

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1774

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1775

"code": "A String", # [Output Only] The error type identifier for this error.

1776

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1777

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1778

},

1779

],

1780

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1781

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1782

"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.

1783

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

1784

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1785

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1786

"name": "A String", # [Output Only] Name of the operation.

1787

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1788

"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.

1789

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

1790

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1791

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1792

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1793

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

1794

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1795

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1796

"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.

1797

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1798

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1799

{

1800

"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.

1801

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1802

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

1803

{

1804

"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).

1805

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1806

},

1807

],

1808

"message": "A String", # [Output Only] A human-readable description of the warning code.

1809

},

1810

],

1811

"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]

1817

<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]

1818

1819

Args:

1820

project: string, Project ID for this request. (required)

1821

zone: string, The name of the zone for this request. (required)

1822

instance: string, Name of the instance resource to return. (required)

1823

1824

Returns:

1825

An object of the form:

1826

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1827

{ # Represents an Instance resource.

1828

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1829

# 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]

1830

"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.

1831

"confidentialInstanceConfig": { # A set of Confidential Instance options.

1832

"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1833

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1834

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

1835

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

1836

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

1837

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

1838

"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]

1839

{ # An instance-attached disk resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1840

"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).

1841

"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.

1842

"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.

1843

#

1844

# 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.

1845

"diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1846

#

1847

# 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.

1848

#

1849

# 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.

1850

#

1851

# 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.

1852

#

1853

# 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]

1854

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1855

"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.

1856

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1857

"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]

1858

#

1859

# The key must meet the following requirements before you can provide it to Compute Engine:

1860

# - 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]

1861

# - 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]

1862

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1863

"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]

1864

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1865

"diskSizeGb": "A String", # The size of the disk in GB.

1866

"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.

1867

{ # Guest OS features.

1868

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

1869

},

1870

],

1871

"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.

1872

"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]

1873

#

1874

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

1875

#

1876

# 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]

1877

"description": "A String", # An optional description. Provide this property when creating the disk.

1878

"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.

1879

"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.

1880

"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]

1881

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

1882

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1883

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1884

# 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:

1885

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType

1886

# - projects/project/zones/zone/diskTypes/diskType

1887

# - 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]

1888

"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]

1889

#

1890

# Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

1891

{ # Guest OS features.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1892

"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]

1893

},

1894

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1895

"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.

1896

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1897

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1898

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

1899

"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

1900

"A String",

1901

],

1902

"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.

1903

"A String",

1904

],

1905

"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]

1906

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1907

# 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:

1908

# projects/debian-cloud/global/images/family/debian-9

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1909

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1910

#

1911

# Alternatively, use a specific version of a public operating system image:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1912

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1913

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1914

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1915

# To create a disk with a custom image that you created, specify the image name in the following format:

1916

# global/images/my-custom-image

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1917

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1918

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1919

# 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:

1920

# global/images/family/my-image-family

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1921

#

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1922

#

1923

# If the source image is deleted later, this field will not be set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1924

"sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

1925

#

1926

# 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.

1927

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1928

"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.

1929

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1930

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

1931

#

1932

# The key must meet the following requirements before you can provide it to Compute Engine:

1933

# - The key is wrapped using a RSA public key certificate provided by Google.

1934

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1935

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1936

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

1937

},

1938

"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.

1939

#

1940

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

1941

# global/snapshots/my-backup

1942

#

1943

#

1944

# If the source snapshot is deleted later, this field will not be set.

1945

"sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot.

1946

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1947

"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.

1948

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1949

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

1950

#

1951

# The key must meet the following requirements before you can provide it to Compute Engine:

1952

# - The key is wrapped using a RSA public key certificate provided by Google.

1953

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1954

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1955

"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]

1956

},

1957

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1958

"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.

1959

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

1960

"licenses": [ # [Output Only] Any valid publicly visible licenses.

1961

"A String",

1962

],

1963

"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.

1964

"savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to PRESERVED if the LocalSSD data has been saved to a persistent location by customer request. (see the discard_local_ssd option on Stop/Suspend). Read-only in the api.

1965

"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

1966

"dbs": [ # The Key Database (db).

1967

{

1968

"content": "A String", # The raw content in the secure keys file.

1969

"fileType": "A String", # The file type of source file.

1970

},

1971

],

1972

"dbxs": [ # The forbidden key database (dbx).

1973

{

1974

"content": "A String", # The raw content in the secure keys file.

1975

"fileType": "A String", # The file type of source file.

1976

},

1977

],

1978

"keks": [ # The Key Exchange Key (KEK).

1979

{

1980

"content": "A String", # The raw content in the secure keys file.

1981

"fileType": "A String", # The file type of source file.

1982

},

1983

],

1984

"pk": { # The Platform Key (PK).

1985

"content": "A String", # The raw content in the secure keys file.

1986

"fileType": "A String", # The file type of source file.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1987

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1988

},

1989

"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]

1990

#

1991

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

1992

#

1993

# 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]

1994

"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]

1995

},

1996

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1997

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

1998

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1999

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2000

"eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.

2001

"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.

2002

#

2003

# To see the latest fingerprint, make get() request to the instance.

2004

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

2005

{ # A specification of the type and number of accelerator cards attached to the instance.

2006

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

2007

"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.

2008

},

2009

],

2010

"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.

2011

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

2012

"instanceEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts data for an instance with a customer-supplied encryption key.

2013

#

2014

# If you are creating a new instance, this field encrypts the local SSD and in-memory contents of the instance using a key that you provide.

2015

#

2016

# If you are restarting an instance protected with a customer-supplied encryption key, you must provide the correct key in order to successfully restart the instance.

2017

#

2018

# If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key and you do not need to provide a key to start the instance later.

2019

#

2020

# Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt local SSDs and in-memory content in a managed instance group.

2021

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2022

"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.

2023

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2024

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

2025

#

2026

# The key must meet the following requirements before you can provide it to Compute Engine:

2027

# - The key is wrapped using a RSA public key certificate provided by Google.

2028

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

2029

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

2030

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

2031

},

2032

"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.

2033

"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.

2034

#

2035

# To see the latest fingerprint, make get() request to the instance.

2036

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

2037

"a_key": "A String",

2038

},

2039

"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:

2040

# zones/us-central1-f/machineTypes/n1-standard-1

2041

#

2042

#

2043

# 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):

2044

# zones/zone/machineTypes/custom-CPUS-MEMORY

2045

#

2046

#

2047

# For example: zones/us-central1-f/machineTypes/custom-4-5120

2048

#

2049

# For a full list of restrictions, read the Specifications for custom machine types.

2050

"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

2051

"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.

2052

#

2053

# To see the latest fingerprint, make a get() request to retrieve the resource.

2054

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

2055

{

2056

"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.

2057

"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).

2058

},

2059

],

2060

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

2061

},

2062

"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".

2063

"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.

2064

"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.

2065

{ # A network interface resource attached to an instance.

2066

"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.

2067

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

2068

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

2069

"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.

2070

"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.

2071

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

2072

#

2073

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

2074

#

2075

# 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.

2076

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

2077

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

2078

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

2079

"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.

2080

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

2081

},

2082

],

2083

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

2084

{ # An alias IP range attached to an instance's network interface.

2085

"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).

2086

"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.

2087

},

2088

],

2089

"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.

2090

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

2091

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

2092

"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.

2093

"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.

2094

#

2095

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

2096

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

2097

# - projects/project/global/networks/network

2098

# - global/networks/default

2099

"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.

2100

"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:

2101

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

2102

# - regions/region/subnetworks/subnetwork

2103

},

2104

],

2105

"postKeyRevocationActionType": "A String", # Specifies whether this instance will be shut down on key revocation.

2106

"preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api.

2107

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.

2108

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.

2109

"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.

2110

"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.

2111

"values": [ # Corresponds to the label values of a reservation resource.

"A String",

],

},

"resourcePolicies": [ # Resource policies applied to this instance.

2116

"A String",

2117

],

2118

"scheduling": { # Sets the scheduling options for an Instance. NextID: 11 # Sets the scheduling options for this instance.

2119

"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.

2120

#

2121

# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

2122

"latencyTolerant": True or False, # Defines whether the instance is tolerant of higher cpu latency. This can only be set during instance creation, or when the instance is not currently running. It must not be set if the preemptible option is also set.

2123

"locationHint": "A String", # An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.

2124

"longTermRelease": True or False, # DEPRECATED, please use maintenance_freeze_duration_hours. TODO(b/154158138): Remove this field. Compute Engine Long Term Release. When specified, VMs that have this policy become long term release (internal: stable fleet) VMs.

2125

#

2126

# For all VM shapes, this should result in fewer disruptions due to software updates and greater predictability via 1 week extended notifications.

2127

#

2128

# For GPU VMs, this should also result in an 2 week uptime guarantee. See go/stable-fleet-gpus-design for more details.

2129

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

2130

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

2131

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

2132

"key": "A String", # Corresponds to the label key of Node resource.

2133

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

2134

"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.

2140

"preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation, it cannot be set or changed after the instance has been created.

2141

},

2142

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

2143

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2144

"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

2145

#

2146

# 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.

2147

{ # A service account.

2148

"email": "A String", # Email address of the service account.

2149

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

2155

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

2156

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

2157

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

2158

},

2159

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

2160

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

2161

},

2162

"shieldedVmConfig": { # A set of Shielded VM options.

2163

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

2164

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

2165

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

2166

},

2167

"shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured.

2168

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

2169

},

2170

"sourceMachineImage": "A String", # Source machine image

2171

"sourceMachineImageEncryptionKey": { # Represents a customer-supplied encryption key # Source GMI encryption key when creating an instance from GMI.

2172

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2173

"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.

2174

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2175

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

2176

#

2177

# The key must meet the following requirements before you can provide it to Compute Engine:

2178

# - The key is wrapped using a RSA public key certificate provided by Google.

2179

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

2180

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

2181

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

2182

},

2183

"startRestricted": True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.

2184

"status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, STOPPED, SUSPENDING, SUSPENDED, and TERMINATED.

2185

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

2186

"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.

2187

"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.

2188

#

2189

# To see the latest fingerprint, make get() request to the instance.

2190

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

"A String",

],

},

"upcomingMaintenance": { # Upcoming Maintenance notification information. # [Output Only] Specifies upcoming maintenance for the instance.

2195

"date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format.

2196

"time": "A String", # [Output Only] The time when the maintenance will take place. This value is in RFC3339 text format.

2197

"type": "A String", # Defines the type of maintenance.

2198

},

2199

"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>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2204

<code class="details" id="getEffectiveFirewalls">getEffectiveFirewalls(project, zone, instance, networkInterface)</code>

2205

<pre>Returns effective firewalls applied to an interface of the instance.

2206

2207

Args:

2208

project: string, Project ID for this request. (required)

2209

zone: string, The name of the zone for this request. (required)

2210

instance: string, Name of the instance scoping this request. (required)

2211

networkInterface: string, The name of the network interface to get the effective firewalls. (required)

2212

2213

Returns:

2214

An object of the form:

2215

2216

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2217

"firewalls": [ # Effective firewalls on the instance.

2218

{ # Represents a Firewall Rule resource.

2219

#

2220

# Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules.

2221

"allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

2222

{

2223

"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.

2224

"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.

2225

#

2226

# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

"A String",

],

},

],

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

2232

"denied": [ # The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.

2233

{

2234

"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.

2235

"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.

2236

#

2237

# 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.

2243

"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.

2244

"A String",

2245

],

2246

"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.

2247

"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.

2248

"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 to Stackdriver.

2249

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

2250

"kind": "compute#firewall", # [Output Only] Type of the resource. Always compute#firewall for firewall rules.

2251

"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 Stackdriver.

2252

"enable": True or False, # This field denotes whether to enable logging for a particular firewall rule.

2253

"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.

2254

},

2255

"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.

2256

"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:

2257

# global/networks/default

2258

# 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:

2259

# - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network

2260

# - projects/myproject/global/networks/my-network

2261

# - global/networks/default

2262

"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`.

2263

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2264

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2265

"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.

2266

"A String",

2267

],

2268

"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.

2269

"A String",

2270

],

2271

"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.

2272

"A String",

2273

],

2274

"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.

2275

"A String",

2276

],

2277

"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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2283

{ # A pruned SecurityPolicy containing ID and any applicable firewall rules.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2284

"id": "A String", # The unique identifier for the security policy. This identifier is defined by the server.

2285

"rules": [ # The rules that apply to the network.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2286

{ # 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]

2287

"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.

2288

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2289

"direction": "A String", # The direction in which this rule applies. This field may only be specified when versioned_expr is set to FIREWALL.

2290

"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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2291

#

2292

# 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]

2293

"kind": "compute#securityPolicyRule", # [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules

2294

"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.

2295

"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.

2296

"destIpRanges": [ # CIDR IP address range.

2297

#

2298

# This field may only be specified when versioned_expr is set to FIREWALL.

2299

"A String",

2300

],

2301

"destPorts": [ # Pairs of IP protocols and ports that the rule should match.

2302

#

2303

# This field may only be specified when versioned_expr is set to FIREWALL.

2304

{

2305

"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.

2306

"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.

2307

#

2308

# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

2309

#

2310

# This field may only be specified when versioned_expr is set to FIREWALL.

"A String",

],

},

],

"layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.

2316

#

2317

# This field may only be specified when versioned_expr is set to FIREWALL.

2318

{

2319

"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.

2320

"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.

2321

#

2322

# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

2323

#

2324

# This field may only be specified when versioned_expr is set to FIREWALL.

"A String",

],

},

],

"srcIpRanges": [ # CIDR IP address range.

"A String",

],

},

"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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2334

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2335

# Example (Comparison):

2336

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2337

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2338

#

2339

# Example (Equality):

2340

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2341

# title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email"

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2342

#

2343

# Example (Logic):

2344

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2345

# title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'"

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2346

#

2347

# Example (Data Manipulation):

2348

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2349

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2350

#

2351

# 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2352

"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.

2353

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

2354

"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.

2355

"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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2356

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2357

"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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2358

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2359

"preview": True or False, # If set to true, the specified action is not enforced.

2360

"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.

2361

"rateLimitOptions": { # Must be specified if the action is "rate_based_blacklist" or "throttle". Cannot be specified for any other actions.

2362

"blockDuration": 42, # Can only be specifed if the action for the rule is "rate_based_blacklist" If specified, determines the time (in seconds) the traffic will continue to be blocked by the rate limit after the rate falls below the threshold. The default value is 0 seconds.

2363

"conformAction": "A String", # Action to take when requests are under the given threshold. When requests are throttled, this is also the action for all requests which are not dropped. Valid options are "allow", "fairshare", and "drop_overload".

2364

"enforceOnKey": "A String", # Determines the key to enforce the threshold_rps limit on. If key is "IP", each IP has this limit enforced separately, whereas "ALL_IPs" means a single limit is applied to all requests matching this rule.

2365

"exceedAction": "A String", # When a request is denied, returns the HTTP response code specified. Valid options are "deny()" where valid values for status are 403, 404, 429, and 502.

2366

"thresholdRps": 42, # Rate in requests per second at which to begin ratelimiting.

2367

},

2368

"ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall security policy rule.

2369

"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.

2370

#

2371

# This field may only be specified when versioned_expr is set to FIREWALL.

2372

"A String",

2373

],

2374

"targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.

2375

"A String",

2376

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2377

},

2378

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2379

},

2380

],

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]

2385

<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]

2386

<pre>Returns the specified guest attributes entry.

2387

2388

Args:

2389

project: string, Project ID for this request. (required)

2390

zone: string, The name of the zone for this request. (required)

2391

instance: string, Name of the instance scoping this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2392

queryPath: string, Specifies the guest attributes path to be queried.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2393

variableKey: string, Specifies the key for the guest attributes entry.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2394

2395

Returns:

2396

An object of the form:

2397

2398

{ # A guest attributes entry.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2399

"kind": "compute#guestAttributes", # [Output Only] Type of the resource. Always compute#guestAttributes for guest attributes entry.

2400

"queryPath": "A String", # The path to be queried. This can be the default namespace ('/') or a nested namespace ('/\/') or a specified key ('/\/\')

2401

"queryValue": { # Array of guest attribute namespace/key/value tuples. # [Output Only] The value of the requested queried path.

2402

"items": [

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2403

{ # A guest attributes namespace/key/value entry.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2404

"key": "A String", # Key for the guest attribute entry.

2405

"namespace": "A String", # Namespace for the guest attribute entry.

2406

"value": "A String", # Value for the guest attribute entry.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2407

},

2408

],

2409

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2410

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

2411

"variableKey": "A String", # The key to search for.

2412

"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]

2417

<code class="details" id="getIamPolicy">getIamPolicy(project, zone, resource, optionsRequestedPolicyVersion=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2418

<pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists.

2419

2420

Args:

2421

project: string, Project ID for this request. (required)

2422

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2423

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2424

optionsRequestedPolicyVersion: integer, Requested IAM Policy version.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2425

2426

Returns:

2427

An object of the form:

2428

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2429

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2430

#

2431

#

2432

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2433

# 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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2434

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2435

# 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).

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2436

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2437

# **JSON example:**

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2438

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2439

# { "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]

2440

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2441

# **YAML example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2442

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2443

# 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]

2444

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2445

# 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]

2446

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2447

{ # 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.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

2448

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2449

# 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.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2450

#

2451

# Example Policy with multiple AuditConfigs:

2452

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2453

# { "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" ] } ] } ] }

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2454

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2455

# 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]

2456

"auditLogConfigs": [ # The configuration for logging of each type of permission.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

2457

{ # Provides the configuration for logging a type of permissions. Example:

2458

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2459

# { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] }

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

2460

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2461

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

2462

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

2463

"A String",

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2464

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2465

"ignoreChildExemptions": True or False,

2466

"logType": "A String", # The log type that this config enables.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2467

},

2468

],

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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2473

},

2474

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2475

"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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2476

{ # Associates `members` with a `role`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2477

"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.

2478

#

2479

# If the condition evaluates to `true`, then this binding applies to the current request.

2480

#

2481

# 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.

2482

#

2483

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

2484

#

2485

# Example (Comparison):

2486

#

2487

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

2488

#

2489

# Example (Equality):

2490

#

2491

# 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'"

2496

#

2497

# Example (Data Manipulation):

2498

#

2499

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

2500

#

2501

# 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.

2502

"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.

2503

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

2504

"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.

2505

"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.

2506

},

2507

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2508

#

2509

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

2510

#

2511

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

2512

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2513

# * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2514

#

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2515

#

2516

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2517

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

2518

#

2519

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

2520

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2521

# * `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.

2522

#

2523

# * `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.

2524

#

2525

# * `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.

2526

#

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2527

#

2528

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2529

# * `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]

2530

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2531

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2532

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2533

},

2534

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2535

"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.

2536

#

2537

# **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.

2538

"iamOwned": True or False,

2539

"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.

2540

{ # A rule to be applied in a Policy.

2541

"action": "A String", # Required

2542

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

2543

{ # A condition to be met.

2544

"iam": "A String", # Trusted attributes supplied by the IAM system.

2545

"op": "A String", # An operator to apply the subject with.

2546

"svc": "A String", # Trusted attributes discharged by the service.

2547

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

2548

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

2554

"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.

2555

"A String",

2556

],

2557

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

2558

{ # Specifies what kind of log the caller must write

2559

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

2560

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

2561

"permissionType": "A String", # The type of the permission that was checked.

2562

},

2563

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

2564

},

2565

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

2566

#

2567

# 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.

2568

#

2569

# Field names correspond to IAM request parameters and field values are their respective values.

2570

#

2571

# 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.

2572

#

2573

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

2574

"customFields": [ # Custom fields.

2575

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

2576

"name": "A String", # Name is the field name.

2577

"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.

2578

},

2579

],

2580

"field": "A String", # The field value to attribute.

2581

"metric": "A String", # The metric to update.

2582

},

2583

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

2584

"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.

2589

"A String",

2590

],

2591

"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.

2597

#

2598

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

2599

#

2600

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

2601

#

2602

# * 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

2603

#

2604

# **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.

2605

#

2606

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

2607

#

2608

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

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]

2613

<code class="details" id="getScreenshot">getScreenshot(project, zone, instance)</code>

2614

<pre>Returns the screenshot from the specified instance.

2615

2616

Args:

2617

project: string, Project ID for this request. (required)

2618

zone: string, The name of the zone for this request. (required)

2619

instance: string, Name of the instance scoping this request. (required)

2620

2621

Returns:

2622

An object of the form:

2623

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2624

{ # An instance's screenshot.

2625

"contents": "A String", # [Output Only] The Base64-encoded screenshot data.

2626

"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]

2631

<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]

2632

<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]

2633

2634

Args:

2635

project: string, Project ID for this request. (required)

2636

zone: string, The name of the zone for this request. (required)

2637

instance: string, Name of the instance scoping this request. (required)

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2638

port: integer, Specifies which COM or serial port to retrieve data from.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2639

start: string, Returns output starting from a specific byte position. Use this to page through output when the output is too large to return in a single request. For the initial request, leave this field unspecified. For subsequent calls, this field should be set to the next value returned in the previous call.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2640

2641

Returns:

2642

An object of the form:

2643

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2644

{ # An instance's serial console output.

2645

"contents": "A String", # [Output Only] The contents of the console output.

2646

"kind": "compute#serialPortOutput", # [Output Only] Type of the resource. Always compute#serialPortOutput for serial port output.

2647

"next": "A String", # [Output Only] The position of the next byte of content from the serial console output. Use this value in the next request as the start parameter.

2648

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

2649

"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, older output will be overwritten by newer content and the start values will be mismatched.

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]

2654

<code class="details" id="getShieldedInstanceIdentity">getShieldedInstanceIdentity(project, zone, instance)</code>

2655

<pre>Returns the Shielded Instance Identity of an instance

2656

2657

Args:

2658

project: string, Project ID for this request. (required)

2659

zone: string, The name of the zone for this request. (required)

2660

instance: string, Name or id of the instance scoping this request. (required)

2661

2662

Returns:

2663

An object of the form:

2664

2665

{ # A shielded Instance identity entry.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2666

"encryptionKey": { # A Shielded Instance Identity Entry. # An Endorsement Key (EK) made by the RSA 2048 algorithm issued to the Shielded Instance's vTPM.

2667

"ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.

2668

"ekPub": "A String", # A PEM-encoded public key.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2669

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2670

"kind": "compute#shieldedInstanceIdentity", # [Output Only] Type of the resource. Always compute#shieldedInstanceIdentity for shielded Instance identity entry.

2671

"signingKey": { # A Shielded Instance Identity Entry. # An Attestation Key (AK) made by the RSA 2048 algorithm issued to the Shielded Instance's vTPM.

2672

"ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.

2673

"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>

2680

<pre>Returns the Shielded VM Identity of an instance

2681

2682

Args:

2683

project: string, Project ID for this request. (required)

2684

zone: string, The name of the zone for this request. (required)

2685

instance: string, Name of the instance scoping this request. (required)

2686

2687

Returns:

2688

An object of the form:

2689

2690

{ # A shielded VM identity entry.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2691

"encryptionKey": { # A Shielded Instance Identity Entry. # An Endorsement Key (EK) issued to the Shielded VM's vTPM.

2692

"ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.

2693

"ekPub": "A String", # A PEM-encoded public key.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2694

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2695

"kind": "compute#shieldedVmIdentity", # [Output Only] Type of the resource. Always compute#shieldedVmIdentity for shielded VM identity entry.

2696

"signingKey": { # A Shielded Instance Identity Entry. # An Attestation Key (AK) issued to the Shielded VM's vTPM.

2697

"ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.

2698

"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]

2704

<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]

2705

<pre>Creates an instance resource in the specified project using the data included in the request.

2706

2707

Args:

2708

project: string, Project ID for this request. (required)

2709

zone: string, The name of the zone for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2710

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2711

The object takes the form of:

2712

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2713

{ # Represents an Instance resource.

2714

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2715

# 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]

2716

"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.

2717

"confidentialInstanceConfig": { # A set of Confidential Instance options.

2718

"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2719

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2720

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

2721

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

2722

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

2723

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2724

"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]

2725

{ # An instance-attached disk resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2726

"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).

2727

"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.

2728

"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.

2729

#

2730

# 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.

2731

"diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2732

#

2733

# 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.

2734

#

2735

# 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.

2736

#

2737

# 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.

2738

#

2739

# 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]

2740

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2741

"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.

2742

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2743

"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]

2744

#

2745

# The key must meet the following requirements before you can provide it to Compute Engine:

2746

# - 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]

2747

# - 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]

2748

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2749

"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]

2750

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2751

"diskSizeGb": "A String", # The size of the disk in GB.

2752

"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.

2753

{ # Guest OS features.

2754

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

2755

},

2756

],

2757

"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.

2758

"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]

2759

#

2760

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

2761

#

2762

# 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]

2763

"description": "A String", # An optional description. Provide this property when creating the disk.

2764

"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.

2765

"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.

2766

"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]

2767

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

2768

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2769

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2770

# 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:

2771

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType

2772

# - projects/project/zones/zone/diskTypes/diskType

2773

# - 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]

2774

"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]

2775

#

2776

# Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

2777

{ # Guest OS features.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2778

"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]

2779

},

2780

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2781

"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.

2782

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2783

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2784

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

2785

"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

2786

"A String",

2787

],

2788

"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.

2789

"A String",

2790

],

2791

"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]

2792

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2793

# 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:

2794

# projects/debian-cloud/global/images/family/debian-9

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2795

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2796

#

2797

# Alternatively, use a specific version of a public operating system image:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2798

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2799

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2800

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2801

# To create a disk with a custom image that you created, specify the image name in the following format:

2802

# global/images/my-custom-image

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2803

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2804

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2805

# 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:

2806

# global/images/family/my-image-family

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2807

#

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2808

#

2809

# If the source image is deleted later, this field will not be set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2810

"sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

2811

#

2812

# 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.

2813

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2814

"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.

2815

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2816

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

2817

#

2818

# The key must meet the following requirements before you can provide it to Compute Engine:

2819

# - The key is wrapped using a RSA public key certificate provided by Google.

2820

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

2821

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

2822

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

2823

},

2824

"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.

2825

#

2826

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

2827

# global/snapshots/my-backup

2828

#

2829

#

2830

# If the source snapshot is deleted later, this field will not be set.

2831

"sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot.

2832

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2833

"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.

2834

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2835

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

2836

#

2837

# The key must meet the following requirements before you can provide it to Compute Engine:

2838

# - The key is wrapped using a RSA public key certificate provided by Google.

2839

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

2840

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

2841

"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]

2842

},

2843

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2844

"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.

2845

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

2846

"licenses": [ # [Output Only] Any valid publicly visible licenses.

2847

"A String",

2848

],

2849

"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.

2850

"savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to PRESERVED if the LocalSSD data has been saved to a persistent location by customer request. (see the discard_local_ssd option on Stop/Suspend). Read-only in the api.

2851

"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

2852

"dbs": [ # The Key Database (db).

2853

{

2854

"content": "A String", # The raw content in the secure keys file.

2855

"fileType": "A String", # The file type of source file.

2856

},

2857

],

2858

"dbxs": [ # The forbidden key database (dbx).

2859

{

2860

"content": "A String", # The raw content in the secure keys file.

2861

"fileType": "A String", # The file type of source file.

2862

},

2863

],

2864

"keks": [ # The Key Exchange Key (KEK).

2865

{

2866

"content": "A String", # The raw content in the secure keys file.

2867

"fileType": "A String", # The file type of source file.

2868

},

2869

],

2870

"pk": { # The Platform Key (PK).

2871

"content": "A String", # The raw content in the secure keys file.

2872

"fileType": "A String", # The file type of source file.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2873

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2874

},

2875

"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]

2876

#

2877

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

2878

#

2879

# 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]

2880

"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]

2881

},

2882

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2883

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

2884

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2885

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2886

"eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.

2887

"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.

2888

#

2889

# To see the latest fingerprint, make get() request to the instance.

2890

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

2891

{ # A specification of the type and number of accelerator cards attached to the instance.

2892

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

2893

"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.

2894

},

2895

],

2896

"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.

2897

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

2898

"instanceEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts data for an instance with a customer-supplied encryption key.

2899

#

2900

# If you are creating a new instance, this field encrypts the local SSD and in-memory contents of the instance using a key that you provide.

2901

#

2902

# If you are restarting an instance protected with a customer-supplied encryption key, you must provide the correct key in order to successfully restart the instance.

2903

#

2904

# If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key and you do not need to provide a key to start the instance later.

2905

#

2906

# Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt local SSDs and in-memory content in a managed instance group.

2907

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2908

"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.

2909

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2910

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

2911

#

2912

# The key must meet the following requirements before you can provide it to Compute Engine:

2913

# - The key is wrapped using a RSA public key certificate provided by Google.

2914

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

2915

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

2916

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

2917

},

2918

"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.

2919

"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.

2920

#

2921

# To see the latest fingerprint, make get() request to the instance.

2922

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

2923

"a_key": "A String",

2924

},

2925

"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:

2926

# zones/us-central1-f/machineTypes/n1-standard-1

2927

#

2928

#

2929

# 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):

2930

# zones/zone/machineTypes/custom-CPUS-MEMORY

2931

#

2932

#

2933

# For example: zones/us-central1-f/machineTypes/custom-4-5120

2934

#

2935

# For a full list of restrictions, read the Specifications for custom machine types.

2936

"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

2937

"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.

2938

#

2939

# To see the latest fingerprint, make a get() request to retrieve the resource.

2940

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

2941

{

2942

"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.

2943

"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).

2944

},

2945

],

2946

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

2947

},

2948

"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".

2949

"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.

2950

"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.

2951

{ # A network interface resource attached to an instance.

2952

"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.

2953

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

2954

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

2955

"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.

2956

"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.

2957

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

2958

#

2959

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

2960

#

2961

# 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.

2962

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

2963

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

2964

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

2965

"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.

2966

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

2967

},

2968

],

2969

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

2970

{ # An alias IP range attached to an instance's network interface.

2971

"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).

2972

"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.

2973

},

2974

],

2975

"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.

2976

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

2977

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

2978

"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.

2979

"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.

2980

#

2981

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

2982

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

2983

# - projects/project/global/networks/network

2984

# - global/networks/default

2985

"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.

2986

"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:

2987

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

2988

# - regions/region/subnetworks/subnetwork

2989

},

2990

],

2991

"postKeyRevocationActionType": "A String", # Specifies whether this instance will be shut down on key revocation.

2992

"preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api.

2993

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.

2994

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.

2995

"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.

2996

"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.

2997

"values": [ # Corresponds to the label values of a reservation resource.

"A String",

],

},

"resourcePolicies": [ # Resource policies applied to this instance.

3002

"A String",

3003

],

3004

"scheduling": { # Sets the scheduling options for an Instance. NextID: 11 # Sets the scheduling options for this instance.

3005

"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.

3006

#

3007

# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

3008

"latencyTolerant": True or False, # Defines whether the instance is tolerant of higher cpu latency. This can only be set during instance creation, or when the instance is not currently running. It must not be set if the preemptible option is also set.

3009

"locationHint": "A String", # An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.

3010

"longTermRelease": True or False, # DEPRECATED, please use maintenance_freeze_duration_hours. TODO(b/154158138): Remove this field. Compute Engine Long Term Release. When specified, VMs that have this policy become long term release (internal: stable fleet) VMs.

3011

#

3012

# For all VM shapes, this should result in fewer disruptions due to software updates and greater predictability via 1 week extended notifications.

3013

#

3014

# For GPU VMs, this should also result in an 2 week uptime guarantee. See go/stable-fleet-gpus-design for more details.

3015

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

3016

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

3017

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

3018

"key": "A String", # Corresponds to the label key of Node resource.

3019

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

3020

"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.

3026

"preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation, it cannot be set or changed after the instance has been created.

3027

},

3028

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

3029

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

3030

"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

3031

#

3032

# 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.

3033

{ # A service account.

3034

"email": "A String", # Email address of the service account.

3035

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

3041

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

3042

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

3043

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

3044

},

3045

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

3046

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

3047

},

3048

"shieldedVmConfig": { # A set of Shielded VM options.

3049

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

3050

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

3051

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

3052

},

3053

"shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured.

3054

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

3055

},

3056

"sourceMachineImage": "A String", # Source machine image

3057

"sourceMachineImageEncryptionKey": { # Represents a customer-supplied encryption key # Source GMI encryption key when creating an instance from GMI.

3058

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3059

"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.

3060

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3061

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

3062

#

3063

# The key must meet the following requirements before you can provide it to Compute Engine:

3064

# - The key is wrapped using a RSA public key certificate provided by Google.

3065

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

3066

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

3067

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

3068

},

3069

"startRestricted": True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.

3070

"status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, STOPPED, SUSPENDING, SUSPENDED, and TERMINATED.

3071

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

3072

"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.

3073

"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.

3074

#

3075

# To see the latest fingerprint, make get() request to the instance.

3076

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

"A String",

],

},

"upcomingMaintenance": { # Upcoming Maintenance notification information. # [Output Only] Specifies upcoming maintenance for the instance.

3081

"date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format.

3082

"time": "A String", # [Output Only] The time when the maintenance will take place. This value is in RFC3339 text format.

3083

"type": "A String", # Defines the type of maintenance.

3084

},

3085

"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]

3086

}

3087

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3088

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.

3089

3090

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.

3091

3092

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]

3093

sourceInstanceTemplate: string, Specifies instance template to create the instance.

3094

3095

This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to an instance template:

3096

- https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate

3097

- projects/project/global/instanceTemplates/instanceTemplate

3098

- global/instanceTemplates/instanceTemplate

3099

sourceMachineImage: string, Specifies instance machine to create the instance.

3100

3101

This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to an instance template:

3102

- https://www.googleapis.com/compute/v1/projects/project/global/global/machineImages/machineImage

3103

- projects/project/global/global/machineImages/machineImage

3104

- global/machineImages/machineImage

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3105

3106

Returns:

3107

An object of the form:

3108

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3109

{ # Represents an Operation resource.

3110

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3111

# Google Compute Engine has three Operation resources:

3112

#

3113

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

3114

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3115

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

3116

#

3117

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3118

# - For global operations, use the `globalOperations` resource.

3119

# - For regional operations, use the `regionOperations` resource.

3120

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3121

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3122

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3123

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3124

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3125

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3126

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3127

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3128

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3129

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3130

"code": "A String", # [Output Only] The error type identifier for this error.

3131

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3132

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3133

},

3134

],

3135

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3136

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3137

"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.

3138

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3139

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3140

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3141

"name": "A String", # [Output Only] Name of the operation.

3142

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3143

"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

3144

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3145

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3146

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

3147

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3148

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3149

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3150

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3151

"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.

3152

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3153

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3154

{

3155

"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.

3156

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

3157

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

3158

{

3159

"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).

3160

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3161

},

3162

],

3163

"message": "A String", # [Output Only] A human-readable description of the warning code.

3164

},

3165

],

3166

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3171

<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]

3172

<pre>Retrieves the list of instances contained within the specified zone.

3173

3174

Args:

3175

project: string, Project ID for this request. (required)

3176

zone: string, The name of the zone for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3177

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]

3178

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3179

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]

3180

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3181

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]

3182

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3183

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) ```

3184

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`)

3185

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

3186

3187

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.

3188

3189

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

3190

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.

3191

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]

3192

3193

Returns:

3194

An object of the form:

3195

3196

{ # Contains a list of instances.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3197

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

3198

"items": [ # A list of Instance resources.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3199

{ # Represents an Instance resource.

3200

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3201

# 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]

3202

"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.

3203

"confidentialInstanceConfig": { # A set of Confidential Instance options.

3204

"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3205

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3206

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

3207

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

3208

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

3209

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3210

"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]

3211

{ # An instance-attached disk resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3212

"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).

3213

"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.

3214

"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.

3215

#

3216

# 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.

3217

"diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3218

#

3219

# 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.

3220

#

3221

# 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.

3222

#

3223

# 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.

3224

#

3225

# 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]

3226

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3227

"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.

3228

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3229

"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]

3230

#

3231

# The key must meet the following requirements before you can provide it to Compute Engine:

3232

# - 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]

3233

# - 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]

3234

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3235

"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]

3236

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3237

"diskSizeGb": "A String", # The size of the disk in GB.

3238

"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.

3239

{ # Guest OS features.

3240

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

3241

},

3242

],

3243

"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.

3244

"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]

3245

#

3246

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

3247

#

3248

# 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]

3249

"description": "A String", # An optional description. Provide this property when creating the disk.

3250

"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.

3251

"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.

3252

"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]

3253

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

3254

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3255

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3256

# 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:

3257

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType

3258

# - projects/project/zones/zone/diskTypes/diskType

3259

# - 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]

3260

"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]

3261

#

3262

# Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

3263

{ # Guest OS features.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3264

"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]

3265

},

3266

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3267

"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.

3268

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3269

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3270

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

3271

"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

3272

"A String",

3273

],

3274

"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.

3275

"A String",

3276

],

3277

"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]

3278

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3279

# 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:

3280

# projects/debian-cloud/global/images/family/debian-9

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3281

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3282

#

3283

# Alternatively, use a specific version of a public operating system image:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3284

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3285

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3286

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3287

# To create a disk with a custom image that you created, specify the image name in the following format:

3288

# global/images/my-custom-image

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3289

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3290

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3291

# 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:

3292

# global/images/family/my-image-family

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3293

#

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

3294

#

3295

# If the source image is deleted later, this field will not be set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3296

"sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

3297

#

3298

# 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.

3299

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3300

"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.

3301

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3302

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

3303

#

3304

# The key must meet the following requirements before you can provide it to Compute Engine:

3305

# - The key is wrapped using a RSA public key certificate provided by Google.

3306

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

3307

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

3308

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

3309

},

3310

"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.

3311

#

3312

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

3313

# global/snapshots/my-backup

3314

#

3315

#

3316

# If the source snapshot is deleted later, this field will not be set.

3317

"sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot.

3318

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3319

"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.

3320

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3321

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

3322

#

3323

# The key must meet the following requirements before you can provide it to Compute Engine:

3324

# - The key is wrapped using a RSA public key certificate provided by Google.

3325

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

3326

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

3327

"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]

3328

},

3329

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3330

"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.

3331

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

3332

"licenses": [ # [Output Only] Any valid publicly visible licenses.

3333

"A String",

3334

],

3335

"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.

3336

"savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to PRESERVED if the LocalSSD data has been saved to a persistent location by customer request. (see the discard_local_ssd option on Stop/Suspend). Read-only in the api.

3337

"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

3338

"dbs": [ # The Key Database (db).

3339

{

3340

"content": "A String", # The raw content in the secure keys file.

3341

"fileType": "A String", # The file type of source file.

3342

},

3343

],

3344

"dbxs": [ # The forbidden key database (dbx).

3345

{

3346

"content": "A String", # The raw content in the secure keys file.

3347

"fileType": "A String", # The file type of source file.

3348

},

3349

],

3350

"keks": [ # The Key Exchange Key (KEK).

3351

{

3352

"content": "A String", # The raw content in the secure keys file.

3353

"fileType": "A String", # The file type of source file.

3354

},

3355

],

3356

"pk": { # The Platform Key (PK).

3357

"content": "A String", # The raw content in the secure keys file.

3358

"fileType": "A String", # The file type of source file.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3359

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3360

},

3361

"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]

3362

#

3363

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

3364

#

3365

# 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]

3366

"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]

3367

},

3368

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3369

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

3370

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3371

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3372

"eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.

3373

"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.

3374

#

3375

# To see the latest fingerprint, make get() request to the instance.

3376

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

3377

{ # A specification of the type and number of accelerator cards attached to the instance.

3378

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

3379

"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.

3380

},

3381

],

3382

"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.

3383

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

3384

"instanceEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts data for an instance with a customer-supplied encryption key.

3385

#

3386

# If you are creating a new instance, this field encrypts the local SSD and in-memory contents of the instance using a key that you provide.

3387

#

3388

# If you are restarting an instance protected with a customer-supplied encryption key, you must provide the correct key in order to successfully restart the instance.

3389

#

3390

# If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key and you do not need to provide a key to start the instance later.

3391

#

3392

# Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt local SSDs and in-memory content in a managed instance group.

3393

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3394

"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.

3395

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3396

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

3397

#

3398

# The key must meet the following requirements before you can provide it to Compute Engine:

3399

# - The key is wrapped using a RSA public key certificate provided by Google.

3400

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

3401

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

3402

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

3403

},

3404

"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.

3405

"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.

3406

#

3407

# To see the latest fingerprint, make get() request to the instance.

3408

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

3409

"a_key": "A String",

3410

},

3411

"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:

3412

# zones/us-central1-f/machineTypes/n1-standard-1

3413

#

3414

#

3415

# 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):

3416

# zones/zone/machineTypes/custom-CPUS-MEMORY

3417

#

3418

#

3419

# For example: zones/us-central1-f/machineTypes/custom-4-5120

3420

#

3421

# For a full list of restrictions, read the Specifications for custom machine types.

3422

"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

3423

"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.

3424

#

3425

# To see the latest fingerprint, make a get() request to retrieve the resource.

3426

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

3427

{

3428

"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.

3429

"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).

3430

},

3431

],

3432

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

3433

},

3434

"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".

3435

"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.

3436

"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.

3437

{ # A network interface resource attached to an instance.

3438

"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.

3439

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

3440

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

3441

"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.

3442

"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.

3443

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

3444

#

3445

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

3446

#

3447

# 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.

3448

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

3449

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

3450

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

3451

"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.

3452

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

3453

},

3454

],

3455

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

3456

{ # An alias IP range attached to an instance's network interface.

3457

"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).

3458

"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.

3459

},

3460

],

3461

"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.

3462

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

3463

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

3464

"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.

3465

"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.

3466

#

3467

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

3468

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

3469

# - projects/project/global/networks/network

3470

# - global/networks/default

3471

"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.

3472

"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:

3473

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

3474

# - regions/region/subnetworks/subnetwork

3475

},

3476

],

3477

"postKeyRevocationActionType": "A String", # Specifies whether this instance will be shut down on key revocation.

3478

"preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api.

3479

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.

3480

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.

3481

"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.

3482

"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.

3483

"values": [ # Corresponds to the label values of a reservation resource.

"A String",

],

},

"resourcePolicies": [ # Resource policies applied to this instance.

3488

"A String",

3489

],

3490

"scheduling": { # Sets the scheduling options for an Instance. NextID: 11 # Sets the scheduling options for this instance.

3491

"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.

3492

#

3493

# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

3494

"latencyTolerant": True or False, # Defines whether the instance is tolerant of higher cpu latency. This can only be set during instance creation, or when the instance is not currently running. It must not be set if the preemptible option is also set.

3495

"locationHint": "A String", # An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.

3496

"longTermRelease": True or False, # DEPRECATED, please use maintenance_freeze_duration_hours. TODO(b/154158138): Remove this field. Compute Engine Long Term Release. When specified, VMs that have this policy become long term release (internal: stable fleet) VMs.

3497

#

3498

# For all VM shapes, this should result in fewer disruptions due to software updates and greater predictability via 1 week extended notifications.

3499

#

3500

# For GPU VMs, this should also result in an 2 week uptime guarantee. See go/stable-fleet-gpus-design for more details.

3501

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

3502

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

3503

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

3504

"key": "A String", # Corresponds to the label key of Node resource.

3505

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

3506

"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.

3512

"preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation, it cannot be set or changed after the instance has been created.

3513

},

3514

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

3515

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

3516

"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

3517

#

3518

# 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.

3519

{ # A service account.

3520

"email": "A String", # Email address of the service account.

3521

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

3527

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

3528

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

3529

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

3530

},

3531

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

3532

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

3533

},

3534

"shieldedVmConfig": { # A set of Shielded VM options.

3535

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

3536

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

3537

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

3538

},

3539

"shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured.

3540

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

3541

},

3542

"sourceMachineImage": "A String", # Source machine image

3543

"sourceMachineImageEncryptionKey": { # Represents a customer-supplied encryption key # Source GMI encryption key when creating an instance from GMI.

3544

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3545

"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.

3546

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3547

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

3548

#

3549

# The key must meet the following requirements before you can provide it to Compute Engine:

3550

# - The key is wrapped using a RSA public key certificate provided by Google.

3551

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

3552

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

3553

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

3554

},

3555

"startRestricted": True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.

3556

"status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, STOPPED, SUSPENDING, SUSPENDED, and TERMINATED.

3557

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

3558

"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.

3559

"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.

3560

#

3561

# To see the latest fingerprint, make get() request to the instance.

3562

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

"A String",

],

},

"upcomingMaintenance": { # Upcoming Maintenance notification information. # [Output Only] Specifies upcoming maintenance for the instance.

3567

"date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format.

3568

"time": "A String", # [Output Only] The time when the maintenance will take place. This value is in RFC3339 text format.

3569

"type": "A String", # Defines the type of maintenance.

3570

},

3571

"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]

3572

},

3573

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3574

"kind": "compute#instanceList", # [Output Only] Type of resource. Always compute#instanceList for lists of Instance resources.

3575

"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.

3576

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

3577

"warning": { # [Output Only] Informational warning message.

3578

"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.

3579

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

3580

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3581

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3582

"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).

3583

"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]

3584

},

3585

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3586

"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]

3587

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3592

<code class="details" id="listReferrers">listReferrers(project, zone, instance, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3593

<pre>Retrieves the list of referrers to instances contained within the specified zone. For more information, read Viewing Referrers to VM Instances.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3594

3595

Args:

3596

project: string, Project ID for this request. (required)

3597

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3598

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]

3599

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]

3600

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3601

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]

3602

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3603

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]

3604

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3605

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]

3606

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]

3607

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

3608

3609

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.

3610

3611

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3612

pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3613

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]

3614

3615

Returns:

3616

An object of the form:

3617

3618

{ # Contains a list of instance referrers.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3619

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

3620

"items": [ # A list of Reference resources.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3621

{ # Represents a reference to a resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3622

"kind": "compute#reference", # [Output Only] Type of the resource. Always compute#reference for references.

3623

"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]

3624

# - MEMBER_OF

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3625

"referrer": "A String", # URL of the resource which refers to the target.

3626

"target": "A String", # URL of the resource to which this reference points.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3627

},

3628

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3629

"kind": "compute#instanceListReferrers", # [Output Only] Type of resource. Always compute#instanceListReferrers for lists of Instance referrers.

3630

"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.

3631

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

3632

"warning": { # [Output Only] Informational warning message.

3633

"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.

3634

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

3635

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

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

"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).

3638

"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]

3639

},

3640

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3641

"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]

3642

},

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>

3648

<pre>Retrieves the next page of results.

3649

3650

Args:

3651

previous_request: The request for the previous page. (required)

3652

previous_response: The response from the request for the previous page. (required)

3653

3654

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3655

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3656

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]

3661

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

3662

<pre>Retrieves the next page of results.

3663

3664

Args:

3665

previous_request: The request for the previous page. (required)

3666

previous_response: The response from the request for the previous page. (required)

3667

3668

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3669

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3670

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]

3675

<code class="details" id="removeResourcePolicies">removeResourcePolicies(project, zone, instance, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3676

<pre>Removes resource policies from an instance.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3677

3678

Args:

3679

project: string, Project ID for this request. (required)

3680

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3681

instance: string, The instance name for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3682

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3683

The object takes the form of:

3684

3685

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3686

"resourcePolicies": [ # Resource policies to be removed from this instance.

3687

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

],

}

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

3692

3693

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.

3694

3695

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]

3696

3697

Returns:

3698

An object of the form:

3699

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3700

{ # Represents an Operation resource.

3701

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3702

# Google Compute Engine has three Operation resources:

3703

#

3704

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

3705

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3706

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

3707

#

3708

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3709

# - For global operations, use the `globalOperations` resource.

3710

# - For regional operations, use the `regionOperations` resource.

3711

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3712

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3713

# 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]

3714

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3715

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3716

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3717

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3718

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3719

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3720

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3721

"code": "A String", # [Output Only] The error type identifier for this error.

3722

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3723

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3724

},

3725

],

3726

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3727

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3728

"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.

3729

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3730

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3731

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3732

"name": "A String", # [Output Only] Name of the operation.

3733

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3734

"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.

3735

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3736

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3737

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

3738

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3739

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3740

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3741

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3742

"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.

3743

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3744

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3745

{

3746

"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.

3747

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

3748

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

3749

{

3750

"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).

3751

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3752

},

3753

],

3754

"message": "A String", # [Output Only] A human-readable description of the warning code.

3755

},

3756

],

3757

"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="reset">reset(project, zone, instance, requestId=None)</code>

3763

<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.

3764

3765

Args:

3766

project: string, Project ID for this request. (required)

3767

zone: string, The name of the zone for this request. (required)

3768

instance: string, Name of the instance scoping this request. (required)

3769

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.

3770

3771

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.

3772

3773

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

3774

3775

Returns:

3776

An object of the form:

3777

3778

{ # Represents an Operation resource.

3779

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3780

# Google Compute Engine has three Operation resources:

3781

#

3782

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

3783

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3784

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

3785

#

3786

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3787

# - For global operations, use the `globalOperations` resource.

3788

# - For regional operations, use the `regionOperations` resource.

3789

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3790

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3791

# 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]

3792

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3793

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3794

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3795

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3796

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3797

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3798

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3799

"code": "A String", # [Output Only] The error type identifier for this error.

3800

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3801

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3802

},

3803

],

3804

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3805

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3806

"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.

3807

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3808

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3809

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3810

"name": "A String", # [Output Only] Name of the operation.

3811

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3812

"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.

3813

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3814

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3815

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

3816

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3817

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3818

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3819

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3820

"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.

3821

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3822

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3823

{

3824

"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.

3825

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

3826

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

3827

{

3828

"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).

3829

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3830

},

3831

],

3832

"message": "A String", # [Output Only] A human-readable description of the warning code.

3833

},

3834

],

3835

"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]

3840

<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]

3841

<pre>Resumes an instance that was suspended using the instances().suspend method.

3842

3843

Args:

3844

project: string, Project ID for this request. (required)

3845

zone: string, The name of the zone for this request. (required)

3846

instance: string, Name of the instance resource to resume. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3847

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3848

The object takes the form of:

3849

3850

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3851

"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]

3852

#

3853

# In order to resume the instance, the disk url and its corresponding key must be provided.

3854

#

3855

# If the disk is not protected with a customer-supplied encryption key it should not be specified.

3856

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3857

"diskEncryptionKey": { # Represents a customer-supplied encryption key # Decrypts data associated with the disk with a customer-supplied encryption key.

3858

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3859

"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.

3860

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3861

"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]

3862

#

3863

# The key must meet the following requirements before you can provide it to Compute Engine:

3864

# - The key is wrapped using a RSA public key certificate provided by Google.

3865

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

3866

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3867

"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]

3868

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3869

"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]

3870

},

3871

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3872

"instanceEncryptionKey": { # Represents a customer-supplied encryption key # Decrypts data associated with an instance that is protected with a customer-supplied encryption key.

3873

#

3874

# 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.

3875

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3876

"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.

3877

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3878

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

3879

#

3880

# The key must meet the following requirements before you can provide it to Compute Engine:

3881

# - The key is wrapped using a RSA public key certificate provided by Google.

3882

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

3883

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

3884

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

3885

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3886

}

3887

3888

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.

3889

3890

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.

3891

3892

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

3893

3894

Returns:

3895

An object of the form:

3896

3897

{ # Represents an Operation resource.

3898

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3899

# Google Compute Engine has three Operation resources:

3900

#

3901

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

3902

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3903

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

3904

#

3905

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3906

# - For global operations, use the `globalOperations` resource.

3907

# - For regional operations, use the `regionOperations` resource.

3908

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3909

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3910

# 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]

3911

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3912

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3913

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3914

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3915

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3916

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3917

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3918

"code": "A String", # [Output Only] The error type identifier for this error.

3919

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3920

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3921

},

3922

],

3923

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3924

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3925

"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.

3926

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3927

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3928

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3929

"name": "A String", # [Output Only] Name of the operation.

3930

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3931

"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.

3932

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3933

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3934

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

3935

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3936

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3937

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3938

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3939

"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.

3940

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3941

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3942

{

3943

"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.

3944

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

3945

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

3946

{

3947

"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).

3948

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3949

},

3950

],

3951

"message": "A String", # [Output Only] A human-readable description of the warning code.

3952

},

3953

],

3954

"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>

3960

<pre>Sets deletion protection on the instance.

3961

3962

Args:

3963

project: string, Project ID for this request. (required)

3964

zone: string, The name of the zone for this request. (required)

3965

resource: string, Name or id of the resource for this request. (required)

3966

deletionProtection: boolean, Whether the resource should be protected against deletion.

3967

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.

3968

3969

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.

3970

3971

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

3972

3973

Returns:

3974

An object of the form:

3975

3976

{ # Represents an Operation resource.

3977

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3978

# Google Compute Engine has three Operation resources:

3979

#

3980

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

3981

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3982

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

3983

#

3984

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3985

# - For global operations, use the `globalOperations` resource.

3986

# - For regional operations, use the `regionOperations` resource.

3987

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3988

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3989

# 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]

3990

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3991

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3992

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3993

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3994

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3995

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3996

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3997

"code": "A String", # [Output Only] The error type identifier for this error.

3998

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3999

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4000

},

4001

],

4002

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4003

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4004

"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.

4005

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4006

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4007

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4008

"name": "A String", # [Output Only] Name of the operation.

4009

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4010

"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.

4011

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4012

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4013

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

4014

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4015

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4016

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4017

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4018

"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.

4019

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4020

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4021

{

4022

"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.

4023

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4024

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4025

{

4026

"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).

4027

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4028

},

4029

],

4030

"message": "A String", # [Output Only] A human-readable description of the warning code.

4031

},

4032

],

4033

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

4038

<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]

4039

<pre>Sets the auto-delete flag for a disk attached to an instance.

4040

4041

Args:

4042

project: string, Project ID for this request. (required)

4043

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4044

instance: string, The instance name for this request. (required)

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4045

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]

4046

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)

4047

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.

4048

4049

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.

4050

4051

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]

4052

4053

Returns:

4054

An object of the form:

4055

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4056

{ # Represents an Operation resource.

4057

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4058

# Google Compute Engine has three Operation resources:

4059

#

4060

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4061

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4062

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4063

#

4064

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4065

# - For global operations, use the `globalOperations` resource.

4066

# - For regional operations, use the `regionOperations` resource.

4067

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4068

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4069

# 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]

4070

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4071

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4072

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4073

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4074

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4075

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4076

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4077

"code": "A String", # [Output Only] The error type identifier for this error.

4078

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4079

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4080

},

4081

],

4082

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4083

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4084

"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.

4085

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4086

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4087

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4088

"name": "A String", # [Output Only] Name of the operation.

4089

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4090

"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.

4091

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4092

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4093

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

4094

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4095

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4096

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4097

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4098

"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.

4099

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4100

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4101

{

4102

"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.

4103

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4104

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4105

{

4106

"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).

4107

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4108

},

4109

],

4110

"message": "A String", # [Output Only] A human-readable description of the warning code.

4111

},

4112

],

4113

"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]

4118

<code class="details" id="setIamPolicy">setIamPolicy(project, zone, resource, body=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4119

<pre>Sets the access control policy on the specified resource. Replaces any existing policy.

4120

4121

Args:

4122

project: string, Project ID for this request. (required)

4123

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4124

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4125

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4126

The object takes the form of:

4127

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4128

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4129

"bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings.

4130

{ # Associates `members` with a `role`.

4131

"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.

4132

#

4133

# If the condition evaluates to `true`, then this binding applies to the current request.

4134

#

4135

# 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.

4136

#

4137

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

4138

#

4139

# Example (Comparison):

4140

#

4141

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

4142

#

4143

# Example (Equality):

4144

#

4145

# 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'"

4150

#

4151

# Example (Data Manipulation):

4152

#

4153

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

4154

#

4155

# 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.

4156

"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.

4157

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

4158

"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.

4159

"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.

4160

},

4161

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

4162

#

4163

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

4164

#

4165

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

4166

#

4167

# * `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`.

4172

#

4173

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

4174

#

4175

# * `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.

4176

#

4177

# * `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.

4178

#

4179

# * `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`.

4184

"A String",

4185

],

4186

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

4187

},

4188

],

4189

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.

4190

"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.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

4191

#

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4192

#

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4193

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4194

# 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.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4195

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4196

# 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]

4197

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4198

# **JSON example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4199

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4200

# { "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]

4201

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4202

# **YAML example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4203

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4204

# 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]

4205

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4206

# 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]

4207

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4208

{ # 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.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

4209

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4210

# 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.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

4211

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4212

# Example Policy with multiple AuditConfigs:

4213

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4214

# { "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]

4215

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4216

# 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]

4217

"auditLogConfigs": [ # The configuration for logging of each type of permission.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4218

{ # Provides the configuration for logging a type of permissions. Example:

4219

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4220

# { "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]

4221

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4222

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

4223

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

4224

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4225

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4226

"ignoreChildExemptions": True or False,

4227

"logType": "A String", # The log type that this config enables.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4228

},

4229

],

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.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

4234

},

4235

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4236

"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]

4237

{ # Associates `members` with a `role`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4238

"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.

4239

#

4240

# If the condition evaluates to `true`, then this binding applies to the current request.

4241

#

4242

# 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.

4243

#

4244

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

4245

#

4246

# Example (Comparison):

4247

#

4248

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

4249

#

4250

# Example (Equality):

4251

#

4252

# 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'"

4257

#

4258

# Example (Data Manipulation):

4259

#

4260

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

4261

#

4262

# 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.

4263

"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.

4264

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

4265

"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.

4266

"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.

4267

},

4268

"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]

4269

#

4270

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

4271

#

4272

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

4273

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4274

# * `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`.

4279

#

4280

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

4281

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4282

# * `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.

4283

#

4284

# * `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.

4285

#

4286

# * `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.

4287

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4288

#

4289

#

4290

# * `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]

4291

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4292

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4293

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4294

},

4295

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4296

"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.

4297

#

4298

# **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.

4299

"iamOwned": True or False,

4300

"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.

4301

{ # A rule to be applied in a Policy.

4302

"action": "A String", # Required

4303

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

4304

{ # A condition to be met.

4305

"iam": "A String", # Trusted attributes supplied by the IAM system.

4306

"op": "A String", # An operator to apply the subject with.

4307

"svc": "A String", # Trusted attributes discharged by the service.

4308

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

4309

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

4315

"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.

4316

"A String",

4317

],

4318

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

4319

{ # Specifies what kind of log the caller must write

4320

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

4321

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

4322

"permissionType": "A String", # The type of the permission that was checked.

4323

},

4324

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

4325

},

4326

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

4327

#

4328

# 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.

4329

#

4330

# Field names correspond to IAM request parameters and field values are their respective values.

4331

#

4332

# 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.

4333

#

4334

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

4335

"customFields": [ # Custom fields.

4336

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

4337

"name": "A String", # Name is the field name.

4338

"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.

4339

},

4340

],

4341

"field": "A String", # The field value to attribute.

4342

"metric": "A String", # The metric to update.

4343

},

4344

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

4345

"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.

4350

"A String",

4351

],

4352

"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.

4353

"A String",

4354

],

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4355

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4356

],

4357

"version": 42, # Specifies the format of the policy.

4358

#

4359

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

4360

#

4361

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

4362

#

4363

# * 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

4364

#

4365

# **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.

4366

#

4367

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

4368

#

4369

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

4370

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4371

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

Returns:

An object of the form:

4376

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4377

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4378

#

4379

#

4380

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4381

# 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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4382

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4383

# 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).

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4384

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4385

# **JSON example:**

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4386

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4387

# { "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]

4388

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4389

# **YAML example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4390

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4391

# 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]

4392

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4393

# 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]

4394

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4395

{ # 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.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

4396

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4397

# 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.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4398

#

4399

# Example Policy with multiple AuditConfigs:

4400

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4401

# { "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" ] } ] } ] }

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4402

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4403

# 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]

4404

"auditLogConfigs": [ # The configuration for logging of each type of permission.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

4405

{ # Provides the configuration for logging a type of permissions. Example:

4406

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4407

# { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] }

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

4408

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4409

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

4410

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

4411

"A String",

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

4412

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4413

"ignoreChildExemptions": True or False,

4414

"logType": "A String", # The log type that this config enables.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

4415

},

4416

],

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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4421

},

4422

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4423

"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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4424

{ # Associates `members` with a `role`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4425

"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.

4426

#

4427

# If the condition evaluates to `true`, then this binding applies to the current request.

4428

#

4429

# 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.

4430

#

4431

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

4432

#

4433

# Example (Comparison):

4434

#

4435

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

4436

#

4437

# Example (Equality):

4438

#

4439

# 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'"

4444

#

4445

# Example (Data Manipulation):

4446

#

4447

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

4448

#

4449

# 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.

4450

"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.

4451

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

4452

"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.

4453

"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.

4454

},

4455

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4456

#

4457

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

4458

#

4459

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

4460

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4461

# * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4462

#

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

4463

#

4464

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4465

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

4466

#

4467

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

4468

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4469

# * `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.

4470

#

4471

# * `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.

4472

#

4473

# * `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.

4474

#

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4475

#

4476

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4477

# * `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]

4478

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4479

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4480

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4481

},

4482

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4483

"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.

4484

#

4485

# **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.

4486

"iamOwned": True or False,

4487

"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.

4488

{ # A rule to be applied in a Policy.

4489

"action": "A String", # Required

4490

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

4491

{ # A condition to be met.

4492

"iam": "A String", # Trusted attributes supplied by the IAM system.

4493

"op": "A String", # An operator to apply the subject with.

4494

"svc": "A String", # Trusted attributes discharged by the service.

4495

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

4496

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

4502

"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.

4503

"A String",

4504

],

4505

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

4506

{ # Specifies what kind of log the caller must write

4507

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

4508

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

4509

"permissionType": "A String", # The type of the permission that was checked.

4510

},

4511

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

4512

},

4513

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

4514

#

4515

# 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.

4516

#

4517

# Field names correspond to IAM request parameters and field values are their respective values.

4518

#

4519

# 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.

4520

#

4521

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

4522

"customFields": [ # Custom fields.

4523

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

4524

"name": "A String", # Name is the field name.

4525

"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.

4526

},

4527

],

4528

"field": "A String", # The field value to attribute.

4529

"metric": "A String", # The metric to update.

4530

},

4531

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

4532

"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.

4537

"A String",

4538

],

4539

"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.

4545

#

4546

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

4547

#

4548

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

4549

#

4550

# * 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

4551

#

4552

# **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.

4553

#

4554

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

4555

#

4556

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

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]

4561

<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]

4562

<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]

4563

4564

Args:

4565

project: string, Project ID for this request. (required)

4566

zone: string, The name of the zone for this request. (required)

4567

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4568

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4569

The object takes the form of:

4570

4571

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4572

"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.

4573

"labels": {

4574

"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]

4578

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.

4579

4580

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.

4581

4582

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]

4583

4584

Returns:

4585

An object of the form:

4586

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4587

{ # Represents an Operation resource.

4588

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4589

# Google Compute Engine has three Operation resources:

4590

#

4591

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4592

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4593

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4594

#

4595

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4596

# - For global operations, use the `globalOperations` resource.

4597

# - For regional operations, use the `regionOperations` resource.

4598

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4599

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4600

# 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]

4601

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4602

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4603

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4604

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4605

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4606

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4607

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4608

"code": "A String", # [Output Only] The error type identifier for this error.

4609

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4610

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4611

},

4612

],

4613

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4614

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4615

"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.

4616

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4617

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4618

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4619

"name": "A String", # [Output Only] Name of the operation.

4620

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4621

"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.

4622

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4623

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4624

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

4625

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4626

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4627

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4628

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4629

"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.

4630

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4631

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4632

{

4633

"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.

4634

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4635

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4636

{

4637

"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).

4638

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4639

},

4640

],

4641

"message": "A String", # [Output Only] A human-readable description of the warning code.

4642

},

4643

],

4644

"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]

4649

<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]

4650

<pre>Changes the number and/or type of accelerator for a stopped instance to the values specified in the request.

4651

4652

Args:

4653

project: string, Project ID for this request. (required)

4654

zone: string, The name of the zone for this request. (required)

4655

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4656

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

4657

The object takes the form of:

4658

4659

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4660

"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]

4661

{ # 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]

4662

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

4663

"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]

4668

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.

4669

4670

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.

4671

4672

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]

4673

4674

Returns:

4675

An object of the form:

4676

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4677

{ # Represents an Operation resource.

4678

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4679

# Google Compute Engine has three Operation resources:

4680

#

4681

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4682

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4683

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4684

#

4685

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4686

# - For global operations, use the `globalOperations` resource.

4687

# - For regional operations, use the `regionOperations` resource.

4688

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4689

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4690

# 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]

4691

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4692

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4693

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4694

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4695

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4696

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

4697

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4698

"code": "A String", # [Output Only] The error type identifier for this error.

4699

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4700

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

4701

},

4702

],

4703

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4704

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4705

"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.

4706

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4707

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4708

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4709

"name": "A String", # [Output Only] Name of the operation.

4710

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4711

"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.

4712

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4713

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4714

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

4715

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4716

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4717

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4718

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4719

"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.

4720

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4721

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4722

{

4723

"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.

4724

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4725

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4726

{

4727

"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).

4728

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4729

},

4730

],

4731

"message": "A String", # [Output Only] A human-readable description of the warning code.

4732

},

4733

],

4734

"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]

4739

<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]

4740

<pre>Changes the machine type for a stopped instance to the machine type specified in the request.

4741

4742

Args:

4743

project: string, Project ID for this request. (required)

4744

zone: string, The name of the zone for this request. (required)

4745

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4746

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4747

The object takes the form of:

4748

4749

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4750

"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]

4751

}

4752

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4753

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.

4754

4755

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.

4756

4757

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]

4758

4759

Returns:

4760

An object of the form:

4761

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4762

{ # Represents an Operation resource.

4763

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4764

# Google Compute Engine has three Operation resources:

4765

#

4766

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4767

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4768

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4769

#

4770

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4771

# - For global operations, use the `globalOperations` resource.

4772

# - For regional operations, use the `regionOperations` resource.

4773

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4774

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4775

# 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]

4776

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4777

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4778

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4779

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4780

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4781

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4782

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4783

"code": "A String", # [Output Only] The error type identifier for this error.

4784

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4785

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4786

},

4787

],

4788

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4789

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4790

"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.

4791

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4792

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4793

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4794

"name": "A String", # [Output Only] Name of the operation.

4795

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4796

"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.

4797

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4798

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4799

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

4800

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4801

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4802

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4803

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4804

"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.

4805

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4806

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4807

{

4808

"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.

4809

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4810

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4811

{

4812

"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).

4813

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4814

},

4815

],

4816

"message": "A String", # [Output Only] A human-readable description of the warning code.

4817

},

4818

],

4819

"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]

4824

<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]

4825

<pre>Sets metadata for the specified instance to the data included in the request.

4826

4827

Args:

4828

project: string, Project ID for this request. (required)

4829

zone: string, The name of the zone for this request. (required)

4830

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4831

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4832

The object takes the form of:

4833

4834

{ # A metadata key/value entry.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4835

"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]

4836

#

4837

# 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]

4838

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

4839

{

4840

"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.

4841

"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).

4842

},

4843

],

4844

"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]

4845

}

4846

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4847

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.

4848

4849

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.

4850

4851

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]

4852

4853

Returns:

4854

An object of the form:

4855

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4856

{ # Represents an Operation resource.

4857

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4858

# Google Compute Engine has three Operation resources:

4859

#

4860

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4861

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4862

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4863

#

4864

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4865

# - For global operations, use the `globalOperations` resource.

4866

# - For regional operations, use the `regionOperations` resource.

4867

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4868

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4869

# 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]

4870

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4871

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4872

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4873

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4874

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4875

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4876

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4877

"code": "A String", # [Output Only] The error type identifier for this error.

4878

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4879

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4880

},

4881

],

4882

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4883

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4884

"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.

4885

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4886

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4887

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4888

"name": "A String", # [Output Only] Name of the operation.

4889

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4890

"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.

4891

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4892

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4893

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

4894

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4895

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4896

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4897

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4898

"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.

4899

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4900

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4901

{

4902

"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.

4903

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4904

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4905

{

4906

"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).

4907

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4908

},

4909

],

4910

"message": "A String", # [Output Only] A human-readable description of the warning code.

4911

},

4912

],

4913

"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]

4918

<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]

4919

<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-03-13 12:12:03 -0400

[diff] [blame]

4920

4921

Args:

4922

project: string, Project ID for this request. (required)

4923

zone: string, The name of the zone for this request. (required)

4924

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4925

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

4926

The object takes the form of:

4927

4928

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4929

"minCpuPlatform": "A String", # Minimum cpu/platform this instance should be started at.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

4930

}

4931

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4932

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.

4933

4934

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.

4935

4936

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]

4937

4938

Returns:

4939

An object of the form:

4940

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4941

{ # Represents an Operation resource.

4942

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4943

# Google Compute Engine has three Operation resources:

4944

#

4945

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4946

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4947

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4948

#

4949

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4950

# - For global operations, use the `globalOperations` resource.

4951

# - For regional operations, use the `regionOperations` resource.

4952

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4953

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4954

# 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]

4955

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4956

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4957

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4958

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4959

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4960

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4961

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4962

"code": "A String", # [Output Only] The error type identifier for this error.

4963

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4964

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4965

},

4966

],

4967

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4968

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4969

"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.

4970

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4971

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4972

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4973

"name": "A String", # [Output Only] Name of the operation.

4974

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4975

"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.

4976

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4977

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4978

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

4979

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4980

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4981

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4982

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4983

"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.

4984

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4985

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4986

{

4987

"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.

4988

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4989

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4990

{

4991

"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).

4992

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4993

},

4994

],

4995

"message": "A String", # [Output Only] A human-readable description of the warning code.

4996

},

4997

],

4998

"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]

5003

<code class="details" id="setName">setName(project, zone, instance, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5004

<pre>Sets name of an instance.

5005

5006

Args:

5007

project: string, Project ID for this request. (required)

5008

zone: string, The name of the zone for this request. (required)

5009

instance: string, The instance name for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5010

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5011

The object takes the form of:

5012

5013

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5014

"currentName": "A String", # The current name of this resource, used to prevent conflicts. Provide the latest name when making a request to change name.

5015

"name": "A String", # The name to be applied to the instance. Needs to be RFC 1035 compliant.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5016

}

5017

5018

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.

5019

5020

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.

5021

5022

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

5023

5024

Returns:

5025

An object of the form:

5026

5027

{ # Represents an Operation resource.

5028

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5029

# Google Compute Engine has three Operation resources:

5030

#

5031

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5032

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5033

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5034

#

5035

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5036

# - For global operations, use the `globalOperations` resource.

5037

# - For regional operations, use the `regionOperations` resource.

5038

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5039

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5040

# 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]

5041

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5042

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5043

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5044

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5045

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5046

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

5047

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5048

"code": "A String", # [Output Only] The error type identifier for this error.

5049

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5050

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

5051

},

5052

],

5053

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5054

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5055

"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.

5056

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5057

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5058

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5059

"name": "A String", # [Output Only] Name of the operation.

5060

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5061

"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.

5062

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5063

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5064

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5065

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5066

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5067

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5068

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5069

"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.

5070

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5071

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5072

{

5073

"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.

5074

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5075

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5076

{

5077

"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).

5078

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5079

},

5080

],

5081

"message": "A String", # [Output Only] A human-readable description of the warning code.

5082

},

5083

],

5084

"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]

5089

<code class="details" id="setScheduling">setScheduling(project, zone, instance, body=None, requestId=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5090

<pre>Sets an instance's scheduling options.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5091

5092

Args:

5093

project: string, Project ID for this request. (required)

5094

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5095

instance: string, Instance name for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5096

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5097

The object takes the form of:

5098

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5099

{ # Sets the scheduling options for an Instance. NextID: 11

5100

"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.

5101

#

5102

# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

5103

"latencyTolerant": True or False, # Defines whether the instance is tolerant of higher cpu latency. This can only be set during instance creation, or when the instance is not currently running. It must not be set if the preemptible option is also set.

5104

"locationHint": "A String", # An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.

5105

"longTermRelease": True or False, # DEPRECATED, please use maintenance_freeze_duration_hours. TODO(b/154158138): Remove this field. Compute Engine Long Term Release. When specified, VMs that have this policy become long term release (internal: stable fleet) VMs.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5106

#

5107

# For all VM shapes, this should result in fewer disruptions due to software updates and greater predictability via 1 week extended notifications.

5108

#

5109

# For GPU VMs, this should also result in an 2 week uptime guarantee. See go/stable-fleet-gpus-design for more details.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5110

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

5111

"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]

5112

{ # 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]

5113

"key": "A String", # Corresponds to the label key of Node resource.

5114

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

5115

"values": [ # Corresponds to the label values of Node resource.

5116

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5117

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5118

},

5119

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5120

"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.

5121

"preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation, it cannot be set or changed after the instance has been created.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5122

}

5123

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5124

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.

5125

5126

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.

5127

5128

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]

5129

5130

Returns:

5131

An object of the form:

5132

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5133

{ # Represents an Operation resource.

5134

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5135

# Google Compute Engine has three Operation resources:

5136

#

5137

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5138

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5139

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5140

#

5141

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5142

# - For global operations, use the `globalOperations` resource.

5143

# - For regional operations, use the `regionOperations` resource.

5144

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5145

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5146

# 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]

5147

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5148

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5149

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5150

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5151

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5152

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5153

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5154

"code": "A String", # [Output Only] The error type identifier for this error.

5155

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5156

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5157

},

5158

],

5159

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5160

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5161

"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.

5162

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5163

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5164

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5165

"name": "A String", # [Output Only] Name of the operation.

5166

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5167

"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.

5168

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5169

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5170

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5171

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5172

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5173

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5174

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5175

"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.

5176

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5177

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5178

{

5179

"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.

5180

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5181

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5182

{

5183

"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).

5184

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5185

},

5186

],

5187

"message": "A String", # [Output Only] A human-readable description of the warning code.

5188

},

5189

],

5190

"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]

5195

<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]

5196

<pre>Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5197

5198

Args:

5199

project: string, Project ID for this request. (required)

5200

zone: string, The name of the zone for this request. (required)

5201

instance: string, Name of the instance resource to start. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5202

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5203

The object takes the form of:

5204

5205

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5206

"email": "A String", # Email address of the service account.

5207

"scopes": [ # The list of scopes to be made available for this service account.

5208

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5209

],

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5210

}

5211

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5212

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.

5213

5214

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.

5215

5216

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]

5217

5218

Returns:

5219

An object of the form:

5220

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5221

{ # Represents an Operation resource.

5222

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5223

# Google Compute Engine has three Operation resources:

5224

#

5225

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5226

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5227

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5228

#

5229

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5230

# - For global operations, use the `globalOperations` resource.

5231

# - For regional operations, use the `regionOperations` resource.

5232

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5233

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5234

# 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]

5235

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5236

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5237

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5238

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5239

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5240

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5241

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5242

"code": "A String", # [Output Only] The error type identifier for this error.

5243

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5244

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5245

},

5246

],

5247

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5248

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5249

"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.

5250

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5251

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5252

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5253

"name": "A String", # [Output Only] Name of the operation.

5254

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5255

"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.

5256

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5257

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5258

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5259

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5260

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5261

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5262

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5263

"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.

5264

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5265

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5266

{

5267

"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.

5268

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5269

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5270

{

5271

"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).

5272

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5273

},

5274

],

5275

"message": "A String", # [Output Only] A human-readable description of the warning code.

5276

},

5277

],

5278

"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]

5283

<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]

5284

<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.

5285

5286

Args:

5287

project: string, Project ID for this request. (required)

5288

zone: string, The name of the zone for this request. (required)

5289

instance: string, Name or id of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5290

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5291

The object takes the form of:

5292

5293

{ # The policy describes the baseline against which Instance boot integrity is measured.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5294

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5295

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5296

5297

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.

5298

5299

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.

5300

5301

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

5302

5303

Returns:

5304

An object of the form:

5305

5306

{ # Represents an Operation resource.

5307

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5308

# Google Compute Engine has three Operation resources:

5309

#

5310

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5311

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5312

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5313

#

5314

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5315

# - For global operations, use the `globalOperations` resource.

5316

# - For regional operations, use the `regionOperations` resource.

5317

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5318

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5319

# 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]

5320

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5321

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5322

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5323

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5324

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5325

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5326

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5327

"code": "A String", # [Output Only] The error type identifier for this error.

5328

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5329

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5330

},

5331

],

5332

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5333

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5334

"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.

5335

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5336

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5337

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5338

"name": "A String", # [Output Only] Name of the operation.

5339

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5340

"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.

5341

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5342

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5343

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5344

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5345

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5346

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5347

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5348

"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.

5349

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5350

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5351

{

5352

"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.

5353

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5354

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5355

{

5356

"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).

5357

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5358

},

5359

],

5360

"message": "A String", # [Output Only] A human-readable description of the warning code.

5361

},

5362

],

5363

"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]

5368

<code class="details" id="setShieldedVmIntegrityPolicy">setShieldedVmIntegrityPolicy(project, zone, instance, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5369

<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.

5370

5371

Args:

5372

project: string, Project ID for this request. (required)

5373

zone: string, The name of the zone for this request. (required)

5374

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5375

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5376

The object takes the form of:

5377

5378

{ # The policy describes the baseline against which VM instance boot integrity is measured.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5379

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5380

}

5381

5382

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.

5383

5384

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.

5385

5386

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

5387

5388

Returns:

5389

An object of the form:

5390

5391

{ # Represents an Operation resource.

5392

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5393

# Google Compute Engine has three Operation resources:

5394

#

5395

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5396

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5397

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5398

#

5399

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5400

# - For global operations, use the `globalOperations` resource.

5401

# - For regional operations, use the `regionOperations` resource.

5402

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5403

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5404

# 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]

5405

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5406

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5407

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5408

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5409

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5410

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5411

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5412

"code": "A String", # [Output Only] The error type identifier for this error.

5413

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5414

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5415

},

5416

],

5417

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5418

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5419

"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.

5420

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5421

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5422

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5423

"name": "A String", # [Output Only] Name of the operation.

5424

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5425

"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.

5426

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5427

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5428

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5429

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5430

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5431

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5432

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5433

"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.

5434

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5435

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5436

{

5437

"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.

5438

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5439

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5440

{

5441

"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).

5442

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5443

},

5444

],

5445

"message": "A String", # [Output Only] A human-readable description of the warning code.

5446

},

5447

],

5448

"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]

5453

<code class="details" id="setTags">setTags(project, zone, instance, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5454

<pre>Sets network tags for the specified instance to the data included in the request.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5455

5456

Args:

5457

project: string, Project ID for this request. (required)

5458

zone: string, The name of the zone for this request. (required)

5459

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5460

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5461

The object takes the form of:

5462

5463

{ # A set of instance tags.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5464

"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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5465

#

5466

# To see the latest fingerprint, make get() request to the instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5467

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

5468

"A String",

5469

],

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5470

}

5471

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5472

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.

5473

5474

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.

5475

5476

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]

5477

5478

Returns:

5479

An object of the form:

5480

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5481

{ # Represents an Operation resource.

5482

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5483

# Google Compute Engine has three Operation resources:

5484

#

5485

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5486

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5487

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5488

#

5489

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5490

# - For global operations, use the `globalOperations` resource.

5491

# - For regional operations, use the `regionOperations` resource.

5492

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5493

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5494

# 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]

5495

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5496

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5497

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5498

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5499

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5500

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5501

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5502

"code": "A String", # [Output Only] The error type identifier for this error.

5503

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5504

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5505

},

5506

],

5507

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5508

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5509

"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.

5510

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5511

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5512

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5513

"name": "A String", # [Output Only] Name of the operation.

5514

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5515

"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.

5516

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5517

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5518

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5519

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5520

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5521

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5522

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5523

"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.

5524

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5525

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5526

{

5527

"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.

5528

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5529

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5530

{

5531

"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).

5532

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5533

},

5534

],

5535

"message": "A String", # [Output Only] A human-readable description of the warning code.

5536

},

5537

],

5538

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

5543

<code class="details" id="simulateMaintenanceEvent">simulateMaintenanceEvent(project, zone, instance)</code>

5544

<pre>Simulates a maintenance event on the instance.

5545

5546

Args:

5547

project: string, Project ID for this request. (required)

5548

zone: string, The name of the zone for this request. (required)

5549

instance: string, Name of the instance scoping this request. (required)

5550

5551

Returns:

5552

An object of the form:

5553

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5554

{ # Represents an Operation resource.

5555

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5556

# Google Compute Engine has three Operation resources:

5557

#

5558

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5559

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5560

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5561

#

5562

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5563

# - For global operations, use the `globalOperations` resource.

5564

# - For regional operations, use the `regionOperations` resource.

5565

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5566

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5567

# 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]

5568

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5569

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5570

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5571

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5572

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5573

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

5574

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5575

"code": "A String", # [Output Only] The error type identifier for this error.

5576

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5577

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

5578

},

5579

],

5580

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5581

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5582

"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.

5583

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5584

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5585

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5586

"name": "A String", # [Output Only] Name of the operation.

5587

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5588

"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.

5589

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5590

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5591

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5592

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5593

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5594

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5595

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5596

"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.

5597

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5598

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5599

{

5600

"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.

5601

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5602

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5603

{

5604

"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).

5605

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5606

},

5607

],

5608

"message": "A String", # [Output Only] A human-readable description of the warning code.

5609

},

5610

],

5611

"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>

<code class="details" id="start">start(project, zone, instance, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5617

<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]

5618

5619

Args:

5620

project: string, Project ID for this request. (required)

5621

zone: string, The name of the zone for this request. (required)

5622

instance: string, Name of the instance resource to start. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5623

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.

5624

5625

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.

5626

5627

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]

5628

5629

Returns:

5630

An object of the form:

5631

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5632

{ # Represents an Operation resource.

5633

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5634

# Google Compute Engine has three Operation resources:

5635

#

5636

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5637

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5638

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5639

#

5640

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5641

# - For global operations, use the `globalOperations` resource.

5642

# - For regional operations, use the `regionOperations` resource.

5643

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5644

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5645

# 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]

5646

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5647

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5648

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5649

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5650

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5651

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5652

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5653

"code": "A String", # [Output Only] The error type identifier for this error.

5654

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5655

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5656

},

5657

],

5658

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5659

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5660

"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.

5661

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5662

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5663

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5664

"name": "A String", # [Output Only] Name of the operation.

5665

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5666

"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.

5667

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5668

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5669

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5670

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5671

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5672

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5673

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5674

"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.

5675

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5676

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5677

{

5678

"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.

5679

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5680

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5681

{

5682

"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).

5683

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5684

},

5685

],

5686

"message": "A String", # [Output Only] A human-readable description of the warning code.

5687

},

5688

],

5689

"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]

5694

<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]

5695

<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]

5696

5697

Args:

5698

project: string, Project ID for this request. (required)

5699

zone: string, The name of the zone for this request. (required)

5700

instance: string, Name of the instance resource to start. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5701

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5702

The object takes the form of:

5703

5704

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5705

"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]

5706

#

5707

# In order to start the instance, the disk url and its corresponding key must be provided.

5708

#

5709

# If the disk is not protected with a customer-supplied encryption key it should not be specified.

5710

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5711

"diskEncryptionKey": { # Represents a customer-supplied encryption key # Decrypts data associated with the disk with a customer-supplied encryption key.

5712

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

5713

"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.

5714

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

5715

"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]

5716

#

5717

# The key must meet the following requirements before you can provide it to Compute Engine:

5718

# - 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]

5719

# - 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]

5720

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5721

"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]

5722

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5723

"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]

5724

},

5725

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5726

"instanceEncryptionKey": { # Represents a customer-supplied encryption key # Decrypts data associated with an instance that is protected with a customer-supplied encryption key.

5727

#

5728

# If the instance you are starting is protected with a customer-supplied encryption key, the correct key must be provided otherwise the instance start will not succeed.

5729

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

5730

"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.

5731

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

5732

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

5733

#

5734

# The key must meet the following requirements before you can provide it to Compute Engine:

5735

# - The key is wrapped using a RSA public key certificate provided by Google.

5736

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

5737

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

5738

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

5739

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5740

}

5741

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5742

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.

5743

5744

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.

5745

5746

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]

5747

5748

Returns:

5749

An object of the form:

5750

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5751

{ # Represents an Operation resource.

5752

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5753

# Google Compute Engine has three Operation resources:

5754

#

5755

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5756

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5757

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5758

#

5759

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5760

# - For global operations, use the `globalOperations` resource.

5761

# - For regional operations, use the `regionOperations` resource.

5762

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5763

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5764

# 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]

5765

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5766

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5767

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5768

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5769

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5770

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5771

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5772

"code": "A String", # [Output Only] The error type identifier for this error.

5773

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5774

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5775

},

5776

],

5777

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5778

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5779

"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.

5780

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5781

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5782

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5783

"name": "A String", # [Output Only] Name of the operation.

5784

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5785

"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.

5786

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5787

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5788

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5789

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5790

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5791

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5792

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5793

"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.

5794

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5795

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5796

{

5797

"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.

5798

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5799

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5800

{

5801

"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).

5802

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5803

},

5804

],

5805

"message": "A String", # [Output Only] A human-readable description of the warning code.

5806

},

5807

],

5808

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

5813

<code class="details" id="stop">stop(project, zone, instance, discardLocalSsd=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5814

<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]

5815

5816

Args:

5817

project: string, Project ID for this request. (required)

5818

zone: string, The name of the zone for this request. (required)

5819

instance: string, Name of the instance resource to stop. (required)

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

5820

discardLocalSsd: boolean, If true, discard the contents of any attached localSSD partitions. Default value is false (== preserve localSSD data).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5821

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.

5822

5823

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.

5824

5825

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]

5826

5827

Returns:

5828

An object of the form:

5829

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5830

{ # Represents an Operation resource.

5831

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5832

# Google Compute Engine has three Operation resources:

5833

#

5834

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5835

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5836

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5837

#

5838

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5839

# - For global operations, use the `globalOperations` resource.

5840

# - For regional operations, use the `regionOperations` resource.

5841

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5842

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5843

# 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]

5844

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5845

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5846

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5847

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5848

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5849

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5850

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5851

"code": "A String", # [Output Only] The error type identifier for this error.

5852

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5853

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5854

},

5855

],

5856

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5857

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5858

"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.

5859

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5860

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5861

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5862

"name": "A String", # [Output Only] Name of the operation.

5863

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5864

"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.

5865

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5866

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5867

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5868

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5869

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5870

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5871

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5872

"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.

5873

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5874

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5875

{

5876

"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.

5877

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5878

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5879

{

5880

"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).

5881

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5882

},

5883

],

5884

"message": "A String", # [Output Only] A human-readable description of the warning code.

5885

},

5886

],

5887

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

5892

<code class="details" id="suspend">suspend(project, zone, instance, discardLocalSsd=None, requestId=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5893

<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.

5894

5895

Args:

5896

project: string, Project ID for this request. (required)

5897

zone: string, The name of the zone for this request. (required)

5898

instance: string, Name of the instance resource to suspend. (required)

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

5899

discardLocalSsd: boolean, If true, discard the contents of any attached localSSD partitions. Default value is false (== preserve localSSD data).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5900

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.

5901

5902

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.

5903

5904

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]

5905

5906

Returns:

5907

An object of the form:

5908

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5909

{ # Represents an Operation resource.

5910

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5911

# Google Compute Engine has three Operation resources:

5912

#

5913

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5914

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5915

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5916

#

5917

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5918

# - For global operations, use the `globalOperations` resource.

5919

# - For regional operations, use the `regionOperations` resource.

5920

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5921

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5922

# 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]

5923

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5924

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5925

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5926

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5927

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5928

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5929

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5930

"code": "A String", # [Output Only] The error type identifier for this error.

5931

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5932

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5933

},

5934

],

5935

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5936

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5937

"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.

5938

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5939

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5940

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5941

"name": "A String", # [Output Only] Name of the operation.

5942

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5943

"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.

5944

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5945

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5946

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5947

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5948

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5949

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5950

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5951

"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.

5952

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5953

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5954

{

5955

"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.

5956

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5957

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5958

{

5959

"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).

5960

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5961

},

5962

],

5963

"message": "A String", # [Output Only] A human-readable description of the warning code.

5964

},

5965

],

5966

"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]

5971

<code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5972

<pre>Returns permissions that a caller has on the specified resource.

5973

5974

Args:

5975

project: string, Project ID for this request. (required)

5976

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5977

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5978

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5979

The object takes the form of:

5980

5981

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5982

"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.

5983

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

],

}

Returns:

An object of the form:

5990

5991

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5992

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.

5993

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

],

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5999

<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]

6000

<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.

6001

6002

Args:

6003

project: string, Project ID for this request. (required)

6004

zone: string, The name of the zone for this request. (required)

6005

instance: string, Name of the instance resource to update. (required)

6006

body: object, The request body.

6007

The object takes the form of:

6008

6009

{ # Represents an Instance resource.

6010

#

6011

# 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]

6012

"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.

6013

"confidentialInstanceConfig": { # A set of Confidential Instance options.

6014

"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6015

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6016

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

6017

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

6018

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

6019

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

6020

"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]

6021

{ # An instance-attached disk resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6022

"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).

6023

"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.

6024

"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.

6025

#

6026

# 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.

6027

"diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6028

#

6029

# 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.

6030

#

6031

# 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.

6032

#

6033

# 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.

6034

#

6035

# 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]

6036

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

6037

"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.

6038

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

6039

"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]

6040

#

6041

# The key must meet the following requirements before you can provide it to Compute Engine:

6042

# - The key is wrapped using a RSA public key certificate provided by Google.

6043

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

6044

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6045

"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]

6046

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6047

"diskSizeGb": "A String", # The size of the disk in GB.

6048

"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.

6049

{ # Guest OS features.

6050

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

6051

},

6052

],

6053

"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.

6054

"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]

6055

#

6056

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

6057

#

6058

# 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]

6059

"description": "A String", # An optional description. Provide this property when creating the disk.

6060

"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.

6061

"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.

6062

"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]

6063

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

6064

#

6065

#

6066

# 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:

6067

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType

6068

# - projects/project/zones/zone/diskTypes/diskType

6069

# - 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]

6070

"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]

6071

#

6072

# Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

6073

{ # Guest OS features.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6074

"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]

6075

},

6076

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6077

"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.

6078

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6079

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6080

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

6081

"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

6082

"A String",

6083

],

6084

"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.

6085

"A String",

6086

],

6087

"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]

6088

#

6089

# 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:

6090

# projects/debian-cloud/global/images/family/debian-9

6091

#

6092

#

6093

# Alternatively, use a specific version of a public operating system image:

6094

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

6095

#

6096

#

6097

# To create a disk with a custom image that you created, specify the image name in the following format:

6098

# global/images/my-custom-image

6099

#

6100

#

6101

# 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:

6102

# global/images/family/my-image-family

6103

#

6104

#

6105

# If the source image is deleted later, this field will not be set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6106

"sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

6107

#

6108

# 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.

6109

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

6110

"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.

6111

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

6112

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

6113

#

6114

# The key must meet the following requirements before you can provide it to Compute Engine:

6115

# - The key is wrapped using a RSA public key certificate provided by Google.

6116

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

6117

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

6118

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

6119

},

6120

"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.

6121

#

6122

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

6123

# global/snapshots/my-backup

6124

#

6125

#

6126

# If the source snapshot is deleted later, this field will not be set.

6127

"sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot.

6128

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

6129

"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.

6130

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

6131

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

6132

#

6133

# The key must meet the following requirements before you can provide it to Compute Engine:

6134

# - The key is wrapped using a RSA public key certificate provided by Google.

6135

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

6136

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

6137

"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]

6138

},

6139

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6140

"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.

6141

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

6142

"licenses": [ # [Output Only] Any valid publicly visible licenses.

6143

"A String",

6144

],

6145

"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.

6146

"savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to PRESERVED if the LocalSSD data has been saved to a persistent location by customer request. (see the discard_local_ssd option on Stop/Suspend). Read-only in the api.

6147

"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

6148

"dbs": [ # The Key Database (db).

6149

{

6150

"content": "A String", # The raw content in the secure keys file.

6151

"fileType": "A String", # The file type of source file.

6152

},

6153

],

6154

"dbxs": [ # The forbidden key database (dbx).

6155

{

6156

"content": "A String", # The raw content in the secure keys file.

6157

"fileType": "A String", # The file type of source file.

6158

},

6159

],

6160

"keks": [ # The Key Exchange Key (KEK).

6161

{

6162

"content": "A String", # The raw content in the secure keys file.

6163

"fileType": "A String", # The file type of source file.

6164

},

6165

],

6166

"pk": { # The Platform Key (PK).

6167

"content": "A String", # The raw content in the secure keys file.

6168

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6169

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6170

},

6171

"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]

6172

#

6173

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

6174

#

6175

# 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]

6176

"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]

6177

},

6178

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6179

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

6180

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6181

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6182

"eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.

6183

"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.

6184

#

6185

# To see the latest fingerprint, make get() request to the instance.

6186

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

6187

{ # A specification of the type and number of accelerator cards attached to the instance.

6188

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

6189

"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.

6190

},

6191

],

6192

"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.

6193

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

6194

"instanceEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts data for an instance with a customer-supplied encryption key.

6195

#

6196

# If you are creating a new instance, this field encrypts the local SSD and in-memory contents of the instance using a key that you provide.

6197

#

6198

# If you are restarting an instance protected with a customer-supplied encryption key, you must provide the correct key in order to successfully restart the instance.

6199

#

6200

# If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key and you do not need to provide a key to start the instance later.

6201

#

6202

# Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt local SSDs and in-memory content in a managed instance group.

6203

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

6204

"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.

6205

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

6206

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

6207

#

6208

# The key must meet the following requirements before you can provide it to Compute Engine:

6209

# - The key is wrapped using a RSA public key certificate provided by Google.

6210

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

6211

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

6212

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

6213

},

6214

"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.

6215

"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.

6216

#

6217

# To see the latest fingerprint, make get() request to the instance.

6218

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

6219

"a_key": "A String",

6220

},

6221

"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:

6222

# zones/us-central1-f/machineTypes/n1-standard-1

6223

#

6224

#

6225

# 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):

6226

# zones/zone/machineTypes/custom-CPUS-MEMORY

6227

#

6228

#

6229

# For example: zones/us-central1-f/machineTypes/custom-4-5120

6230

#

6231

# For a full list of restrictions, read the Specifications for custom machine types.

6232

"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

6233

"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.

6234

#

6235

# To see the latest fingerprint, make a get() request to retrieve the resource.

6236

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

6237

{

6238

"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.

6239

"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).

6240

},

6241

],

6242

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

6243

},

6244

"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".

6245

"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.

6246

"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.

6247

{ # A network interface resource attached to an instance.

6248

"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.

6249

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

6250

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

6251

"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.

6252

"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.

6253

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

6254

#

6255

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

6256

#

6257

# 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.

6258

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

6259

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

6260

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

6261

"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.

6262

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

6263

},

6264

],

6265

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

6266

{ # An alias IP range attached to an instance's network interface.

6267

"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).

6268

"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.

6269

},

6270

],

6271

"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.

6272

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

6273

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

6274

"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.

6275

"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.

6276

#

6277

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

6278

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

6279

# - projects/project/global/networks/network

6280

# - global/networks/default

6281

"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.

6282

"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:

6283

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

6284

# - regions/region/subnetworks/subnetwork

6285

},

6286

],

6287

"postKeyRevocationActionType": "A String", # Specifies whether this instance will be shut down on key revocation.

6288

"preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api.

6289

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.

6290

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.

6291

"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.

6292

"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.

6293

"values": [ # Corresponds to the label values of a reservation resource.

"A String",

],

},

"resourcePolicies": [ # Resource policies applied to this instance.

6298

"A String",

6299

],

6300

"scheduling": { # Sets the scheduling options for an Instance. NextID: 11 # Sets the scheduling options for this instance.

6301

"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.

6302

#

6303

# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

6304

"latencyTolerant": True or False, # Defines whether the instance is tolerant of higher cpu latency. This can only be set during instance creation, or when the instance is not currently running. It must not be set if the preemptible option is also set.

6305

"locationHint": "A String", # An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.

6306

"longTermRelease": True or False, # DEPRECATED, please use maintenance_freeze_duration_hours. TODO(b/154158138): Remove this field. Compute Engine Long Term Release. When specified, VMs that have this policy become long term release (internal: stable fleet) VMs.

6307

#

6308

# For all VM shapes, this should result in fewer disruptions due to software updates and greater predictability via 1 week extended notifications.

6309

#

6310

# For GPU VMs, this should also result in an 2 week uptime guarantee. See go/stable-fleet-gpus-design for more details.

6311

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

6312

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

6313

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

6314

"key": "A String", # Corresponds to the label key of Node resource.

6315

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

6316

"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.

6322

"preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation, it cannot be set or changed after the instance has been created.

6323

},

6324

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

6325

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

6326

"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

6327

#

6328

# 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.

6329

{ # A service account.

6330

"email": "A String", # Email address of the service account.

6331

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

6337

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

6338

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

6339

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

6340

},

6341

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

6342

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

6343

},

6344

"shieldedVmConfig": { # A set of Shielded VM options.

6345

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

6346

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

6347

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

6348

},

6349

"shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured.

6350

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

6351

},

6352

"sourceMachineImage": "A String", # Source machine image

6353

"sourceMachineImageEncryptionKey": { # Represents a customer-supplied encryption key # Source GMI encryption key when creating an instance from GMI.

6354

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

6355

"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.

6356

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

6357

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

6358

#

6359

# The key must meet the following requirements before you can provide it to Compute Engine:

6360

# - The key is wrapped using a RSA public key certificate provided by Google.

6361

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

6362

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

6363

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

6364

},

6365

"startRestricted": True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.

6366

"status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, STOPPED, SUSPENDING, SUSPENDED, and TERMINATED.

6367

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

6368

"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.

6369

"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.

6370

#

6371

# To see the latest fingerprint, make get() request to the instance.

6372

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

"A String",

],

},

"upcomingMaintenance": { # Upcoming Maintenance notification information. # [Output Only] Specifies upcoming maintenance for the instance.

6377

"date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format.

6378

"time": "A String", # [Output Only] The time when the maintenance will take place. This value is in RFC3339 text format.

6379

"type": "A String", # Defines the type of maintenance.

6380

},

6381

"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]

6382

}

6383

6384

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]

6390

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]

6396

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.

6397

6398

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.

6399

6400

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]

6401

6402

Returns:

6403

An object of the form:

6404

6405

{ # Represents an Operation resource.

6406

#

6407

# Google Compute Engine has three Operation resources:

6408

#

6409

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6410

#

6411

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6412

#

6413

# Operations can be global, regional or zonal.

6414

# - For global operations, use the `globalOperations` resource.

6415

# - For regional operations, use the `regionOperations` resource.

6416

# - For zonal operations, use the `zonalOperations` resource.

6417

#

6418

# 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]

6419

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6420

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6421

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6422

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6423

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6424

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6425

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6426

"code": "A String", # [Output Only] The error type identifier for this error.

6427

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6428

"message": "A String", # [Output Only] An optional, human-readable error message.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6429

},

6430

],

6431

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6432

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6433

"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.

6434

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6435

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6436

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6437

"name": "A String", # [Output Only] Name of the operation.

6438

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6439

"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.

6440

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6441

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6442

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

6443

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6444

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6445

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6446

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6447

"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.

6448

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6449

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6450

{

6451

"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.

6452

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6453

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6454

{

6455

"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).

6456

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6457

},

6458

],

6459

"message": "A String", # [Output Only] A human-readable description of the warning code.

6460

},

6461

],

6462

"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]

6468

<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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6469

6470

Args:

6471

project: string, Project ID for this request. (required)

6472

zone: string, The name of the zone for this request. (required)

6473

instance: string, The instance name for this request. (required)

6474

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]

6475

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6476

The object takes the form of:

6477

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6478

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

6479

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

6480

"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.

6481

"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.

6482

"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]

6483

#

6484

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

6485

#

6486

# 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]

6487

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

6488

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

6489

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

6490

"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.

6491

"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]

6492

}

6493

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6494

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.

6495

6496

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.

6497

6498

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]

6499

6500

Returns:

6501

An object of the form:

6502

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6503

{ # Represents an Operation resource.

6504

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6505

# Google Compute Engine has three Operation resources:

6506

#

6507

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6508

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6509

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6510

#

6511

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6512

# - For global operations, use the `globalOperations` resource.

6513

# - For regional operations, use the `regionOperations` resource.

6514

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6515

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6516

# 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]

6517

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6518

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6519

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6520

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6521

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6522

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6523

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6524

"code": "A String", # [Output Only] The error type identifier for this error.

6525

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6526

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6527

},

6528

],

6529

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6530

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6531

"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.

6532

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6533

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6534

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6535

"name": "A String", # [Output Only] Name of the operation.

6536

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6537

"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.

6538

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6539

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6540

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

6541

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6542

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6543

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6544

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6545

"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.

6546

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6547

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6548

{

6549

"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.

6550

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6551

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6552

{

6553

"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).

6554

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6555

},

6556

],

6557

"message": "A String", # [Output Only] A human-readable description of the warning code.

6558

},

6559

],

6560

"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]

6565

<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]

6566

<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.

6567

6568

Args:

6569

project: string, Project ID for this request. (required)

6570

zone: string, The name of the zone for this request. (required)

6571

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6572

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6573

The object takes the form of:

6574

6575

{ # A set of Display Device options

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6576

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6577

}

6578

6579

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.

6580

6581

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.

6582

6583

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

6584

6585

Returns:

6586

An object of the form:

6587

6588

{ # Represents an Operation resource.

6589

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6590

# Google Compute Engine has three Operation resources:

6591

#

6592

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6593

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6594

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6595

#

6596

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6597

# - For global operations, use the `globalOperations` resource.

6598

# - For regional operations, use the `regionOperations` resource.

6599

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6600

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6601

# 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]

6602

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6603

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6604

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6605

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6606

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6607

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6608

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6609

"code": "A String", # [Output Only] The error type identifier for this error.

6610

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6611

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6612

},

6613

],

6614

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6615

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6616

"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.

6617

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6618

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6619

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6620

"name": "A String", # [Output Only] Name of the operation.

6621

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6622

"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.

6623

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6624

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6625

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

6626

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6627

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6628

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6629

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6630

"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.

6631

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6632

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6633

{

6634

"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.

6635

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6636

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6637

{

6638

"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).

6639

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6640

},

6641

],

6642

"message": "A String", # [Output Only] A human-readable description of the warning code.

6643

},

6644

],

6645

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

6649

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6650

<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]

6651

<pre>Updates an instance's network interface. This method follows PATCH semantics.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

6652

6653

Args:

6654

project: string, Project ID for this request. (required)

6655

zone: string, The name of the zone for this request. (required)

6656

instance: string, The instance name for this request. (required)

6657

networkInterface: string, The name of the network interface to update. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6658

body: object, The request body.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

6659

The object takes the form of:

6660

6661

{ # A network interface resource attached to an instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6662

"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.

6663

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

6664

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

6665

"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.

6666

"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.

6667

"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]

6668

#

6669

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

6670

#

6671

# 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]

6672

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

6673

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

6674

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

6675

"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.

6676

"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]

6677

},

6678

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6679

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

6680

{ # An alias IP range attached to an instance's network interface.

6681

"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).

6682

"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.

6683

},

6684

],

6685

"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.

6686

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

6687

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

6688

"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.

6689

"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.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

6690

#

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

6691

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

6692

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

6693

# - projects/project/global/networks/network

6694

# - global/networks/default

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6695

"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.

6696

"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:

6697

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

6698

# - regions/region/subnetworks/subnetwork

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

6699

}

6700

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6701

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.

6702

6703

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.

6704

6705

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]

6706

6707

Returns:

6708

An object of the form:

6709

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6710

{ # Represents an Operation resource.

6711

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6712

# Google Compute Engine has three Operation resources:

6713

#

6714

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6715

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6716

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6717

#

6718

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6719

# - For global operations, use the `globalOperations` resource.

6720

# - For regional operations, use the `regionOperations` resource.

6721

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6722

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6723

# 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]

6724

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6725

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6726

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6727

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6728

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6729

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6730

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6731

"code": "A String", # [Output Only] The error type identifier for this error.

6732

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6733

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6734

},

6735

],

6736

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6737

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6738

"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.

6739

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6740

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6741

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6742

"name": "A String", # [Output Only] Name of the operation.

6743

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6744

"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.

6745

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6746

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6747

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

6748

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6749

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6750

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6751

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6752

"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.

6753

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6754

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6755

{

6756

"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.

6757

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6758

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6759

{

6760

"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).

6761

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6762

},

6763

],

6764

"message": "A String", # [Output Only] A human-readable description of the warning code.

6765

},

6766

],

6767

"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]

6772

<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]

6773

<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.

6774

6775

Args:

6776

project: string, Project ID for this request. (required)

6777

zone: string, The name of the zone for this request. (required)

6778

instance: string, Name or id of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6779

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6780

The object takes the form of:

6781

6782

{ # A set of Shielded Instance options.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6783

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

6784

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

6785

"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]

6786

}

6787

6788

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.

6789

6790

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.

6791

6792

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

6793

6794

Returns:

6795

An object of the form:

6796

6797

{ # Represents an Operation resource.

6798

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6799

# Google Compute Engine has three Operation resources:

6800

#

6801

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6802

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6803

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6804

#

6805

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6806

# - For global operations, use the `globalOperations` resource.

6807

# - For regional operations, use the `regionOperations` resource.

6808

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6809

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6810

# 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]

6811

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6812

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6813

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6814

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6815

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6816

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6817

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6818

"code": "A String", # [Output Only] The error type identifier for this error.

6819

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6820

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6821

},

6822

],

6823

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6824

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6825

"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.

6826

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6827

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6828

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6829

"name": "A String", # [Output Only] Name of the operation.

6830

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6831

"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.

6832

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6833

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6834

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

6835

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6836

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6837

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6838

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6839

"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.

6840

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6841

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6842

{

6843

"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.

6844

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6845

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6846

{

6847

"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).

6848

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6849

},

6850

],

6851

"message": "A String", # [Output Only] A human-readable description of the warning code.

6852

},

6853

],

6854

"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]

6859

<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]

6860

<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.

6861

6862

Args:

6863

project: string, Project ID for this request. (required)

6864

zone: string, The name of the zone for this request. (required)

6865

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6866

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6867

The object takes the form of:

6868

6869

{ # A set of Shielded VM options.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6870

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

6871

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

6872

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6873

}

6874

6875

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.

6876

6877

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.

6878

6879

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

6880

6881

Returns:

6882

An object of the form:

6883

6884

{ # Represents an Operation resource.

6885

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6886

# Google Compute Engine has three Operation resources:

6887

#

6888

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6889

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6890

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6891

#

6892

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6893

# - For global operations, use the `globalOperations` resource.

6894

# - For regional operations, use the `regionOperations` resource.

6895

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6896

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6897

# 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]

6898

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6899

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6900

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6901

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6902

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6903

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

6904

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6905

"code": "A String", # [Output Only] The error type identifier for this error.

6906

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6907

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

6908

},

6909

],

6910

},

Bu Sun Kim