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

Dmitry Frenkel

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

[diff] [blame]

96

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

97

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

98

Sai Cheemalapati

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

[diff] [blame]

99

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

Sai Cheemalapati

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

[diff] [blame]

100

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

101

Sai Cheemalapati

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

[diff] [blame]

102

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

103

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

104

Sai Cheemalapati

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

[diff] [blame]

105

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

106

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

107

108

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

Bu Sun Kim

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

[diff] [blame]

109

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

110

111

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

112

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

113

Bu Sun Kim

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

[diff] [blame]

114

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

115

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

Sai Cheemalapati

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

[diff] [blame]

116

Dan O'Meara

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

[diff] [blame]

117

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

Sai Cheemalapati

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

[diff] [blame]

118

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

119

Dan O'Meara

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

[diff] [blame]

120

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

121

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

122

Bu Sun Kim

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

[diff] [blame]

123

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

124

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

125

Bu Sun Kim

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

[diff] [blame]

126

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

127

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

128

129

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

130

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

131

Bu Sun Kim

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

[diff] [blame]

132

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

133

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

134

Bu Sun Kim

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

[diff] [blame]

135

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

136

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

137

Bu Sun Kim

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

[diff] [blame]

138

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

Bu Sun Kim

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

[diff] [blame^]

139

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

Sai Cheemalapati

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

[diff] [blame]

140

141

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

142

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

143

Sai Cheemalapati

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

[diff] [blame]

144

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

145

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

146

Dan O'Meara

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

[diff] [blame]

147

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

148

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

149

Sai Cheemalapati

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

[diff] [blame]

150

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

151

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

152

Dan O'Meara

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

[diff] [blame]

153

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

154

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

155

156

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

157

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

Sai Cheemalapati

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

[diff] [blame]

158

Sai Cheemalapati

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

[diff] [blame]

159

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

160

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

161

Dan O'Meara

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

[diff] [blame]

162

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

Sai Cheemalapati

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

[diff] [blame]

163

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

164

Dan O'Meara

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

[diff] [blame]

165

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

166

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

167

Dan O'Meara

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

[diff] [blame]

168

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

169

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

170

Dan O'Meara

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

[diff] [blame]

171

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

172

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

173

Dan O'Meara

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

[diff] [blame]

174

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

175

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

176

Dan O'Meara

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

[diff] [blame]

177

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

178

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

179

Dan O'Meara

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

[diff] [blame]

180

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

181

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

Sai Cheemalapati

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

[diff] [blame]

182

Dan O'Meara

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

[diff] [blame]

183

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

Bu Sun Kim

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

[diff] [blame]

184

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

Sai Cheemalapati

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

[diff] [blame]

185

Dan O'Meara

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

[diff] [blame]

186

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

187

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

188

Dan O'Meara

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

[diff] [blame]

189

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

190

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

191

Dan O'Meara

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

[diff] [blame]

192

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

193

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

194

Dan O'Meara

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

[diff] [blame]

195

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

196

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

197

Sai Cheemalapati

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

[diff] [blame]

198

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

199

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

200

201

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

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

Dan O'Meara

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

[diff] [blame]

204

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

205

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

206

Sai Cheemalapati

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

[diff] [blame]

207

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

208

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

209

Sai Cheemalapati

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

[diff] [blame]

210

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

211

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

212

Dan O'Meara

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

[diff] [blame]

213

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

Sai Cheemalapati

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

[diff] [blame]

214

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

215

Bu Sun Kim

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

[diff] [blame]

216

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

217

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

218

219

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

220

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

221

Dan O'Meara

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

[diff] [blame]

222

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

223

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

224

Dan O'Meara

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

[diff] [blame]

225

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

226

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

227

Dan O'Meara

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

[diff] [blame]

228

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

229

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

230

Dan O'Meara

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

[diff] [blame]

231

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

232

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

233

<h3>Method Details</h3>

234

Dan O'Meara

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

[diff] [blame]

235

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

236

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

Sai Cheemalapati

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

[diff] [blame]

237

238

Args:

239

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

240

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

241

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

242

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]

243

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

244

The object takes the form of:

245

Bu Sun Kim

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

[diff] [blame]

246

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

Bu Sun Kim

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

[diff] [blame^]

247

"externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.

248

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

Bu Sun Kim

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

[diff] [blame]

249

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

250

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

251

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

252

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

253

#

254

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

255

#

256

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

257

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

258

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

259

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

260

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

261

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

262

}

263

Bu Sun Kim

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

[diff] [blame]

264

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.

265

266

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.

267

268

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]

269

270

Returns:

271

An object of the form:

272

Bu Sun Kim

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

[diff] [blame]

273

{ # Represents an Operation resource.

274

#

Dan O'Meara

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

[diff] [blame]

275

# Google Compute Engine has three Operation resources:

276

#

277

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

278

#

Bu Sun Kim

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

[diff] [blame]

279

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

280

#

281

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

282

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

283

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

284

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

Bu Sun Kim

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

[diff] [blame]

285

#

Dan O'Meara

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

[diff] [blame]

286

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

287

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

288

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

289

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

290

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

291

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

292

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

Bu Sun Kim

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

[diff] [blame]

293

{

Bu Sun Kim

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

[diff] [blame]

294

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

295

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

296

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

Bu Sun Kim

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

[diff] [blame]

297

},

298

],

299

},

Bu Sun Kim

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

[diff] [blame]

300

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

301

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

302

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

303

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

304

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

305

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

306

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

307

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

308

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

309

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

310

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

311

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

312

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

313

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

314

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

315

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

316

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

317

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

318

{

319

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

320

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

321

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

322

{

323

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

324

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

325

},

326

],

327

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

328

},

329

],

330

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

335

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

336

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

337

338

Args:

339

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

340

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

341

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

Dan O'Meara

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

[diff] [blame]

342

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

343

The object takes the form of:

344

345

{

Bu Sun Kim

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

[diff] [blame]

346

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

347

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

352

353

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.

354

355

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

356

357

Returns:

358

An object of the form:

359

360

{ # Represents an Operation resource.

361

#

Dan O'Meara

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

[diff] [blame]

362

# Google Compute Engine has three Operation resources:

363

#

364

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

365

#

Bu Sun Kim

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

[diff] [blame]

366

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

367

#

368

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

369

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

370

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

371

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

Bu Sun Kim

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

[diff] [blame]

372

#

Dan O'Meara

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

[diff] [blame]

373

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

374

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

375

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

376

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

377

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

378

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

379

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

Sai Cheemalapati

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

[diff] [blame]

380

{

Bu Sun Kim

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

[diff] [blame]

381

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

382

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

383

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

Sai Cheemalapati

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

[diff] [blame]

384

},

385

],

386

},

Bu Sun Kim

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

[diff] [blame]

387

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

388

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

389

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

390

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

391

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

392

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

393

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

394

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

395

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

396

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

397

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

398

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

399

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

400

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

401

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

402

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

403

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

404

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

405

{

406

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

407

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

408

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

409

{

410

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

411

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

412

},

413

],

414

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

415

},

416

],

417

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

422

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

423

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

424

425

Args:

426

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

Dan O'Meara

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

[diff] [blame]

427

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]

428

Dan O'Meara

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

[diff] [blame]

429

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]

430

Dan O'Meara

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

[diff] [blame]

431

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]

432

Bu Sun Kim

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

[diff] [blame]

433

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]

434

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]

435

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

436

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

437

438

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.

439

440

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

441

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.

442

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]

443

444

Returns:

445

An object of the form:

446

447

{

Bu Sun Kim

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

[diff] [blame]

448

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

449

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

450

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

451

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

Bu Sun Kim

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

[diff] [blame]

452

{ # Represents an Instance resource.

453

#

Dan O'Meara

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

[diff] [blame]

454

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

Dmitry Frenkel

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

[diff] [blame]

455

"advancedMachineFeatures": { # Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of an Image (e.g., whether or not the OS in the Image supports nested virtualization being enabled or disabled). # Controls for advanced machine-related behavior features.

456

"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).

457

"threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.

458

},

Bu Sun Kim

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

[diff] [blame]

459

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

460

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

461

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

462

},

Bu Sun Kim

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

[diff] [blame]

463

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

464

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

465

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

466

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

467

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

468

{ # An instance-attached disk resource.

Bu Sun Kim

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

[diff] [blame]

469

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

470

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

471

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

472

#

473

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

Dmitry Frenkel

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

[diff] [blame]

474

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

Sai Cheemalapati

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

[diff] [blame]

475

#

476

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

477

#

478

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

479

#

480

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

481

#

482

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

483

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

484

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

485

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

486

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

487

#

488

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

489

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

490

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

491

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

Bu Sun Kim

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

[diff] [blame]

492

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

493

},

Bu Sun Kim

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

[diff] [blame]

494

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

Bu Sun Kim

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

[diff] [blame^]

495

"forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error.

Bu Sun Kim

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

[diff] [blame]

496

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

497

{ # Guest OS features.

498

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

499

},

500

],

501

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

502

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

503

#

504

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

505

#

506

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

507

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

508

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

509

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

510

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

511

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

512

#

Bu Sun Kim

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

[diff] [blame]

513

#

Sai Cheemalapati

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

[diff] [blame]

514

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

515

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

516

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

517

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

518

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

519

#

520

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

521

{ # Guest OS features.

Bu Sun Kim

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

[diff] [blame]

522

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

523

},

524

],

Bu Sun Kim

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

[diff] [blame]

525

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

526

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

527

},

Bu Sun Kim

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

[diff] [blame]

528

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

Bu Sun Kim

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

[diff] [blame]

529

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

Dmitry Frenkel

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

[diff] [blame]

530

"provisionedIops": "A String", # Indicates how many IOPS must be provisioned for the disk.

Bu Sun Kim

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

[diff] [blame]

531

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

532

"A String",

533

],

534

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

535

"A String",

536

],

537

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

538

#

Bu Sun Kim

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

[diff] [blame]

539

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

540

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

Sai Cheemalapati

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

[diff] [blame]

541

#

Sai Cheemalapati

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

[diff] [blame]

542

#

543

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

Bu Sun Kim

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

[diff] [blame]

544

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

Sai Cheemalapati

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

[diff] [blame]

545

#

Sai Cheemalapati

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

[diff] [blame]

546

#

Bu Sun Kim

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

[diff] [blame]

547

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

548

# global/images/my-custom-image

Sai Cheemalapati

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

[diff] [blame]

549

#

Sai Cheemalapati

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

[diff] [blame]

550

#

Bu Sun Kim

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

[diff] [blame]

551

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

552

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

Sai Cheemalapati

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

[diff] [blame]

553

#

Jon Wayne Parrott

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

[diff] [blame]

554

#

555

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

Dmitry Frenkel

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

[diff] [blame]

556

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

Bu Sun Kim

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

[diff] [blame]

557

#

558

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

559

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

560

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

561

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

562

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

563

#

564

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

565

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

566

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

567

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

568

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

569

},

570

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

571

#

572

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

573

# global/snapshots/my-backup

574

#

575

#

576

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

Dmitry Frenkel

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

[diff] [blame]

577

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

Bu Sun Kim

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

[diff] [blame]

578

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

579

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

580

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

581

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

582

#

583

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

584

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

585

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

586

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

587

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

588

},

589

},

Bu Sun Kim

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

[diff] [blame]

590

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

591

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

592

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

593

"A String",

594

],

595

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

596

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

597

"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

598

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

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

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

605

{

606

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

607

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

608

},

609

],

610

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

611

{

612

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

613

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

614

},

615

],

616

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

617

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

618

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

Bu Sun Kim

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

[diff] [blame]

619

},

Bu Sun Kim

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

[diff] [blame]

620

},

621

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

622

#

623

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

624

#

625

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

626

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

Bu Sun Kim

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

[diff] [blame^]

627

"userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of URLs to the license resource. Unlike regular licenses, user provided licenses can be modified after the disk is created.

628

"A String",

629

],

Sai Cheemalapati

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

[diff] [blame]

630

},

631

],

Bu Sun Kim

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

[diff] [blame]

632

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

633

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

Dan O'Meara

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

[diff] [blame]

634

},

Bu Sun Kim

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

[diff] [blame]

635

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

636

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

637

#

638

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

639

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

640

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

641

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

642

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

643

},

644

],

645

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

646

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

Dmitry Frenkel

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

[diff] [blame]

647

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

Bu Sun Kim

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

[diff] [blame]

648

#

649

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

650

#

651

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

652

#

653

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

654

#

655

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

656

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

657

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

658

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

659

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

660

#

661

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

662

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

663

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

664

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

665

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

666

},

667

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

668

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

669

#

670

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

671

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

672

"a_key": "A String",

673

},

Bu Sun Kim

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

[diff] [blame]

674

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

675

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

676

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

Bu Sun Kim

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

[diff] [blame]

677

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

678

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

679

#

680

#

681

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

682

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

683

#

684

#

685

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

686

#

687

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

688

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

689

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

690

#

691

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

692

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

693

{

694

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

695

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

696

},

697

],

698

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

699

},

700

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

701

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

702

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

703

{ # A network interface resource attached to an instance.

704

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

705

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

Bu Sun Kim

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

[diff] [blame^]

706

"externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.

707

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

Bu Sun Kim

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

[diff] [blame]

708

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

709

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

710

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

711

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

712

#

713

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

714

#

715

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

716

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

717

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

718

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

719

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

720

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

721

},

722

],

723

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

724

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

725

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

726

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

727

},

728

],

729

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

Bu Sun Kim

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

[diff] [blame^]

730

"internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range.

731

"ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.

732

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

733

"externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.

734

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

735

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

736

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

737

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

738

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

739

#

740

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

741

#

742

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

743

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

744

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

745

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

746

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

747

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

748

},

749

],

Bu Sun Kim

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

[diff] [blame]

750

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

751

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

752

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

753

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

754

#

755

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

756

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

757

# - projects/project/global/networks/network

758

# - global/networks/default

759

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

Bu Sun Kim

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

[diff] [blame^]

760

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

761

"queueCount": 42, # The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.

762

"stackType": "A String", # The stack type for this network interface to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used.

763

#

764

# This field can be both set at instance creation and update network interface operations.

Bu Sun Kim

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

[diff] [blame]

765

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

766

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

767

# - regions/region/subnetworks/subnetwork

768

},

769

],

Dmitry Frenkel

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

[diff] [blame]

770

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.

Bu Sun Kim

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

[diff] [blame]

771

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

772

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

773

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

774

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

775

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

776

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

"A String",

],

},

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

781

"A String",

782

],

Dmitry Frenkel

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

[diff] [blame]

783

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

784

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

Bu Sun Kim

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

[diff] [blame]

785

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

786

#

787

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

788

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

789

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

Bu Sun Kim

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

[diff] [blame]

790

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after instance creation where the instance won't be scheduled for maintenance.

Bu Sun Kim

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

[diff] [blame^]

791

"maintenanceInterval": "A String", # Specifies whether this VM may be a stable fleet VM. Setting this to "Periodic" designates this VM as a Stable Fleet VM.

792

#

793

# See go/stable-fleet-ug for more details.

Bu Sun Kim

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

[diff] [blame]

794

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

795

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

796

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

797

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

798

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

799

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

"A String",

],

},

],

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

Bu Sun Kim

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

[diff] [blame]

805

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

Bu Sun Kim

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

[diff] [blame]

806

},

Dmitry Frenkel

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

[diff] [blame]

807

"secureLabels": [ # Secure labels to apply to this instance. These can be later modified by the update method. Maximum number of secure labels allowed is 300.

808

"A String",

809

],

Bu Sun Kim

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

[diff] [blame]

810

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

811

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

812

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

813

#

814

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

815

{ # A service account.

816

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

817

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

"A String",

],

},

],

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

823

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

824

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

825

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

826

},

827

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

828

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

829

},

Dmitry Frenkel

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

[diff] [blame]

830

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

Bu Sun Kim

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

[diff] [blame]

831

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

832

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

833

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

834

},

Dmitry Frenkel

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

[diff] [blame]

835

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

Bu Sun Kim

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

[diff] [blame]

836

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

837

},

838

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

Dmitry Frenkel

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

[diff] [blame]

839

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

Bu Sun Kim

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

[diff] [blame]

840

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

841

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

842

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

843

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

844

#

845

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

846

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

847

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

848

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

849

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

850

},

851

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

Bu Sun Kim

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

[diff] [blame^]

852

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

Bu Sun Kim

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

[diff] [blame]

853

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

854

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

855

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

856

#

857

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

858

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

Dmitry Frenkel

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

[diff] [blame]

863

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

864

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

Bu Sun Kim

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

[diff] [blame]

865

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

866

},

867

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

868

},

869

],

Bu Sun Kim

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

[diff] [blame]

870

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

871

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

872

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

873

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

Sai Cheemalapati

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

[diff] [blame]

874

{

Bu Sun Kim

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

[diff] [blame]

875

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

876

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

Sai Cheemalapati

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

[diff] [blame]

877

},

878

],

Bu Sun Kim

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

[diff] [blame]

879

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

Sai Cheemalapati

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

[diff] [blame]

880

},

881

},

882

},

Bu Sun Kim

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

[diff] [blame]

883

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

884

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

885

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

886

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

887

"A String",

888

],

889

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

890

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

891

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

892

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

Bu Sun Kim

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

[diff] [blame]

893

{

Bu Sun Kim

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

[diff] [blame]

894

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

895

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

896

},

897

],

Bu Sun Kim

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

[diff] [blame]

898

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

899

},

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>

905

<pre>Retrieves the next page of results.

906

907

Args:

908

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

909

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

910

911

Returns:

Bu Sun Kim

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

[diff] [blame]

912

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

Sai Cheemalapati

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

[diff] [blame]

913

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]

918

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

919

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

920

921

Args:

922

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

923

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

924

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

Dan O'Meara

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

[diff] [blame]

925

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

926

The object takes the form of:

927

928

{ # An instance-attached disk resource.

Bu Sun Kim

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

[diff] [blame]

929

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

930

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

931

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

932

#

933

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

Dmitry Frenkel

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

[diff] [blame]

934

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

Sai Cheemalapati

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

[diff] [blame]

935

#

936

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

937

#

938

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

939

#

940

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

941

#

942

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

943

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

944

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

945

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

946

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

947

#

948

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

949

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

950

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

951

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

Bu Sun Kim

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

[diff] [blame]

952

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

953

},

Bu Sun Kim

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

[diff] [blame]

954

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

Bu Sun Kim

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

[diff] [blame^]

955

"forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error.

Bu Sun Kim

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

[diff] [blame]

956

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

957

{ # Guest OS features.

958

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

959

},

960

],

961

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

962

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

963

#

964

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

965

#

966

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

967

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

968

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

969

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

970

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

971

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

972

#

Bu Sun Kim

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

[diff] [blame]

973

#

Sai Cheemalapati

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

[diff] [blame]

974

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

975

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

976

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

977

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

978

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

979

#

980

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

981

{ # Guest OS features.

Bu Sun Kim

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

[diff] [blame]

982

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

983

},

984

],

Bu Sun Kim

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

[diff] [blame]

985

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

986

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

987

},

Bu Sun Kim

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

[diff] [blame]

988

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

Bu Sun Kim

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

[diff] [blame]

989

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

Dmitry Frenkel

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

[diff] [blame]

990

"provisionedIops": "A String", # Indicates how many IOPS must be provisioned for the disk.

Bu Sun Kim

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

[diff] [blame]

991

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

992

"A String",

993

],

994

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

995

"A String",

996

],

997

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

998

#

Bu Sun Kim

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

[diff] [blame]

999

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

1000

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

Sai Cheemalapati

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

[diff] [blame]

1001

#

Sai Cheemalapati

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

[diff] [blame]

1002

#

1003

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

Bu Sun Kim

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

[diff] [blame]

1004

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

Sai Cheemalapati

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

[diff] [blame]

1005

#

Sai Cheemalapati

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

[diff] [blame]

1006

#

Bu Sun Kim

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

[diff] [blame]

1007

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

1008

# global/images/my-custom-image

Sai Cheemalapati

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

[diff] [blame]

1009

#

Sai Cheemalapati

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

[diff] [blame]

1010

#

Bu Sun Kim

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

[diff] [blame]

1011

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

1012

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

Sai Cheemalapati

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

[diff] [blame]

1013

#

Jon Wayne Parrott

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

[diff] [blame]

1014

#

1015

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

Dmitry Frenkel

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

[diff] [blame]

1016

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

Bu Sun Kim

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

[diff] [blame]

1017

#

1018

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

1019

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

1020

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

1021

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

1022

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

1023

#

1024

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

1025

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

1026

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

1027

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

1028

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

1029

},

1030

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

1031

#

1032

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

1033

# global/snapshots/my-backup

1034

#

1035

#

1036

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

Dmitry Frenkel

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

[diff] [blame]

1037

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

Bu Sun Kim

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

[diff] [blame]

1038

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

1039

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

1040

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

1041

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

1042

#

1043

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

1044

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

1045

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

1046

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

1047

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

1048

},

1049

},

Bu Sun Kim

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

[diff] [blame]

1050

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

1051

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

1052

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

1053

"A String",

1054

],

1055

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

1056

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

1057

"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

1058

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

1059

{

1060

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

1061

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

1062

},

1063

],

1064

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

1065

{

1066

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

1067

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

1068

},

1069

],

1070

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

1071

{

1072

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

1073

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

1074

},

1075

],

1076

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

1077

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

1078

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

Bu Sun Kim

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

[diff] [blame]

1079

},

Bu Sun Kim

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

[diff] [blame]

1080

},

1081

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

1082

#

1083

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

1084

#

1085

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

1086

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

Bu Sun Kim

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

[diff] [blame^]

1087

"userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of URLs to the license resource. Unlike regular licenses, user provided licenses can be modified after the disk is created.

1088

"A String",

1089

],

Sai Cheemalapati

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

[diff] [blame]

1090

}

1091

Dmitry Frenkel

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

[diff] [blame]

1092

forceAttach: boolean, Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error.

Bu Sun Kim

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

[diff] [blame]

1093

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.

1094

1095

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.

1096

1097

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]

1098

1099

Returns:

1100

An object of the form:

1101

Bu Sun Kim

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

[diff] [blame]

1102

{ # Represents an Operation resource.

1103

#

Dan O'Meara

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

[diff] [blame]

1104

# Google Compute Engine has three Operation resources:

1105

#

1106

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

1107

#

Bu Sun Kim

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

[diff] [blame]

1108

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

1109

#

1110

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

1111

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

1112

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

1113

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1114

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1115

# 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]

1116

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1117

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1118

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1119

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1120

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1121

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1122

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1123

"code": "A String", # [Output Only] The error type identifier for this error.

1124

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1125

"message": "A String", # [Output Only] An optional, human-readable error message.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1126

},

1127

],

1128

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1129

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1130

"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.

1131

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

1132

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1133

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1134

"name": "A String", # [Output Only] Name of the operation.

1135

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1136

"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.

1137

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

1138

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1139

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1140

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1141

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

1142

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1143

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1144

"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.

1145

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1146

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1147

{

1148

"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.

1149

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1150

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

1151

{

1152

"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).

1153

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1154

},

1155

],

1156

"message": "A String", # [Output Only] A human-readable description of the warning code.

1157

},

1158

],

1159

"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>

1165

<pre>Creates multiple instances. Count specifies the number of instances to create.

1166

1167

Args:

1168

project: string, Project ID for this request. (required)

1169

zone: string, The name of the zone for this request. (required)

1170

body: object, The request body.

1171

The object takes the form of:

1172

1173

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1174

"count": "A String", # The maximum number of instances to create.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1175

"instance": { # Represents an Instance resource. # The instance defining the VM instances to be created.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1176

#

1177

# 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 ==)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1178

"advancedMachineFeatures": { # Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of an Image (e.g., whether or not the OS in the Image supports nested virtualization being enabled or disabled). # Controls for advanced machine-related behavior features.

1179

"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).

1180

"threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.

1181

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1182

"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.

1183

"confidentialInstanceConfig": { # A set of Confidential Instance options.

1184

"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]

1185

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1186

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

1187

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

1188

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

1189

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

1190

"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]

1191

{ # An instance-attached disk resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1192

"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).

1193

"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.

1194

"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.

1195

#

1196

# If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1197

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1198

#

1199

# 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.

1200

#

1201

# 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.

1202

#

1203

# 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.

1204

#

1205

# 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]

1206

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1207

"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.

1208

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1209

"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]

1210

#

1211

# The key must meet the following requirements before you can provide it to Compute Engine:

1212

# - The key is wrapped using a RSA public key certificate provided by Google.

1213

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1214

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1215

"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]

1216

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1217

"diskSizeGb": "A String", # The size of the disk in GB.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1218

"forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1219

"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.

1220

{ # Guest OS features.

1221

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

1222

},

1223

],

1224

"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.

1225

"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]

1226

#

1227

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

1228

#

1229

# 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]

1230

"description": "A String", # An optional description. Provide this property when creating the disk.

1231

"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.

1232

"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.

1233

"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]

1234

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

1235

#

1236

#

1237

# 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:

1238

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType

1239

# - projects/project/zones/zone/diskTypes/diskType

1240

# - 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]

1241

"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]

1242

#

1243

# Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

1244

{ # Guest OS features.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1245

"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]

1246

},

1247

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1248

"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.

1249

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1250

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1251

"multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1252

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1253

"provisionedIops": "A String", # Indicates how many IOPS must be provisioned for the disk.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1254

"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

1255

"A String",

1256

],

1257

"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.

1258

"A String",

1259

],

1260

"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]

1261

#

1262

# 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:

1263

# projects/debian-cloud/global/images/family/debian-9

1264

#

1265

#

1266

# Alternatively, use a specific version of a public operating system image:

1267

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

1268

#

1269

#

1270

# To create a disk with a custom image that you created, specify the image name in the following format:

1271

# global/images/my-custom-image

1272

#

1273

#

1274

# 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:

1275

# global/images/family/my-image-family

1276

#

1277

#

1278

# If the source image is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1279

"sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1280

#

1281

# 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.

1282

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1283

"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.

1284

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1285

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

1286

#

1287

# The key must meet the following requirements before you can provide it to Compute Engine:

1288

# - The key is wrapped using a RSA public key certificate provided by Google.

1289

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1290

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1291

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

1292

},

1293

"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.

1294

#

1295

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

1296

# global/snapshots/my-backup

1297

#

1298

#

1299

# If the source snapshot is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1300

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1301

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1302

"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.

1303

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1304

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

1305

#

1306

# The key must meet the following requirements before you can provide it to Compute Engine:

1307

# - The key is wrapped using a RSA public key certificate provided by Google.

1308

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1309

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1310

"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]

1311

},

1312

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1313

"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.

1314

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

1315

"licenses": [ # [Output Only] Any valid publicly visible licenses.

1316

"A String",

1317

],

1318

"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.

1319

"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.

1320

"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

1321

"dbs": [ # The Key Database (db).

1322

{

1323

"content": "A String", # The raw content in the secure keys file.

1324

"fileType": "A String", # The file type of source file.

1325

},

1326

],

1327

"dbxs": [ # The forbidden key database (dbx).

1328

{

1329

"content": "A String", # The raw content in the secure keys file.

1330

"fileType": "A String", # The file type of source file.

1331

},

1332

],

1333

"keks": [ # The Key Exchange Key (KEK).

1334

{

1335

"content": "A String", # The raw content in the secure keys file.

1336

"fileType": "A String", # The file type of source file.

1337

},

1338

],

1339

"pk": { # The Platform Key (PK).

1340

"content": "A String", # The raw content in the secure keys file.

1341

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1342

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1343

},

1344

"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]

1345

#

1346

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

1347

#

1348

# 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]

1349

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1350

"userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of URLs to the license resource. Unlike regular licenses, user provided licenses can be modified after the disk is created.

1351

"A String",

1352

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1353

},

1354

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1355

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

1356

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1357

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1358

"eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.

1359

"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.

1360

#

1361

# To see the latest fingerprint, make get() request to the instance.

1362

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

1363

{ # A specification of the type and number of accelerator cards attached to the instance.

1364

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

1365

"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.

1366

},

1367

],

1368

"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.

1369

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1370

"instanceEncryptionKey": { # Encrypts or decrypts data for an instance with a customer-supplied encryption key.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1371

#

1372

# 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.

1373

#

1374

# 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.

1375

#

1376

# 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.

1377

#

1378

# 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.

1379

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1380

"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.

1381

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1382

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

1383

#

1384

# The key must meet the following requirements before you can provide it to Compute Engine:

1385

# - The key is wrapped using a RSA public key certificate provided by Google.

1386

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1387

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1388

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

1389

},

1390

"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.

1391

"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.

1392

#

1393

# To see the latest fingerprint, make get() request to the instance.

1394

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

1395

"a_key": "A String",

1396

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1397

"lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format.

1398

"lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format.

1399

"lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1400

"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:

1401

# zones/us-central1-f/machineTypes/n1-standard-1

1402

#

1403

#

1404

# 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):

1405

# zones/zone/machineTypes/custom-CPUS-MEMORY

1406

#

1407

#

1408

# For example: zones/us-central1-f/machineTypes/custom-4-5120

1409

#

1410

# For a full list of restrictions, read the Specifications for custom machine types.

1411

"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

1412

"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.

1413

#

1414

# To see the latest fingerprint, make a get() request to retrieve the resource.

1415

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

1416

{

1417

"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.

1418

"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).

1419

},

1420

],

1421

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

1422

},

1423

"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".

1424

"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.

1425

"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.

1426

{ # A network interface resource attached to an instance.

1427

"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.

1428

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1429

"externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.

1430

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1431

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

1432

"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.

1433

"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.

1434

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

1435

#

1436

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

1437

#

1438

# 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.

1439

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

1440

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

1441

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

1442

"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.

1443

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

1444

},

1445

],

1446

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

1447

{ # An alias IP range attached to an instance's network interface.

1448

"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).

1449

"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.

1450

},

1451

],

1452

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1453

"internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range.

1454

"ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.

1455

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

1456

"externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.

1457

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

1458

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

1459

"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.

1460

"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.

1461

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

1462

#

1463

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

1464

#

1465

# 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.

1466

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

1467

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

1468

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

1469

"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.

1470

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

1471

},

1472

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1473

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

1474

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

1475

"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.

1476

"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.

1477

#

1478

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

1479

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

1480

# - projects/project/global/networks/network

1481

# - global/networks/default

1482

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1483

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

1484

"queueCount": 42, # The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.

1485

"stackType": "A String", # The stack type for this network interface to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used.

1486

#

1487

# This field can be both set at instance creation and update network interface operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1488

"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:

1489

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

1490

# - regions/region/subnetworks/subnetwork

1491

},

1492

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1493

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1494

"preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api.

1495

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.

1496

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.

1497

"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.

1498

"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.

1499

"values": [ # Corresponds to the label values of a reservation resource.

"A String",

],

},

"resourcePolicies": [ # Resource policies applied to this instance.

1504

"A String",

1505

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1506

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

1507

"scheduling": { # Sets the scheduling options for an Instance. NextID: 13 # Sets the scheduling options for this instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1508

"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.

1509

#

1510

# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

1511

"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.

1512

"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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1513

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after instance creation where the instance won't be scheduled for maintenance.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1514

"maintenanceInterval": "A String", # Specifies whether this VM may be a stable fleet VM. Setting this to "Periodic" designates this VM as a Stable Fleet VM.

1515

#

1516

# See go/stable-fleet-ug for more details.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1517

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

1518

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

1519

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

1520

"key": "A String", # Corresponds to the label key of Node resource.

1521

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

1522

"values": [ # Corresponds to the label values of Node resource.

"A String",

],

},

],

"onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1528

"preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1529

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1530

"secureLabels": [ # Secure labels to apply to this instance. These can be later modified by the update method. Maximum number of secure labels allowed is 300.

1531

"A String",

1532

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1533

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

1534

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1535

"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

1536

#

1537

# 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.

1538

{ # A service account.

1539

"email": "A String", # Email address of the service account.

1540

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

1546

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

1547

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

1548

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

1549

},

1550

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

1551

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

1552

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1553

"shieldedVmConfig": { # A set of Shielded VM options. # Deprecating, please use shielded_instance_config.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1554

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

1555

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

1556

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

1557

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1558

"shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured. # Deprecating, please use shielded_instance_integrity_policy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1559

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

1560

},

1561

"sourceMachineImage": "A String", # Source machine image

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1562

"sourceMachineImageEncryptionKey": { # Source GMI encryption key when creating an instance from GMI.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1563

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1564

"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.

1565

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1566

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

1567

#

1568

# The key must meet the following requirements before you can provide it to Compute Engine:

1569

# - The key is wrapped using a RSA public key certificate provided by Google.

1570

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1571

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1572

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

1573

},

1574

"startRestricted": True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1575

"status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1576

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

1577

"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.

1578

"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.

1579

#

1580

# To see the latest fingerprint, make get() request to the instance.

1581

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1586

"date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use start_time_window instead.

1587

"time": "A String", # [Output Only] The time when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use start_time_window instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1588

"type": "A String", # Defines the type of maintenance.

1589

},

1590

"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]

1591

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1592

"instanceProperties": { # The instance properties defining the VM instances to be created. Required if sourceInstanceTemplate is not provided.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1593

"advancedMachineFeatures": { # Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of an Image (e.g., whether or not the OS in the Image supports nested virtualization being enabled or disabled). # Controls for advanced machine-related behavior features.

1594

"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).

1595

"threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.

1596

},

1597

"canIpForward": True or False, # Enables instances created based on these properties to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information.

1598

"confidentialInstanceConfig": { # A set of Confidential Instance options. # Specifies the Confidential Instance options.

1599

"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.

1600

},

1601

"description": "A String", # An optional text description for the instances that are created from these properties.

1602

"disks": [ # An array of disks that are associated with the instances that are created from these properties.

1603

{ # An instance-attached disk resource.

1604

"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).

1605

"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.

1606

"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.

1607

#

1608

# 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.

1609

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.

1610

#

1611

# 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.

1612

#

1613

# 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.

1614

#

1615

# 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.

1616

#

1617

# Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.

1618

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1619

"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.

1620

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1621

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

1622

#

1623

# The key must meet the following requirements before you can provide it to Compute Engine:

1624

# - The key is wrapped using a RSA public key certificate provided by Google.

1625

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1626

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1627

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

1628

},

1629

"diskSizeGb": "A String", # The size of the disk in GB.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1630

"forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1631

"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.

1632

{ # Guest OS features.

1633

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

1634

},

1635

],

1636

"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.

1637

"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.

1638

#

1639

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

1640

#

1641

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

1642

"description": "A String", # An optional description. Provide this property when creating the disk.

1643

"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.

1644

"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.

1645

"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:

1646

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

1647

#

1648

#

1649

# 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:

1650

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType

1651

# - projects/project/zones/zone/diskTypes/diskType

1652

# - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.

1653

"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.

1654

#

1655

# Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

1656

{ # Guest OS features.

1657

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

1658

},

1659

],

1660

"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.

1661

"a_key": "A String",

1662

},

1663

"multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.

1664

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

1665

"provisionedIops": "A String", # Indicates how many IOPS must be provisioned for the disk.

1666

"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

1667

"A String",

1668

],

1669

"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.

1670

"A String",

1671

],

1672

"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.

1673

#

1674

# 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:

1675

# projects/debian-cloud/global/images/family/debian-9

1676

#

1677

#

1678

# Alternatively, use a specific version of a public operating system image:

1679

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

1680

#

1681

#

1682

# To create a disk with a custom image that you created, specify the image name in the following format:

1683

# global/images/my-custom-image

1684

#

1685

#

1686

# 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:

1687

# global/images/family/my-image-family

1688

#

1689

#

1690

# If the source image is deleted later, this field will not be set.

1691

"sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

1692

#

1693

# 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.

1694

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1695

"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.

1696

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1697

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

1698

#

1699

# The key must meet the following requirements before you can provide it to Compute Engine:

1700

# - The key is wrapped using a RSA public key certificate provided by Google.

1701

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1702

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1703

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

1704

},

1705

"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.

1706

#

1707

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

1708

# global/snapshots/my-backup

1709

#

1710

#

1711

# If the source snapshot is deleted later, this field will not be set.

1712

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

1713

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1714

"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.

1715

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1716

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

1717

#

1718

# The key must meet the following requirements before you can provide it to Compute Engine:

1719

# - The key is wrapped using a RSA public key certificate provided by Google.

1720

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1721

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1722

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

1723

},

1724

},

1725

"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.

1726

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

1727

"licenses": [ # [Output Only] Any valid publicly visible licenses.

1728

"A String",

1729

],

1730

"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.

1731

"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.

1732

"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

1733

"dbs": [ # The Key Database (db).

1734

{

1735

"content": "A String", # The raw content in the secure keys file.

1736

"fileType": "A String", # The file type of source file.

1737

},

1738

],

1739

"dbxs": [ # The forbidden key database (dbx).

1740

{

1741

"content": "A String", # The raw content in the secure keys file.

1742

"fileType": "A String", # The file type of source file.

1743

},

1744

],

1745

"keks": [ # The Key Exchange Key (KEK).

1746

{

1747

"content": "A String", # The raw content in the secure keys file.

1748

"fileType": "A String", # The file type of source file.

1749

},

1750

],

1751

"pk": { # The Platform Key (PK).

1752

"content": "A String", # The raw content in the secure keys file.

1753

"fileType": "A String", # The file type of source file.

1754

},

1755

},

1756

"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.

1757

#

1758

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

1759

#

1760

# Note that for InstanceTemplate, specify the disk name, not the URL for the disk.

1761

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1762

"userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of URLs to the license resource. Unlike regular licenses, user provided licenses can be modified after the disk is created.

1763

"A String",

1764

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1765

},

1766

],

1767

"displayDevice": { # A set of Display Device options # Display Device properties to enable support for remote display products like: Teradici, VNC and TeamViewer

1768

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

1769

},

1770

"guestAccelerators": [ # A list of guest accelerator cards' type and count to use for instances created from these properties.

1771

{ # A specification of the type and number of accelerator cards attached to the instance.

1772

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

1773

"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.

1774

},

1775

],

1776

"labels": { # Labels to apply to instances that are created from these properties.

1777

"a_key": "A String",

1778

},

1779

"machineType": "A String", # The machine type to use for instances that are created from these properties.

1780

"metadata": { # A metadata key/value entry. # The metadata key/value pairs to assign to instances that are created from these properties. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information.

1781

"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.

1782

#

1783

# To see the latest fingerprint, make a get() request to retrieve the resource.

1784

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

1785

{

1786

"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.

1787

"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).

1788

},

1789

],

1790

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

1791

},

1792

"minCpuPlatform": "A String", # Minimum cpu/platform to be used by instances. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". For more information, read Specifying a Minimum CPU Platform.

1793

"networkInterfaces": [ # An array of network access configurations for this interface.

1794

{ # A network interface resource attached to an instance.

1795

"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.

1796

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1797

"externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.

1798

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1799

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

1800

"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.

1801

"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.

1802

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

1803

#

1804

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

1805

#

1806

# 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.

1807

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

1808

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

1809

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

1810

"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.

1811

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

1812

},

1813

],

1814

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

1815

{ # An alias IP range attached to an instance's network interface.

1816

"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).

1817

"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.

1818

},

1819

],

1820

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1821

"internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range.

1822

"ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.

1823

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

1824

"externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.

1825

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

1826

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

1827

"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.

1828

"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.

1829

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

1830

#

1831

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

1832

#

1833

# 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.

1834

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

1835

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

1836

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

1837

"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.

1838

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

1839

},

1840

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1841

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

1842

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

1843

"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.

1844

"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.

1845

#

1846

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

1847

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

1848

# - projects/project/global/networks/network

1849

# - global/networks/default

1850

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1851

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

1852

"queueCount": 42, # The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.

1853

"stackType": "A String", # The stack type for this network interface to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used.

1854

#

1855

# This field can be both set at instance creation and update network interface operations.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1856

"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:

1857

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

1858

# - regions/region/subnetworks/subnetwork

1859

},

1860

],

1861

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.

1862

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for VMs. If not specified, use INHERIT_FROM_SUBNETWORK as default.

1863

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that instances can consume from.

1864

"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.

1865

"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.

1866

"values": [ # Corresponds to the label values of a reservation resource.

"A String",

],

},

"resourcePolicies": [ # Resource policies (names, not ULRs) applied to instances created from these properties.

1871

"A String",

1872

],

1873

"scheduling": { # Sets the scheduling options for an Instance. NextID: 13 # Specifies the scheduling options for the instances that are created from these properties.

1874

"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.

1875

#

1876

# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

1877

"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.

1878

"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.

1879

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after instance creation where the instance won't be scheduled for maintenance.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1880

"maintenanceInterval": "A String", # Specifies whether this VM may be a stable fleet VM. Setting this to "Periodic" designates this VM as a Stable Fleet VM.

1881

#

1882

# See go/stable-fleet-ug for more details.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1883

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

1884

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

1885

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

1886

"key": "A String", # Corresponds to the label key of Node resource.

1887

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

1888

"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.

1894

"preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.

1895

},

1896

"serviceAccounts": [ # A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from these properties. Use metadata queries to obtain the access tokens for these instances.

1897

{ # A service account.

1898

"email": "A String", # Email address of the service account.

1899

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

1905

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

1906

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

1907

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

1908

},

1909

"shieldedVmConfig": { # A set of Shielded VM options. # Specifies the Shielded VM options for the instances that are created from these properties.

1910

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

1911

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

1912

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

1913

},

1914

"tags": { # A set of instance tags. # A list of tags to apply to the instances that are created from these properties. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035.

1915

"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.

1916

#

1917

# To see the latest fingerprint, make get() request to the instance.

1918

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

"A String",

],

},

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1923

"locationPolicy": { # Configuration for location policy among multiple possible locations (e.g. preferences for zone selection among zones in a single region).

1924

"locations": { # Location configurations mapped by location name. Currently only zone names are supported and must be represented as valid internal URLs, like: zones/us-central1-a.

1925

"a_key": {

1926

"preference": "A String",

1927

},

1928

},

1929

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1930

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1931

"namePattern": "A String", # Instance name pattern. Name pattern includes a parameter to specify the auto-incrementing portion of the name, in a form of consecutive hash (#) chars, each of them corresponding to one digit of an instance name. For example: name_pattern = inst-####-prod will generate names starting with inst-0001-prod, inst-0002-prod, up to required count. If there exist instances matching the name pattern in the same project and zone, the initial instance number will be equal to the maximum existing instance number + 1 (e.g. if there exists an instance with name inst-0030-prod, then the generated names will start with inst-0031-prod). The name pattern placeholder #...# can contain up to 18 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1932

"predefinedNames": [ # List of predefined names. The number of names provided must be equal to count.

1933

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1934

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1935

"sourceInstanceTemplate": "A String", # Specifies the instance template from which to create instances. You may combine sourceInstanceTemplate with instanceProperties to override specific values from an existing instance template. Bulk API follows the semantics of JSON Merge Patch described by RFC 7396.

1936

#

1937

# It can be a full or partial URL. For example, the following are all valid URLs to an instance template:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1938

# - https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate

1939

# - projects/project/global/instanceTemplates/instanceTemplate

1940

# - global/instanceTemplates/instanceTemplate

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1941

#

1942

# This field is optional.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1943

}

1944

1945

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.

1946

1947

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.

1948

1949

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

1950

1951

Returns:

1952

An object of the form:

1953

1954

{ # Represents an Operation resource.

1955

#

1956

# Google Compute Engine has three Operation resources:

1957

#

1958

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

1959

#

1960

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

1961

#

1962

# Operations can be global, regional or zonal.

1963

# - For global operations, use the `globalOperations` resource.

1964

# - For regional operations, use the `regionOperations` resource.

1965

# - For zonal operations, use the `zonalOperations` resource.

1966

#

1967

# 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]

1968

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1969

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1970

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1971

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1972

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1973

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1974

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1975

"code": "A String", # [Output Only] The error type identifier for this error.

1976

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1977

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1978

},

1979

],

1980

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1981

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1982

"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.

1983

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

1984

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1985

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1986

"name": "A String", # [Output Only] Name of the operation.

1987

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1988

"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.

1989

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

1990

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1991

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1992

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1993

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

1994

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1995

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1996

"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.

1997

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1998

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1999

{

2000

"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.

2001

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2002

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2003

{

2004

"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).

2005

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2006

},

2007

],

2008

"message": "A String", # [Output Only] A human-readable description of the warning code.

2009

},

2010

],

2011

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2016

<code class="details" id="close">close()</code>

2017

<pre>Close httplib2 connections.</pre>

</div>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

2021

<code class="details" id="delete">delete(project, zone, instance, requestId=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2022

<pre>Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance.

2023

2024

Args:

2025

project: string, Project ID for this request. (required)

2026

zone: string, The name of the zone for this request. (required)

2027

instance: string, Name of the instance resource to delete. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2028

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.

2029

2030

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.

2031

2032

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]

2033

2034

Returns:

2035

An object of the form:

2036

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2037

{ # Represents an Operation resource.

2038

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2039

# Google Compute Engine has three Operation resources:

2040

#

2041

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2042

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2043

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2044

#

2045

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2046

# - For global operations, use the `globalOperations` resource.

2047

# - For regional operations, use the `regionOperations` resource.

2048

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2049

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2050

# 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]

2051

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2052

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2053

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2054

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2055

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2056

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2057

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2058

"code": "A String", # [Output Only] The error type identifier for this error.

2059

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2060

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2061

},

2062

],

2063

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2064

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2065

"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.

2066

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2067

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2068

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2069

"name": "A String", # [Output Only] Name of the operation.

2070

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2071

"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.

2072

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2073

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2074

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2075

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2076

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2077

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2078

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2079

"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.

2080

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2081

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2082

{

2083

"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.

2084

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2085

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2086

{

2087

"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).

2088

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2089

},

2090

],

2091

"message": "A String", # [Output Only] A human-readable description of the warning code.

2092

},

2093

],

2094

"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]

2099

<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]

2100

<pre>Deletes an access config from an instance's network interface.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2101

2102

Args:

2103

project: string, Project ID for this request. (required)

2104

zone: string, The name of the zone for this request. (required)

2105

instance: string, The instance name for this request. (required)

2106

accessConfig: string, The name of the access config to delete. (required)

2107

networkInterface: string, The name of the network interface. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2108

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.

2109

2110

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.

2111

2112

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]

2113

2114

Returns:

2115

An object of the form:

2116

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2117

{ # Represents an Operation resource.

2118

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2119

# Google Compute Engine has three Operation resources:

2120

#

2121

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2122

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2123

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2124

#

2125

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2126

# - For global operations, use the `globalOperations` resource.

2127

# - For regional operations, use the `regionOperations` resource.

2128

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2129

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2130

# 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]

2131

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2132

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2133

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2134

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2135

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2136

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2137

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2138

"code": "A String", # [Output Only] The error type identifier for this error.

2139

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2140

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2141

},

2142

],

2143

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2144

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2145

"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.

2146

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2147

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2148

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2149

"name": "A String", # [Output Only] Name of the operation.

2150

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2151

"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.

2152

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2153

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2154

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2155

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2156

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2157

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2158

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2159

"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.

2160

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2161

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2162

{

2163

"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.

2164

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2165

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2166

{

2167

"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).

2168

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2169

},

2170

],

2171

"message": "A String", # [Output Only] A human-readable description of the warning code.

2172

},

2173

],

2174

"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]

2179

<code class="details" id="detachDisk">detachDisk(project, zone, instance, deviceName, requestId=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2180

<pre>Detaches a disk from an instance.

2181

2182

Args:

2183

project: string, Project ID for this request. (required)

2184

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2185

instance: string, Instance name for this request. (required)

2186

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)

2187

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.

2188

2189

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.

2190

2191

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]

2192

2193

Returns:

2194

An object of the form:

2195

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2196

{ # Represents an Operation resource.

2197

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2198

# Google Compute Engine has three Operation resources:

2199

#

2200

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2201

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2202

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2203

#

2204

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2205

# - For global operations, use the `globalOperations` resource.

2206

# - For regional operations, use the `regionOperations` resource.

2207

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2208

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2209

# 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]

2210

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2211

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2212

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2213

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2214

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2215

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2216

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2217

"code": "A String", # [Output Only] The error type identifier for this error.

2218

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2219

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2220

},

2221

],

2222

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2223

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2224

"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.

2225

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2226

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2227

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2228

"name": "A String", # [Output Only] Name of the operation.

2229

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2230

"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.

2231

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2232

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2233

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2234

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2235

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2236

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2237

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2238

"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.

2239

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2240

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2241

{

2242

"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.

2243

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2244

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2245

{

2246

"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).

2247

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2248

},

2249

],

2250

"message": "A String", # [Output Only] A human-readable description of the warning code.

2251

},

2252

],

2253

"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]

2259

<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]

2260

2261

Args:

2262

project: string, Project ID for this request. (required)

2263

zone: string, The name of the zone for this request. (required)

2264

instance: string, Name of the instance resource to return. (required)

2265

2266

Returns:

2267

An object of the form:

2268

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2269

{ # Represents an Instance resource.

2270

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2271

# 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 ==)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2272

"advancedMachineFeatures": { # Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of an Image (e.g., whether or not the OS in the Image supports nested virtualization being enabled or disabled). # Controls for advanced machine-related behavior features.

2273

"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).

2274

"threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.

2275

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2276

"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.

2277

"confidentialInstanceConfig": { # A set of Confidential Instance options.

2278

"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]

2279

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2280

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

2281

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

2282

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

2283

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2284

"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]

2285

{ # An instance-attached disk resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2286

"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).

2287

"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.

2288

"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.

2289

#

2290

# If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2291

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2292

#

2293

# 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.

2294

#

2295

# 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.

2296

#

2297

# 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.

2298

#

2299

# 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]

2300

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2301

"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.

2302

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2303

"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]

2304

#

2305

# The key must meet the following requirements before you can provide it to Compute Engine:

2306

# - 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]

2307

# - 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]

2308

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2309

"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]

2310

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2311

"diskSizeGb": "A String", # The size of the disk in GB.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

2312

"forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2313

"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.

2314

{ # Guest OS features.

2315

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

2316

},

2317

],

2318

"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.

2319

"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]

2320

#

2321

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

2322

#

2323

# 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]

2324

"description": "A String", # An optional description. Provide this property when creating the disk.

2325

"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.

2326

"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.

2327

"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]

2328

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

2329

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2330

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2331

# 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:

2332

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType

2333

# - projects/project/zones/zone/diskTypes/diskType

2334

# - 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]

2335

"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]

2336

#

2337

# Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

2338

{ # Guest OS features.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2339

"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]

2340

},

2341

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2342

"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.

2343

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2344

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2345

"multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2346

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2347

"provisionedIops": "A String", # Indicates how many IOPS must be provisioned for the disk.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2348

"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

2349

"A String",

2350

],

2351

"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.

2352

"A String",

2353

],

2354

"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]

2355

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2356

# 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:

2357

# projects/debian-cloud/global/images/family/debian-9

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2358

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2359

#

2360

# Alternatively, use a specific version of a public operating system image:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2361

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2362

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2363

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2364

# To create a disk with a custom image that you created, specify the image name in the following format:

2365

# global/images/my-custom-image

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2366

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2367

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2368

# 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:

2369

# global/images/family/my-image-family

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2370

#

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2371

#

2372

# If the source image is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2373

"sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2374

#

2375

# 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.

2376

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2377

"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.

2378

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2379

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

2380

#

2381

# The key must meet the following requirements before you can provide it to Compute Engine:

2382

# - The key is wrapped using a RSA public key certificate provided by Google.

2383

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

2384

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

2385

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

2386

},

2387

"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.

2388

#

2389

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

2390

# global/snapshots/my-backup

2391

#

2392

#

2393

# If the source snapshot is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2394

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2395

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2396

"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.

2397

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2398

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

2399

#

2400

# The key must meet the following requirements before you can provide it to Compute Engine:

2401

# - The key is wrapped using a RSA public key certificate provided by Google.

2402

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

2403

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

2404

"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]

2405

},

2406

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2407

"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.

2408

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

2409

"licenses": [ # [Output Only] Any valid publicly visible licenses.

2410

"A String",

2411

],

2412

"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.

2413

"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.

2414

"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

2415

"dbs": [ # The Key Database (db).

2416

{

2417

"content": "A String", # The raw content in the secure keys file.

2418

"fileType": "A String", # The file type of source file.

2419

},

2420

],

2421

"dbxs": [ # The forbidden key database (dbx).

2422

{

2423

"content": "A String", # The raw content in the secure keys file.

2424

"fileType": "A String", # The file type of source file.

2425

},

2426

],

2427

"keks": [ # The Key Exchange Key (KEK).

2428

{

2429

"content": "A String", # The raw content in the secure keys file.

2430

"fileType": "A String", # The file type of source file.

2431

},

2432

],

2433

"pk": { # The Platform Key (PK).

2434

"content": "A String", # The raw content in the secure keys file.

2435

"fileType": "A String", # The file type of source file.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2436

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2437

},

2438

"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]

2439

#

2440

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

2441

#

2442

# 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]

2443

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

2444

"userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of URLs to the license resource. Unlike regular licenses, user provided licenses can be modified after the disk is created.

2445

"A String",

2446

],

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2447

},

2448

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2449

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

2450

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2451

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2452

"eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.

2453

"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.

2454

#

2455

# To see the latest fingerprint, make get() request to the instance.

2456

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

2457

{ # A specification of the type and number of accelerator cards attached to the instance.

2458

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

2459

"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.

2460

},

2461

],

2462

"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.

2463

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2464

"instanceEncryptionKey": { # Encrypts or decrypts data for an instance with a customer-supplied encryption key.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2465

#

2466

# 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.

2467

#

2468

# 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.

2469

#

2470

# 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.

2471

#

2472

# 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.

2473

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2474

"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.

2475

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2476

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

2477

#

2478

# The key must meet the following requirements before you can provide it to Compute Engine:

2479

# - The key is wrapped using a RSA public key certificate provided by Google.

2480

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

2481

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

2482

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

2483

},

2484

"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.

2485

"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.

2486

#

2487

# To see the latest fingerprint, make get() request to the instance.

2488

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

2489

"a_key": "A String",

2490

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2491

"lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format.

2492

"lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format.

2493

"lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2494

"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:

2495

# zones/us-central1-f/machineTypes/n1-standard-1

2496

#

2497

#

2498

# 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):

2499

# zones/zone/machineTypes/custom-CPUS-MEMORY

2500

#

2501

#

2502

# For example: zones/us-central1-f/machineTypes/custom-4-5120

2503

#

2504

# For a full list of restrictions, read the Specifications for custom machine types.

2505

"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

2506

"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.

2507

#

2508

# To see the latest fingerprint, make a get() request to retrieve the resource.

2509

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

2510

{

2511

"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.

2512

"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).

2513

},

2514

],

2515

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

2516

},

2517

"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".

2518

"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.

2519

"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.

2520

{ # A network interface resource attached to an instance.

2521

"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.

2522

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

2523

"externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.

2524

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2525

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

2526

"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.

2527

"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.

2528

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

2529

#

2530

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

2531

#

2532

# 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.

2533

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

2534

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

2535

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

2536

"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.

2537

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

2538

},

2539

],

2540

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

2541

{ # An alias IP range attached to an instance's network interface.

2542

"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).

2543

"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.

2544

},

2545

],

2546

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

2547

"internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range.

2548

"ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.

2549

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

2550

"externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.

2551

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

2552

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

2553

"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.

2554

"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.

2555

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

2556

#

2557

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

2558

#

2559

# 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.

2560

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

2561

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

2562

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

2563

"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.

2564

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

2565

},

2566

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2567

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

2568

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

2569

"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.

2570

"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.

2571

#

2572

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

2573

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

2574

# - projects/project/global/networks/network

2575

# - global/networks/default

2576

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

2577

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

2578

"queueCount": 42, # The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.

2579

"stackType": "A String", # The stack type for this network interface to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used.

2580

#

2581

# This field can be both set at instance creation and update network interface operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2582

"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:

2583

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

2584

# - regions/region/subnetworks/subnetwork

2585

},

2586

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2587

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2588

"preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api.

2589

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.

2590

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.

2591

"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.

2592

"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.

2593

"values": [ # Corresponds to the label values of a reservation resource.

"A String",

],

},

"resourcePolicies": [ # Resource policies applied to this instance.

2598

"A String",

2599

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2600

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

2601

"scheduling": { # Sets the scheduling options for an Instance. NextID: 13 # Sets the scheduling options for this instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2602

"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.

2603

#

2604

# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

2605

"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.

2606

"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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2607

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after instance creation where the instance won't be scheduled for maintenance.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

2608

"maintenanceInterval": "A String", # Specifies whether this VM may be a stable fleet VM. Setting this to "Periodic" designates this VM as a Stable Fleet VM.

2609

#

2610

# See go/stable-fleet-ug for more details.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2611

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

2612

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

2613

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

2614

"key": "A String", # Corresponds to the label key of Node resource.

2615

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

2616

"values": [ # Corresponds to the label values of Node resource.

"A String",

],

},

],

"onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2622

"preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2623

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2624

"secureLabels": [ # Secure labels to apply to this instance. These can be later modified by the update method. Maximum number of secure labels allowed is 300.

2625

"A String",

2626

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2627

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

2628

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2629

"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

2630

#

2631

# 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.

2632

{ # A service account.

2633

"email": "A String", # Email address of the service account.

2634

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

2640

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

2641

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

2642

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

2643

},

2644

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

2645

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

2646

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2647

"shieldedVmConfig": { # A set of Shielded VM options. # Deprecating, please use shielded_instance_config.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2648

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

2649

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

2650

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

2651

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2652

"shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured. # Deprecating, please use shielded_instance_integrity_policy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2653

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

2654

},

2655

"sourceMachineImage": "A String", # Source machine image

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2656

"sourceMachineImageEncryptionKey": { # Source GMI encryption key when creating an instance from GMI.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2657

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2658

"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.

2659

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2660

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

2661

#

2662

# The key must meet the following requirements before you can provide it to Compute Engine:

2663

# - The key is wrapped using a RSA public key certificate provided by Google.

2664

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

2665

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

2666

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

2667

},

2668

"startRestricted": True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

2669

"status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2670

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

2671

"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.

2672

"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.

2673

#

2674

# To see the latest fingerprint, make get() request to the instance.

2675

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2680

"date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use start_time_window instead.

2681

"time": "A String", # [Output Only] The time when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use start_time_window instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2682

"type": "A String", # Defines the type of maintenance.

2683

},

2684

"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]

2689

<code class="details" id="getEffectiveFirewalls">getEffectiveFirewalls(project, zone, instance, networkInterface)</code>

2690

<pre>Returns effective firewalls applied to an interface of the instance.

2691

2692

Args:

2693

project: string, Project ID for this request. (required)

2694

zone: string, The name of the zone for this request. (required)

2695

instance: string, Name of the instance scoping this request. (required)

2696

networkInterface: string, The name of the network interface to get the effective firewalls. (required)

2697

2698

Returns:

2699

An object of the form:

2700

2701

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2702

"firewalls": [ # Effective firewalls on the instance.

2703

{ # Represents a Firewall Rule resource.

2704

#

2705

# Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules.

2706

"allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

2707

{

2708

"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.

2709

"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.

2710

#

2711

# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

"A String",

],

},

],

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

2717

"denied": [ # The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.

2718

{

2719

"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.

2720

"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.

2721

#

2722

# 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.

2728

"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.

2729

"A String",

2730

],

2731

"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.

2732

"disabled": True or False, # Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2733

"enableLogging": True or False, # Deprecated in favor of enable in LogConfig. This field denotes whether to enable logging for a particular firewall rule. If logging is enabled, logs will be exported t Cloud Logging.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2734

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

2735

"kind": "compute#firewall", # [Output Only] Type of the resource. Always compute#firewall for firewall rules.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2736

"logConfig": { # The available logging options for a firewall rule. # This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Cloud Logging.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2737

"enable": True or False, # This field denotes whether to enable logging for a particular firewall rule.

2738

"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.

2739

},

2740

"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.

2741

"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:

2742

# global/networks/default

2743

# 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:

2744

# - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network

2745

# - projects/myproject/global/networks/my-network

2746

# - global/networks/default

2747

"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`.

2748

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2749

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2750

"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.

2751

"A String",

2752

],

2753

"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.

2754

"A String",

2755

],

2756

"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.

2757

"A String",

2758

],

2759

"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.

2760

"A String",

2761

],

2762

"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]

2768

{ # A pruned SecurityPolicy containing ID and any applicable firewall rules.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2769

"id": "A String", # The unique identifier for the security policy. This identifier is defined by the server.

2770

"rules": [ # The rules that apply to the network.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2771

{ # 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]

2772

"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.

2773

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2774

"direction": "A String", # The direction in which this rule applies. This field may only be specified when versioned_expr is set to FIREWALL.

2775

"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]

2776

#

2777

# 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]

2778

"kind": "compute#securityPolicyRule", # [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules

2779

"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.

2780

"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.

2781

"destIpRanges": [ # CIDR IP address range.

2782

#

2783

# This field may only be specified when versioned_expr is set to FIREWALL.

2784

"A String",

2785

],

2786

"destPorts": [ # Pairs of IP protocols and ports that the rule should match.

2787

#

2788

# This field may only be specified when versioned_expr is set to FIREWALL.

2789

{

2790

"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.

2791

"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.

2792

#

2793

# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

2794

#

2795

# 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.

2801

#

2802

# This field may only be specified when versioned_expr is set to FIREWALL.

2803

{

2804

"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.

2805

"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.

2806

#

2807

# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

2808

#

2809

# This field may only be specified when versioned_expr is set to FIREWALL.

"A String",

],

},

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2814

"srcIpRanges": [ # CIDR IP address range. Maximum number of src_ip_ranges allowed is 10.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"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]

2819

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2820

# Example (Comparison):

2821

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2822

# 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]

2823

#

2824

# Example (Equality):

2825

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2826

# 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]

2827

#

2828

# Example (Logic):

2829

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2830

# 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]

2831

#

2832

# Example (Data Manipulation):

2833

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2834

# 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]

2835

#

2836

# 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]

2837

"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.

2838

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

2839

"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.

2840

"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]

2841

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2842

"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]

2843

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2844

"preview": True or False, # If set to true, the specified action is not enforced.

2845

"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.

2846

"rateLimitOptions": { # Must be specified if the action is "rate_based_blacklist" or "throttle". Cannot be specified for any other actions.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2847

"banDurationSec": 42, # Can only be specified if the action for the rule is "rate_based_ban". If specified, the key will be banned for the configured 'ban_duration' when the number of requests that exceed the 'rate_limit_threshold' also exceed this 'ban_threshold'.

2848

"banThreshold": { # Can only be specified if the action for the rule is "rate_based_ban". If specified, the key will be banned for the configured 'ban_duration' when the number of requests that exceed the 'rate_limit_threshold' also exceed this 'ban_threshold'.

2849

"count": 42, # Number of HTTP(S) requests for calculating the threshold.

2850

"intervalSec": 42, # Interval over which the threshold is computed.

2851

},

2852

"blockDuration": 42, # Can only be specified if the action for the rule is "rate_based_ban" 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. [Deprecated] This field is deprecated.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2853

"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".

2854

"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.

2855

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2856

"rateLimitThreshold": { # Threshold at which to begin ratelimiting.

2857

"count": 42, # Number of HTTP(S) requests for calculating the threshold.

2858

"intervalSec": 42, # Interval over which the threshold is computed.

2859

},

2860

"thresholdRps": 42, # Rate in requests per second at which to begin ratelimiting. [Deprecated] This field is deprecated.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2861

},

2862

"ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall security policy rule.

2863

"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.

2864

#

2865

# This field may only be specified when versioned_expr is set to FIREWALL.

2866

"A String",

2867

],

2868

"targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.

2869

"A String",

2870

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2871

},

2872

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2873

},

2874

],

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]

2879

<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]

2880

<pre>Returns the specified guest attributes entry.

2881

2882

Args:

2883

project: string, Project ID for this request. (required)

2884

zone: string, The name of the zone for this request. (required)

2885

instance: string, Name of the instance scoping this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2886

queryPath: string, Specifies the guest attributes path to be queried.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2887

variableKey: string, Specifies the key for the guest attributes entry.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2888

2889

Returns:

2890

An object of the form:

2891

2892

{ # A guest attributes entry.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2893

"kind": "compute#guestAttributes", # [Output Only] Type of the resource. Always compute#guestAttributes for guest attributes entry.

2894

"queryPath": "A String", # The path to be queried. This can be the default namespace ('/') or a nested namespace ('/\/') or a specified key ('/\/\')

2895

"queryValue": { # Array of guest attribute namespace/key/value tuples. # [Output Only] The value of the requested queried path.

2896

"items": [

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2897

{ # A guest attributes namespace/key/value entry.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2898

"key": "A String", # Key for the guest attribute entry.

2899

"namespace": "A String", # Namespace for the guest attribute entry.

2900

"value": "A String", # Value for the guest attribute entry.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2901

},

2902

],

2903

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2904

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

2905

"variableKey": "A String", # The key to search for.

2906

"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]

2911

<code class="details" id="getIamPolicy">getIamPolicy(project, zone, resource, optionsRequestedPolicyVersion=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2912

<pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists.

2913

2914

Args:

2915

project: string, Project ID for this request. (required)

2916

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2917

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2918

optionsRequestedPolicyVersion: integer, Requested IAM Policy version.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2919

2920

Returns:

2921

An object of the form:

2922

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2923

{ # 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]

2924

#

2925

#

2926

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2927

# 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]

2928

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2929

# 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]

2930

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2931

# **JSON example:**

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2932

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2933

# { "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]

2934

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2935

# **YAML example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2936

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2937

# 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]

2938

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2939

# 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]

2940

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2941

{ # 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]

2942

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2943

# 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]

2944

#

2945

# Example Policy with multiple AuditConfigs:

2946

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2947

# { "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]

2948

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2949

# 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]

2950

"auditLogConfigs": [ # The configuration for logging of each type of permission.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

2951

{ # Provides the configuration for logging a type of permissions. Example:

2952

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2953

# { "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]

2954

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2955

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

2956

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

2957

"A String",

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2958

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2959

"ignoreChildExemptions": True or False,

2960

"logType": "A String", # The log type that this config enables.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2961

},

2962

],

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]

2967

},

2968

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2969

"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]

2970

{ # Associates `members` with a `role`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2971

"bindingId": "A String", # A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2972

"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.

2973

#

2974

# If the condition evaluates to `true`, then this binding applies to the current request.

2975

#

2976

# 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.

2977

#

2978

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

2979

#

2980

# Example (Comparison):

2981

#

2982

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

2983

#

2984

# Example (Equality):

2985

#

2986

# 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'"

2991

#

2992

# Example (Data Manipulation):

2993

#

2994

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

2995

#

2996

# 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.

2997

"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.

2998

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

2999

"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.

3000

"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.

3001

},

3002

"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]

3003

#

3004

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

3005

#

3006

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

3007

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3008

# * `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]

3009

#

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

3010

#

3011

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3012

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

3013

#

3014

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

3015

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3016

# * `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.

3017

#

3018

# * `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.

3019

#

3020

# * `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.

3021

#

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3022

#

3023

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3024

# * `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]

3025

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3026

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3027

"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]

3028

},

3029

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3030

"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.

3031

#

3032

# **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.

3033

"iamOwned": True or False,

3034

"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.

3035

{ # A rule to be applied in a Policy.

3036

"action": "A String", # Required

3037

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

3038

{ # A condition to be met.

3039

"iam": "A String", # Trusted attributes supplied by the IAM system.

3040

"op": "A String", # An operator to apply the subject with.

3041

"svc": "A String", # Trusted attributes discharged by the service.

3042

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

3043

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

3049

"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.

3050

"A String",

3051

],

3052

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

3053

{ # Specifies what kind of log the caller must write

3054

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

3055

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

3056

"permissionType": "A String", # The type of the permission that was checked.

3057

},

3058

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

3059

},

3060

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

3061

#

3062

# 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.

3063

#

3064

# Field names correspond to IAM request parameters and field values are their respective values.

3065

#

3066

# 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.

3067

#

3068

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

3069

"customFields": [ # Custom fields.

3070

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

3071

"name": "A String", # Name is the field name.

3072

"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.

3073

},

3074

],

3075

"field": "A String", # The field value to attribute.

3076

"metric": "A String", # The metric to update.

3077

},

3078

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

3079

"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.

3084

"A String",

3085

],

3086

"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.

3092

#

3093

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

3094

#

3095

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

3096

#

3097

# * 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

3098

#

3099

# **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.

3100

#

3101

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

3102

#

3103

# 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]

3108

<code class="details" id="getScreenshot">getScreenshot(project, zone, instance)</code>

3109

<pre>Returns the screenshot from the specified instance.

3110

3111

Args:

3112

project: string, Project ID for this request. (required)

3113

zone: string, The name of the zone for this request. (required)

3114

instance: string, Name of the instance scoping this request. (required)

3115

3116

Returns:

3117

An object of the form:

3118

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3119

{ # An instance's screenshot.

3120

"contents": "A String", # [Output Only] The Base64-encoded screenshot data.

3121

"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]

3126

<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]

3127

<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]

3128

3129

Args:

3130

project: string, Project ID for this request. (required)

3131

zone: string, The name of the zone for this request. (required)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3132

instance: string, Name of the instance for this request. (required)

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3133

port: integer, Specifies which COM or serial port to retrieve data from.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3134

start: string, Specifies the starting byte position of the output to return. To start with the first byte of output to the specified port, omit this field or set it to `0`.

3135

3136

If the output for that byte position is available, this field matches the `start` parameter sent with the request. If the amount of serial console output exceeds the size of the buffer (1 MB), the oldest output is discarded and is no longer available. If the requested start position refers to discarded output, the start position is adjusted to the oldest output still available, and the adjusted start position is returned as the `start` property value.

3137

3138

You can also provide a negative start position, which translates to the most recent number of bytes written to the serial port. For example, -3 is interpreted as the most recent 3 bytes written to the serial console.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3139

3140

Returns:

3141

An object of the form:

3142

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3143

{ # An instance's serial console output.

3144

"contents": "A String", # [Output Only] The contents of the console output.

3145

"kind": "compute#serialPortOutput", # [Output Only] Type of the resource. Always compute#serialPortOutput for serial port output.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3146

"next": "A String", # [Output Only] The position of the next byte of content, regardless of whether the content exists, following the output returned in the `contents` property. Use this value in the next request as the start parameter.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3147

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3148

"start": "A String", # The starting byte position of the output that was returned. This should match the start parameter sent with the request. If the serial console output exceeds the size of the buffer (1 MB), older output is overwritten by newer content. The output start value will indicate the byte position of the output that was returned, which might be different than the `start` value that was specified in the request.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3153

<code class="details" id="getShieldedInstanceIdentity">getShieldedInstanceIdentity(project, zone, instance)</code>

3154

<pre>Returns the Shielded Instance Identity of an instance

3155

3156

Args:

3157

project: string, Project ID for this request. (required)

3158

zone: string, The name of the zone for this request. (required)

3159

instance: string, Name or id of the instance scoping this request. (required)

3160

3161

Returns:

3162

An object of the form:

3163

3164

{ # A shielded Instance identity entry.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3165

"encryptionKey": { # A Shielded Instance Identity Entry. # An Endorsement Key (EK) made by the RSA 2048 algorithm issued to the Shielded Instance's vTPM.

3166

"ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.

3167

"ekPub": "A String", # A PEM-encoded public key.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3168

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3169

"kind": "compute#shieldedInstanceIdentity", # [Output Only] Type of the resource. Always compute#shieldedInstanceIdentity for shielded Instance identity entry.

3170

"signingKey": { # A Shielded Instance Identity Entry. # An Attestation Key (AK) made by the RSA 2048 algorithm issued to the Shielded Instance's vTPM.

3171

"ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.

3172

"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>

3179

<pre>Returns the Shielded VM Identity of an instance

3180

3181

Args:

3182

project: string, Project ID for this request. (required)

3183

zone: string, The name of the zone for this request. (required)

3184

instance: string, Name of the instance scoping this request. (required)

3185

3186

Returns:

3187

An object of the form:

3188

3189

{ # A shielded VM identity entry.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3190

"encryptionKey": { # A Shielded Instance Identity Entry. # An Endorsement Key (EK) issued to the Shielded VM's vTPM.

3191

"ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.

3192

"ekPub": "A String", # A PEM-encoded public key.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3193

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3194

"kind": "compute#shieldedVmIdentity", # [Output Only] Type of the resource. Always compute#shieldedVmIdentity for shielded VM identity entry.

3195

"signingKey": { # A Shielded Instance Identity Entry. # An Attestation Key (AK) issued to the Shielded VM's vTPM.

3196

"ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.

3197

"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]

3203

<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]

3204

<pre>Creates an instance resource in the specified project using the data included in the request.

3205

3206

Args:

3207

project: string, Project ID for this request. (required)

3208

zone: string, The name of the zone for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3209

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3210

The object takes the form of:

3211

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3212

{ # Represents an Instance resource.

3213

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3214

# 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 ==)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3215

"advancedMachineFeatures": { # Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of an Image (e.g., whether or not the OS in the Image supports nested virtualization being enabled or disabled). # Controls for advanced machine-related behavior features.

3216

"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).

3217

"threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.

3218

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3219

"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.

3220

"confidentialInstanceConfig": { # A set of Confidential Instance options.

3221

"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]

3222

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3223

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

3224

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

3225

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

3226

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3227

"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]

3228

{ # An instance-attached disk resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3229

"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).

3230

"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.

3231

"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.

3232

#

3233

# If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3234

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3235

#

3236

# 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.

3237

#

3238

# 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.

3239

#

3240

# 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.

3241

#

3242

# 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]

3243

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3244

"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.

3245

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3246

"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]

3247

#

3248

# The key must meet the following requirements before you can provide it to Compute Engine:

3249

# - 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]

3250

# - 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]

3251

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3252

"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]

3253

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3254

"diskSizeGb": "A String", # The size of the disk in GB.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

3255

"forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3256

"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.

3257

{ # Guest OS features.

3258

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

3259

},

3260

],

3261

"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.

3262

"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]

3263

#

3264

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

3265

#

3266

# 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]

3267

"description": "A String", # An optional description. Provide this property when creating the disk.

3268

"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.

3269

"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.

3270

"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]

3271

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

3272

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3273

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3274

# 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:

3275

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType

3276

# - projects/project/zones/zone/diskTypes/diskType

3277

# - 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]

3278

"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]

3279

#

3280

# Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

3281

{ # Guest OS features.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3282

"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]

3283

},

3284

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3285

"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.

3286

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3287

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3288

"multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3289

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3290

"provisionedIops": "A String", # Indicates how many IOPS must be provisioned for the disk.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3291

"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

3292

"A String",

3293

],

3294

"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.

3295

"A String",

3296

],

3297

"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]

3298

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3299

# 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:

3300

# projects/debian-cloud/global/images/family/debian-9

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3301

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3302

#

3303

# Alternatively, use a specific version of a public operating system image:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3304

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3305

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3306

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3307

# To create a disk with a custom image that you created, specify the image name in the following format:

3308

# global/images/my-custom-image

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3309

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3310

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3311

# 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:

3312

# global/images/family/my-image-family

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3313

#

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

3314

#

3315

# If the source image is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3316

"sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3317

#

3318

# 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.

3319

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3320

"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.

3321

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3322

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

3323

#

3324

# The key must meet the following requirements before you can provide it to Compute Engine:

3325

# - The key is wrapped using a RSA public key certificate provided by Google.

3326

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

3327

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

3328

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

3329

},

3330

"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.

3331

#

3332

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

3333

# global/snapshots/my-backup

3334

#

3335

#

3336

# If the source snapshot is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3337

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3338

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3339

"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.

3340

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3341

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

3342

#

3343

# The key must meet the following requirements before you can provide it to Compute Engine:

3344

# - The key is wrapped using a RSA public key certificate provided by Google.

3345

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

3346

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

3347

"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]

3348

},

3349

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3350

"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.

3351

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

3352

"licenses": [ # [Output Only] Any valid publicly visible licenses.

3353

"A String",

3354

],

3355

"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.

3356

"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.

3357

"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

3358

"dbs": [ # The Key Database (db).

3359

{

3360

"content": "A String", # The raw content in the secure keys file.

3361

"fileType": "A String", # The file type of source file.

3362

},

3363

],

3364

"dbxs": [ # The forbidden key database (dbx).

3365

{

3366

"content": "A String", # The raw content in the secure keys file.

3367

"fileType": "A String", # The file type of source file.

3368

},

3369

],

3370

"keks": [ # The Key Exchange Key (KEK).

3371

{

3372

"content": "A String", # The raw content in the secure keys file.

3373

"fileType": "A String", # The file type of source file.

3374

},

3375

],

3376

"pk": { # The Platform Key (PK).

3377

"content": "A String", # The raw content in the secure keys file.

3378

"fileType": "A String", # The file type of source file.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3379

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3380

},

3381

"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]

3382

#

3383

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

3384

#

3385

# 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]

3386

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

3387

"userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of URLs to the license resource. Unlike regular licenses, user provided licenses can be modified after the disk is created.

3388

"A String",

3389

],

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3390

},

3391

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3392

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

3393

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3394

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3395

"eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.

3396

"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.

3397

#

3398

# To see the latest fingerprint, make get() request to the instance.

3399

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

3400

{ # A specification of the type and number of accelerator cards attached to the instance.

3401

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

3402

"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.

3403

},

3404

],

3405

"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.

3406

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3407

"instanceEncryptionKey": { # Encrypts or decrypts data for an instance with a customer-supplied encryption key.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3408

#

3409

# 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.

3410

#

3411

# 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.

3412

#

3413

# 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.

3414

#

3415

# 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.

3416

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3417

"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.

3418

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3419

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

3420

#

3421

# The key must meet the following requirements before you can provide it to Compute Engine:

3422

# - The key is wrapped using a RSA public key certificate provided by Google.

3423

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

3424

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

3425

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

3426

},

3427

"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.

3428

"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.

3429

#

3430

# To see the latest fingerprint, make get() request to the instance.

3431

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

3432

"a_key": "A String",

3433

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3434

"lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format.

3435

"lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format.

3436

"lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3437

"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:

3438

# zones/us-central1-f/machineTypes/n1-standard-1

3439

#

3440

#

3441

# 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):

3442

# zones/zone/machineTypes/custom-CPUS-MEMORY

3443

#

3444

#

3445

# For example: zones/us-central1-f/machineTypes/custom-4-5120

3446

#

3447

# For a full list of restrictions, read the Specifications for custom machine types.

3448

"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

3449

"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.

3450

#

3451

# To see the latest fingerprint, make a get() request to retrieve the resource.

3452

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

3453

{

3454

"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.

3455

"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).

3456

},

3457

],

3458

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

3459

},

3460

"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".

3461

"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.

3462

"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.

3463

{ # A network interface resource attached to an instance.

3464

"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.

3465

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

3466

"externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.

3467

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3468

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

3469

"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.

3470

"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.

3471

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

3472

#

3473

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

3474

#

3475

# 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.

3476

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

3477

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

3478

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

3479

"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.

3480

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

3481

},

3482

],

3483

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

3484

{ # An alias IP range attached to an instance's network interface.

3485

"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).

3486

"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.

3487

},

3488

],

3489

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

3490

"internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range.

3491

"ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.

3492

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

3493

"externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.

3494

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

3495

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

3496

"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.

3497

"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.

3498

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

3499

#

3500

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

3501

#

3502

# 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.

3503

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

3504

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

3505

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

3506

"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.

3507

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

3508

},

3509

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3510

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

3511

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

3512

"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.

3513

"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.

3514

#

3515

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

3516

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

3517

# - projects/project/global/networks/network

3518

# - global/networks/default

3519

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

3520

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

3521

"queueCount": 42, # The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.

3522

"stackType": "A String", # The stack type for this network interface to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used.

3523

#

3524

# This field can be both set at instance creation and update network interface operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3525

"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:

3526

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

3527

# - regions/region/subnetworks/subnetwork

3528

},

3529

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3530

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3531

"preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api.

3532

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.

3533

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.

3534

"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.

3535

"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.

3536

"values": [ # Corresponds to the label values of a reservation resource.

"A String",

],

},

"resourcePolicies": [ # Resource policies applied to this instance.

3541

"A String",

3542

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3543

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

3544

"scheduling": { # Sets the scheduling options for an Instance. NextID: 13 # Sets the scheduling options for this instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3545

"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.

3546

#

3547

# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

3548

"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.

3549

"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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3550

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after instance creation where the instance won't be scheduled for maintenance.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

3551

"maintenanceInterval": "A String", # Specifies whether this VM may be a stable fleet VM. Setting this to "Periodic" designates this VM as a Stable Fleet VM.

3552

#

3553

# See go/stable-fleet-ug for more details.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3554

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

3555

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

3556

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

3557

"key": "A String", # Corresponds to the label key of Node resource.

3558

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

3559

"values": [ # Corresponds to the label values of Node resource.

"A String",

],

},

],

"onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3565

"preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3566

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3567

"secureLabels": [ # Secure labels to apply to this instance. These can be later modified by the update method. Maximum number of secure labels allowed is 300.

3568

"A String",

3569

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3570

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

3571

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

3572

"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

3573

#

3574

# 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.

3575

{ # A service account.

3576

"email": "A String", # Email address of the service account.

3577

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

3583

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

3584

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

3585

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

3586

},

3587

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

3588

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

3589

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3590

"shieldedVmConfig": { # A set of Shielded VM options. # Deprecating, please use shielded_instance_config.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3591

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

3592

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

3593

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

3594

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3595

"shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured. # Deprecating, please use shielded_instance_integrity_policy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3596

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

3597

},

3598

"sourceMachineImage": "A String", # Source machine image

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3599

"sourceMachineImageEncryptionKey": { # Source GMI encryption key when creating an instance from GMI.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3600

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3601

"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.

3602

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3603

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

3604

#

3605

# The key must meet the following requirements before you can provide it to Compute Engine:

3606

# - The key is wrapped using a RSA public key certificate provided by Google.

3607

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

3608

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

3609

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

3610

},

3611

"startRestricted": True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

3612

"status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3613

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

3614

"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.

3615

"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.

3616

#

3617

# To see the latest fingerprint, make get() request to the instance.

3618

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3623

"date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use start_time_window instead.

3624

"time": "A String", # [Output Only] The time when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use start_time_window instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3625

"type": "A String", # Defines the type of maintenance.

3626

},

3627

"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]

3628

}

3629

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3630

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.

3631

3632

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.

3633

3634

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]

3635

sourceInstanceTemplate: string, Specifies instance template to create the instance.

3636

3637

This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to an instance template:

3638

- https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate

3639

- projects/project/global/instanceTemplates/instanceTemplate

3640

- global/instanceTemplates/instanceTemplate

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

3641

sourceMachineImage: string, Specifies the machine image to use to create the instance.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3642

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

3643

This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to a machine image:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3644

- https://www.googleapis.com/compute/v1/projects/project/global/global/machineImages/machineImage

3645

- projects/project/global/global/machineImages/machineImage

3646

- global/machineImages/machineImage

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3647

3648

Returns:

3649

An object of the form:

3650

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3651

{ # Represents an Operation resource.

3652

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3653

# Google Compute Engine has three Operation resources:

3654

#

3655

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

3656

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3657

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

3658

#

3659

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3660

# - For global operations, use the `globalOperations` resource.

3661

# - For regional operations, use the `regionOperations` resource.

3662

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3663

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3664

# 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]

3665

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3666

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3667

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3668

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3669

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3670

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3671

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3672

"code": "A String", # [Output Only] The error type identifier for this error.

3673

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3674

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3675

},

3676

],

3677

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3678

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3679

"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.

3680

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3681

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3682

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3683

"name": "A String", # [Output Only] Name of the operation.

3684

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3685

"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.

3686

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3687

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3688

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

3689

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3690

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3691

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3692

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3693

"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.

3694

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3695

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3696

{

3697

"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.

3698

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

3699

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

3700

{

3701

"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).

3702

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3703

},

3704

],

3705

"message": "A String", # [Output Only] A human-readable description of the warning code.

3706

},

3707

],

3708

"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]

3713

<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]

3714

<pre>Retrieves the list of instances contained within the specified zone.

3715

3716

Args:

3717

project: string, Project ID for this request. (required)

3718

zone: string, The name of the zone for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3719

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]

3720

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3721

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]

3722

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3723

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]

3724

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3725

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) ```

3726

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`)

3727

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

3728

3729

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.

3730

3731

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

3732

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.

3733

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]

3734

3735

Returns:

3736

An object of the form:

3737

3738

{ # Contains a list of instances.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3739

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

3740

"items": [ # A list of Instance resources.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3741

{ # Represents an Instance resource.

3742

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3743

# 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 ==)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3744

"advancedMachineFeatures": { # Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of an Image (e.g., whether or not the OS in the Image supports nested virtualization being enabled or disabled). # Controls for advanced machine-related behavior features.

3745

"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).

3746

"threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.

3747

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3748

"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.

3749

"confidentialInstanceConfig": { # A set of Confidential Instance options.

3750

"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]

3751

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3752

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

3753

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

3754

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

3755

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3756

"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]

3757

{ # An instance-attached disk resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3758

"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).

3759

"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.

3760

"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.

3761

#

3762

# If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3763

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3764

#

3765

# 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.

3766

#

3767

# 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.

3768

#

3769

# 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.

3770

#

3771

# 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]

3772

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3773

"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.

3774

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3775

"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]

3776

#

3777

# The key must meet the following requirements before you can provide it to Compute Engine:

3778

# - 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]

3779

# - 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]

3780

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3781

"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]

3782

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3783

"diskSizeGb": "A String", # The size of the disk in GB.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

3784

"forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3785

"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.

3786

{ # Guest OS features.

3787

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

3788

},

3789

],

3790

"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.

3791

"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]

3792

#

3793

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

3794

#

3795

# 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]

3796

"description": "A String", # An optional description. Provide this property when creating the disk.

3797

"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.

3798

"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.

3799

"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]

3800

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

3801

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3802

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3803

# 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:

3804

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType

3805

# - projects/project/zones/zone/diskTypes/diskType

3806

# - 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]

3807

"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]

3808

#

3809

# Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

3810

{ # Guest OS features.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3811

"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]

3812

},

3813

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3814

"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.

3815

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3816

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3817

"multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3818

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3819

"provisionedIops": "A String", # Indicates how many IOPS must be provisioned for the disk.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3820

"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

3821

"A String",

3822

],

3823

"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.

3824

"A String",

3825

],

3826

"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]

3827

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3828

# 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:

3829

# projects/debian-cloud/global/images/family/debian-9

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3830

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3831

#

3832

# Alternatively, use a specific version of a public operating system image:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3833

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3834

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3835

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3836

# To create a disk with a custom image that you created, specify the image name in the following format:

3837

# global/images/my-custom-image

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3838

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3839

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3840

# 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:

3841

# global/images/family/my-image-family

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3842

#

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

3843

#

3844

# If the source image is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3845

"sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3846

#

3847

# 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.

3848

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3849

"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.

3850

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3851

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

3852

#

3853

# The key must meet the following requirements before you can provide it to Compute Engine:

3854

# - The key is wrapped using a RSA public key certificate provided by Google.

3855

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

3856

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

3857

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

3858

},

3859

"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.

3860

#

3861

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

3862

# global/snapshots/my-backup

3863

#

3864

#

3865

# If the source snapshot is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3866

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3867

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3868

"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.

3869

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3870

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

3871

#

3872

# The key must meet the following requirements before you can provide it to Compute Engine:

3873

# - The key is wrapped using a RSA public key certificate provided by Google.

3874

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

3875

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

3876

"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]

3877

},

3878

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3879

"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.

3880

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

3881

"licenses": [ # [Output Only] Any valid publicly visible licenses.

3882

"A String",

3883

],

3884

"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.

3885

"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.

3886

"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

3887

"dbs": [ # The Key Database (db).

3888

{

3889

"content": "A String", # The raw content in the secure keys file.

3890

"fileType": "A String", # The file type of source file.

3891

},

3892

],

3893

"dbxs": [ # The forbidden key database (dbx).

3894

{

3895

"content": "A String", # The raw content in the secure keys file.

3896

"fileType": "A String", # The file type of source file.

3897

},

3898

],

3899

"keks": [ # The Key Exchange Key (KEK).

3900

{

3901

"content": "A String", # The raw content in the secure keys file.

3902

"fileType": "A String", # The file type of source file.

3903

},

3904

],

3905

"pk": { # The Platform Key (PK).

3906

"content": "A String", # The raw content in the secure keys file.

3907

"fileType": "A String", # The file type of source file.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3908

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3909

},

3910

"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]

3911

#

3912

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

3913

#

3914

# 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]

3915

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

3916

"userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of URLs to the license resource. Unlike regular licenses, user provided licenses can be modified after the disk is created.

3917

"A String",

3918

],

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3919

},

3920

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3921

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

3922

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3923

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3924

"eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.

3925

"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.

3926

#

3927

# To see the latest fingerprint, make get() request to the instance.

3928

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

3929

{ # A specification of the type and number of accelerator cards attached to the instance.

3930

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

3931

"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.

3932

},

3933

],

3934

"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.

3935

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3936

"instanceEncryptionKey": { # Encrypts or decrypts data for an instance with a customer-supplied encryption key.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3937

#

3938

# 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.

3939

#

3940

# 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.

3941

#

3942

# 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.

3943

#

3944

# 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.

3945

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3946

"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.

3947

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3948

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

3949

#

3950

# The key must meet the following requirements before you can provide it to Compute Engine:

3951

# - The key is wrapped using a RSA public key certificate provided by Google.

3952

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

3953

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

3954

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

3955

},

3956

"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.

3957

"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.

3958

#

3959

# To see the latest fingerprint, make get() request to the instance.

3960

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

3961

"a_key": "A String",

3962

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3963

"lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format.

3964

"lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format.

3965

"lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3966

"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:

3967

# zones/us-central1-f/machineTypes/n1-standard-1

3968

#

3969

#

3970

# 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):

3971

# zones/zone/machineTypes/custom-CPUS-MEMORY

3972

#

3973

#

3974

# For example: zones/us-central1-f/machineTypes/custom-4-5120

3975

#

3976

# For a full list of restrictions, read the Specifications for custom machine types.

3977

"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

3978

"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.

3979

#

3980

# To see the latest fingerprint, make a get() request to retrieve the resource.

3981

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

3982

{

3983

"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.

3984

"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).

3985

},

3986

],

3987

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

3988

},

3989

"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".

3990

"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.

3991

"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.

3992

{ # A network interface resource attached to an instance.

3993

"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.

3994

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

3995

"externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.

3996

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3997

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

3998

"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.

3999

"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.

4000

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

4001

#

4002

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

4003

#

4004

# 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.

4005

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

4006

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

4007

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

4008

"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.

4009

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

4010

},

4011

],

4012

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

4013

{ # An alias IP range attached to an instance's network interface.

4014

"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).

4015

"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.

4016

},

4017

],

4018

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

4019

"internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range.

4020

"ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.

4021

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

4022

"externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.

4023

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

4024

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

4025

"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.

4026

"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.

4027

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

4028

#

4029

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

4030

#

4031

# 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.

4032

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

4033

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

4034

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

4035

"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.

4036

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

4037

},

4038

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4039

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

4040

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

4041

"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.

4042

"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.

4043

#

4044

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

4045

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

4046

# - projects/project/global/networks/network

4047

# - global/networks/default

4048

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

4049

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

4050

"queueCount": 42, # The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.

4051

"stackType": "A String", # The stack type for this network interface to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used.

4052

#

4053

# This field can be both set at instance creation and update network interface operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4054

"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:

4055

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

4056

# - regions/region/subnetworks/subnetwork

4057

},

4058

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4059

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4060

"preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api.

4061

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.

4062

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.

4063

"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.

4064

"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.

4065

"values": [ # Corresponds to the label values of a reservation resource.

"A String",

],

},

"resourcePolicies": [ # Resource policies applied to this instance.

4070

"A String",

4071

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4072

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

4073

"scheduling": { # Sets the scheduling options for an Instance. NextID: 13 # Sets the scheduling options for this instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4074

"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.

4075

#

4076

# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

4077

"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.

4078

"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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4079

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after instance creation where the instance won't be scheduled for maintenance.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

4080

"maintenanceInterval": "A String", # Specifies whether this VM may be a stable fleet VM. Setting this to "Periodic" designates this VM as a Stable Fleet VM.

4081

#

4082

# See go/stable-fleet-ug for more details.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4083

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

4084

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

4085

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

4086

"key": "A String", # Corresponds to the label key of Node resource.

4087

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

4088

"values": [ # Corresponds to the label values of Node resource.

"A String",

],

},

],

"onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4094

"preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4095

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4096

"secureLabels": [ # Secure labels to apply to this instance. These can be later modified by the update method. Maximum number of secure labels allowed is 300.

4097

"A String",

4098

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4099

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

4100

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

4101

"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

4102

#

4103

# 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.

4104

{ # A service account.

4105

"email": "A String", # Email address of the service account.

4106

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

4112

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

4113

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

4114

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

4115

},

4116

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

4117

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

4118

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4119

"shieldedVmConfig": { # A set of Shielded VM options. # Deprecating, please use shielded_instance_config.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4120

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

4121

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

4122

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

4123

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4124

"shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured. # Deprecating, please use shielded_instance_integrity_policy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4125

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

4126

},

4127

"sourceMachineImage": "A String", # Source machine image

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4128

"sourceMachineImageEncryptionKey": { # Source GMI encryption key when creating an instance from GMI.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4129

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

4130

"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.

4131

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

4132

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

4133

#

4134

# The key must meet the following requirements before you can provide it to Compute Engine:

4135

# - The key is wrapped using a RSA public key certificate provided by Google.

4136

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

4137

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

4138

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

4139

},

4140

"startRestricted": True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

4141

"status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4142

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

4143

"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.

4144

"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.

4145

#

4146

# To see the latest fingerprint, make get() request to the instance.

4147

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4152

"date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use start_time_window instead.

4153

"time": "A String", # [Output Only] The time when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use start_time_window instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4154

"type": "A String", # Defines the type of maintenance.

4155

},

4156

"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]

4157

},

4158

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4159

"kind": "compute#instanceList", # [Output Only] Type of resource. Always compute#instanceList for lists of Instance resources.

4160

"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.

4161

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

4162

"warning": { # [Output Only] Informational warning message.

4163

"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.

4164

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4165

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4166

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4167

"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).

4168

"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]

4169

},

4170

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4171

"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]

4172

},

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]

4177

<code class="details" id="listReferrers">listReferrers(project, zone, instance, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

4178

<pre>Retrieves a list of resources that refer to the VM instance specified in the request. For example, if the VM instance is part of a managed or unmanaged instance group, the referrers list includes the instance group. For more information, read Viewing referrers to VM instances.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4179

4180

Args:

4181

project: string, Project ID for this request. (required)

4182

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4183

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]

4184

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]

4185

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4186

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]

4187

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4188

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]

4189

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4190

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]

4191

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]

4192

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

4193

4194

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.

4195

4196

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4197

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]

4198

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]

4199

4200

Returns:

4201

An object of the form:

4202

4203

{ # Contains a list of instance referrers.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4204

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

4205

"items": [ # A list of Reference resources.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4206

{ # Represents a reference to a resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4207

"kind": "compute#reference", # [Output Only] Type of the resource. Always compute#reference for references.

4208

"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]

4209

# - MEMBER_OF

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4210

"referrer": "A String", # URL of the resource which refers to the target.

4211

"target": "A String", # URL of the resource to which this reference points.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4212

},

4213

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4214

"kind": "compute#instanceListReferrers", # [Output Only] Type of resource. Always compute#instanceListReferrers for lists of Instance referrers.

4215

"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.

4216

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

4217

"warning": { # [Output Only] Informational warning message.

4218

"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.

4219

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4220

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

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

"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).

4223

"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]

4224

},

4225

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4226

"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]

4227

},

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>

4233

<pre>Retrieves the next page of results.

4234

4235

Args:

4236

previous_request: The request for the previous page. (required)

4237

previous_response: The response from the request for the previous page. (required)

4238

4239

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4240

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4241

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]

4246

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

4247

<pre>Retrieves the next page of results.

4248

4249

Args:

4250

previous_request: The request for the previous page. (required)

4251

previous_response: The response from the request for the previous page. (required)

4252

4253

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4254

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4255

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]

4260

<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]

4261

<pre>Removes resource policies from an instance.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4262

4263

Args:

4264

project: string, Project ID for this request. (required)

4265

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4266

instance: string, The instance name for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4267

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4268

The object takes the form of:

4269

4270

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4271

"resourcePolicies": [ # Resource policies to be removed from this instance.

4272

"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.

4277

4278

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.

4279

4280

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]

4281

4282

Returns:

4283

An object of the form:

4284

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4285

{ # Represents an Operation resource.

4286

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4287

# Google Compute Engine has three Operation resources:

4288

#

4289

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4290

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4291

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4292

#

4293

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4294

# - For global operations, use the `globalOperations` resource.

4295

# - For regional operations, use the `regionOperations` resource.

4296

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4297

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4298

# 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]

4299

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4300

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4301

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4302

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4303

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4304

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4305

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4306

"code": "A String", # [Output Only] The error type identifier for this error.

4307

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4308

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4309

},

4310

],

4311

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4312

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4313

"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.

4314

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4315

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4316

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4317

"name": "A String", # [Output Only] Name of the operation.

4318

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4319

"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.

4320

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4321

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4322

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

4323

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4324

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4325

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4326

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4327

"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.

4328

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4329

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4330

{

4331

"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.

4332

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4333

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4334

{

4335

"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).

4336

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4337

},

4338

],

4339

"message": "A String", # [Output Only] A human-readable description of the warning code.

4340

},

4341

],

4342

"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>

4348

<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.

4349

4350

Args:

4351

project: string, Project ID for this request. (required)

4352

zone: string, The name of the zone for this request. (required)

4353

instance: string, Name of the instance scoping this request. (required)

4354

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.

4355

4356

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.

4357

4358

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

4359

4360

Returns:

4361

An object of the form:

4362

4363

{ # Represents an Operation resource.

4364

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4365

# Google Compute Engine has three Operation resources:

4366

#

4367

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4368

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4369

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4370

#

4371

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4372

# - For global operations, use the `globalOperations` resource.

4373

# - For regional operations, use the `regionOperations` resource.

4374

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4375

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4376

# 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]

4377

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4378

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4379

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4380

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4381

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4382

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4383

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4384

"code": "A String", # [Output Only] The error type identifier for this error.

4385

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4386

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4387

},

4388

],

4389

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4390

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4391

"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.

4392

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4393

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4394

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4395

"name": "A String", # [Output Only] Name of the operation.

4396

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4397

"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.

4398

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4399

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4400

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

4401

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4402

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4403

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4404

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4405

"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.

4406

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4407

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4408

{

4409

"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.

4410

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4411

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4412

{

4413

"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).

4414

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4415

},

4416

],

4417

"message": "A String", # [Output Only] A human-readable description of the warning code.

4418

},

4419

],

4420

"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]

4425

<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]

4426

<pre>Resumes an instance that was suspended using the instances().suspend method.

4427

4428

Args:

4429

project: string, Project ID for this request. (required)

4430

zone: string, The name of the zone for this request. (required)

4431

instance: string, Name of the instance resource to resume. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4432

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4433

The object takes the form of:

4434

4435

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4436

"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]

4437

#

4438

# In order to resume the instance, the disk url and its corresponding key must be provided.

4439

#

4440

# If the disk is not protected with a customer-supplied encryption key it should not be specified.

4441

{

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4442

"diskEncryptionKey": { # Decrypts data associated with the disk with a customer-supplied encryption key.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4443

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

4444

"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.

4445

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

4446

"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]

4447

#

4448

# The key must meet the following requirements before you can provide it to Compute Engine:

4449

# - The key is wrapped using a RSA public key certificate provided by Google.

4450

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

4451

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4452

"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]

4453

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4454

"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]

4455

},

4456

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4457

"instanceEncryptionKey": { # Decrypts data associated with an instance that is protected with a customer-supplied encryption key.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4458

#

4459

# 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.

4460

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

4461

"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.

4462

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

4463

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

4464

#

4465

# The key must meet the following requirements before you can provide it to Compute Engine:

4466

# - The key is wrapped using a RSA public key certificate provided by Google.

4467

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

4468

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

4469

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

4470

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4471

}

4472

4473

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.

4474

4475

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.

4476

4477

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

4478

4479

Returns:

4480

An object of the form:

4481

4482

{ # Represents an Operation resource.

4483

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4484

# Google Compute Engine has three Operation resources:

4485

#

4486

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4487

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4488

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4489

#

4490

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4491

# - For global operations, use the `globalOperations` resource.

4492

# - For regional operations, use the `regionOperations` resource.

4493

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4494

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4495

# 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]

4496

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4497

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4498

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4499

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4500

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4501

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4502

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4503

"code": "A String", # [Output Only] The error type identifier for this error.

4504

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4505

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4506

},

4507

],

4508

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4509

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4510

"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.

4511

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4512

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4513

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4514

"name": "A String", # [Output Only] Name of the operation.

4515

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4516

"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.

4517

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4518

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4519

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

4520

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4521

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4522

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4523

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4524

"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.

4525

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4526

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4527

{

4528

"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.

4529

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4530

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4531

{

4532

"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).

4533

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4534

},

4535

],

4536

"message": "A String", # [Output Only] A human-readable description of the warning code.

4537

},

4538

],

4539

"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>

4545

<pre>Sets deletion protection on the instance.

4546

4547

Args:

4548

project: string, Project ID for this request. (required)

4549

zone: string, The name of the zone for this request. (required)

4550

resource: string, Name or id of the resource for this request. (required)

4551

deletionProtection: boolean, Whether the resource should be protected against deletion.

4552

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.

4553

4554

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.

4555

4556

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

4557

4558

Returns:

4559

An object of the form:

4560

4561

{ # Represents an Operation resource.

4562

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4563

# Google Compute Engine has three Operation resources:

4564

#

4565

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4566

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4567

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4568

#

4569

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4570

# - For global operations, use the `globalOperations` resource.

4571

# - For regional operations, use the `regionOperations` resource.

4572

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4573

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4574

# 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]

4575

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4576

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4577

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4578

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4579

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4580

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4581

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4582

"code": "A String", # [Output Only] The error type identifier for this error.

4583

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4584

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4585

},

4586

],

4587

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4588

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4589

"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.

4590

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4591

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4592

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4593

"name": "A String", # [Output Only] Name of the operation.

4594

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4595

"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.

4596

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4597

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4598

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

4599

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4600

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4601

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4602

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4603

"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.

4604

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4605

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4606

{

4607

"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.

4608

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4609

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4610

{

4611

"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).

4612

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4613

},

4614

],

4615

"message": "A String", # [Output Only] A human-readable description of the warning code.

4616

},

4617

],

4618

"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]

4623

<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]

4624

<pre>Sets the auto-delete flag for a disk attached to an instance.

4625

4626

Args:

4627

project: string, Project ID for this request. (required)

4628

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4629

instance: string, The instance name for this request. (required)

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4630

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]

4631

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)

4632

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.

4633

4634

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.

4635

4636

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]

4637

4638

Returns:

4639

An object of the form:

4640

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4641

{ # Represents an Operation resource.

4642

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4643

# Google Compute Engine has three Operation resources:

4644

#

4645

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4646

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4647

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4648

#

4649

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4650

# - For global operations, use the `globalOperations` resource.

4651

# - For regional operations, use the `regionOperations` resource.

4652

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4653

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4654

# 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]

4655

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4656

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4657

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4658

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4659

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4660

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4661

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4662

"code": "A String", # [Output Only] The error type identifier for this error.

4663

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4664

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4665

},

4666

],

4667

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4668

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4669

"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.

4670

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4671

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4672

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4673

"name": "A String", # [Output Only] Name of the operation.

4674

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4675

"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.

4676

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4677

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4678

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

4679

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4680

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4681

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4682

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4683

"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.

4684

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4685

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4686

{

4687

"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.

4688

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4689

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4690

{

4691

"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).

4692

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4693

},

4694

],

4695

"message": "A String", # [Output Only] A human-readable description of the warning code.

4696

},

4697

],

4698

"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]

4703

<code class="details" id="setIamPolicy">setIamPolicy(project, zone, resource, body=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4704

<pre>Sets the access control policy on the specified resource. Replaces any existing policy.

4705

4706

Args:

4707

project: string, Project ID for this request. (required)

4708

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4709

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4710

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4711

The object takes the form of:

4712

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4713

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4714

"bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings.

4715

{ # Associates `members` with a `role`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4716

"bindingId": "A String", # A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4717

"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.

4718

#

4719

# If the condition evaluates to `true`, then this binding applies to the current request.

4720

#

4721

# 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.

4722

#

4723

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

4724

#

4725

# Example (Comparison):

4726

#

4727

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

4728

#

4729

# Example (Equality):

4730

#

4731

# 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'"

4736

#

4737

# Example (Data Manipulation):

4738

#

4739

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

4740

#

4741

# 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.

4742

"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.

4743

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

4744

"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.

4745

"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.

4746

},

4747

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

4748

#

4749

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

4750

#

4751

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

4752

#

4753

# * `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`.

4758

#

4759

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

4760

#

4761

# * `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.

4762

#

4763

# * `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.

4764

#

4765

# * `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`.

4770

"A String",

4771

],

4772

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

4773

},

4774

],

4775

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.

4776

"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]

4777

#

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4778

#

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4779

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4780

# 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]

4781

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4782

# 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]

4783

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4784

# **JSON example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4785

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4786

# { "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]

4787

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4788

# **YAML example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4789

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4790

# 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]

4791

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4792

# 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]

4793

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4794

{ # 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]

4795

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4796

# 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]

4797

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4798

# Example Policy with multiple AuditConfigs:

4799

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4800

# { "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]

4801

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4802

# 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]

4803

"auditLogConfigs": [ # The configuration for logging of each type of permission.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4804

{ # Provides the configuration for logging a type of permissions. Example:

4805

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4806

# { "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]

4807

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4808

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

4809

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

4810

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4811

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4812

"ignoreChildExemptions": True or False,

4813

"logType": "A String", # The log type that this config enables.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4814

},

4815

],

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]

4820

},

4821

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4822

"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]

4823

{ # Associates `members` with a `role`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4824

"bindingId": "A String", # A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4825

"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.

4826

#

4827

# If the condition evaluates to `true`, then this binding applies to the current request.

4828

#

4829

# 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.

4830

#

4831

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

4832

#

4833

# Example (Comparison):

4834

#

4835

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

4836

#

4837

# Example (Equality):

4838

#

4839

# 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'"

4844

#

4845

# Example (Data Manipulation):

4846

#

4847

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

4848

#

4849

# 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.

4850

"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.

4851

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

4852

"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.

4853

"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.

4854

},

4855

"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]

4856

#

4857

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

4858

#

4859

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

4860

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4861

# * `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`.

4866

#

4867

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

4868

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4869

# * `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.

4870

#

4871

# * `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.

4872

#

4873

# * `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.

4874

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4875

#

4876

#

4877

# * `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]

4878

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4879

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4880

"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]

4881

},

4882

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4883

"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.

4884

#

4885

# **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.

4886

"iamOwned": True or False,

4887

"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.

4888

{ # A rule to be applied in a Policy.

4889

"action": "A String", # Required

4890

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

4891

{ # A condition to be met.

4892

"iam": "A String", # Trusted attributes supplied by the IAM system.

4893

"op": "A String", # An operator to apply the subject with.

4894

"svc": "A String", # Trusted attributes discharged by the service.

4895

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

4896

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

4902

"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.

4903

"A String",

4904

],

4905

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

4906

{ # Specifies what kind of log the caller must write

4907

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

4908

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

4909

"permissionType": "A String", # The type of the permission that was checked.

4910

},

4911

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

4912

},

4913

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

4914

#

4915

# 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.

4916

#

4917

# Field names correspond to IAM request parameters and field values are their respective values.

4918

#

4919

# 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.

4920

#

4921

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

4922

"customFields": [ # Custom fields.

4923

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

4924

"name": "A String", # Name is the field name.

4925

"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.

4926

},

4927

],

4928

"field": "A String", # The field value to attribute.

4929

"metric": "A String", # The metric to update.

4930

},

4931

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

4932

"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.

4937

"A String",

4938

],

4939

"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.

4940

"A String",

4941

],

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4942

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4943

],

4944

"version": 42, # Specifies the format of the policy.

4945

#

4946

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

4947

#

4948

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

4949

#

4950

# * 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

4951

#

4952

# **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.

4953

#

4954

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

4955

#

4956

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

4957

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4958

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

Returns:

An object of the form:

4963

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4964

{ # 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]

4965

#

4966

#

4967

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4968

# 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]

4969

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4970

# 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]

4971

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4972

# **JSON example:**

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4973

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4974

# { "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]

4975

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4976

# **YAML example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4977

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4978

# 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]

4979

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4980

# 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]

4981

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4982

{ # 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]

4983

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4984

# 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]

4985

#

4986

# Example Policy with multiple AuditConfigs:

4987

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4988

# { "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]

4989

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4990

# 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]

4991

"auditLogConfigs": [ # The configuration for logging of each type of permission.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

4992

{ # Provides the configuration for logging a type of permissions. Example:

4993

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4994

# { "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]

4995

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4996

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

4997

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

4998

"A String",

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

4999

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5000

"ignoreChildExemptions": True or False,

5001

"logType": "A String", # The log type that this config enables.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

5002

},

5003

],

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]

5008

},

5009

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5010

"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]

5011

{ # Associates `members` with a `role`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5012

"bindingId": "A String", # A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5013

"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.

5014

#

5015

# If the condition evaluates to `true`, then this binding applies to the current request.

5016

#

5017

# 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.

5018

#

5019

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

5020

#

5021

# Example (Comparison):

5022

#

5023

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

5024

#

5025

# Example (Equality):

5026

#

5027

# 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'"

5032

#

5033

# Example (Data Manipulation):

5034

#

5035

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

5036

#

5037

# 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.

5038

"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.

5039

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

5040

"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.

5041

"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.

5042

},

5043

"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]

5044

#

5045

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

5046

#

5047

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

5048

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5049

# * `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]

5050

#

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

5051

#

5052

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5053

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

5054

#

5055

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

5056

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5057

# * `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.

5058

#

5059

# * `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.

5060

#

5061

# * `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.

5062

#

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

5063

#

5064

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5065

# * `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]

5066

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5067

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5068

"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]

5069

},

5070

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5071

"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.

5072

#

5073

# **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.

5074

"iamOwned": True or False,

5075

"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.

5076

{ # A rule to be applied in a Policy.

5077

"action": "A String", # Required

5078

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

5079

{ # A condition to be met.

5080

"iam": "A String", # Trusted attributes supplied by the IAM system.

5081

"op": "A String", # An operator to apply the subject with.

5082

"svc": "A String", # Trusted attributes discharged by the service.

5083

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

5084

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

5090

"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.

5091

"A String",

5092

],

5093

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

5094

{ # Specifies what kind of log the caller must write

5095

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

5096

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

5097

"permissionType": "A String", # The type of the permission that was checked.

5098

},

5099

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

5100

},

5101

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

5102

#

5103

# 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.

5104

#

5105

# Field names correspond to IAM request parameters and field values are their respective values.

5106

#

5107

# 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.

5108

#

5109

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

5110

"customFields": [ # Custom fields.

5111

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

5112

"name": "A String", # Name is the field name.

5113

"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.

5114

},

5115

],

5116

"field": "A String", # The field value to attribute.

5117

"metric": "A String", # The metric to update.

5118

},

5119

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

5120

"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.

5125

"A String",

5126

],

5127

"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.

5133

#

5134

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

5135

#

5136

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

5137

#

5138

# * 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

5139

#

5140

# **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.

5141

#

5142

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

5143

#

5144

# 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]

5149

<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]

5150

<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]

5151

5152

Args:

5153

project: string, Project ID for this request. (required)

5154

zone: string, The name of the zone for this request. (required)

5155

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5156

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5157

The object takes the form of:

5158

5159

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5160

"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.

5161

"labels": {

5162

"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]

5166

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.

5167

5168

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.

5169

5170

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]

5171

5172

Returns:

5173

An object of the form:

5174

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5175

{ # Represents an Operation resource.

5176

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5177

# Google Compute Engine has three Operation resources:

5178

#

5179

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5180

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5181

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5182

#

5183

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5184

# - For global operations, use the `globalOperations` resource.

5185

# - For regional operations, use the `regionOperations` resource.

5186

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5187

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5188

# 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]

5189

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5190

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5191

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5192

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5193

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5194

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5195

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5196

"code": "A String", # [Output Only] The error type identifier for this error.

5197

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5198

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5199

},

5200

],

5201

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5202

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5203

"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.

5204

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5205

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5206

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5207

"name": "A String", # [Output Only] Name of the operation.

5208

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5209

"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.

5210

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5211

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5212

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5213

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5214

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5215

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5216

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5217

"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.

5218

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5219

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5220

{

5221

"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.

5222

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5223

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5224

{

5225

"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).

5226

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5227

},

5228

],

5229

"message": "A String", # [Output Only] A human-readable description of the warning code.

5230

},

5231

],

5232

"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]

5237

<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]

5238

<pre>Changes the number and/or type of accelerator for a stopped instance to the values specified in the request.

5239

5240

Args:

5241

project: string, Project ID for this request. (required)

5242

zone: string, The name of the zone for this request. (required)

5243

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5244

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

5245

The object takes the form of:

5246

5247

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5248

"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]

5249

{ # 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]

5250

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

5251

"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]

5256

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.

5257

5258

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.

5259

5260

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]

5261

5262

Returns:

5263

An object of the form:

5264

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5265

{ # Represents an Operation resource.

5266

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5267

# Google Compute Engine has three Operation resources:

5268

#

5269

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5270

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5271

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5272

#

5273

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5274

# - For global operations, use the `globalOperations` resource.

5275

# - For regional operations, use the `regionOperations` resource.

5276

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5277

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5278

# 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]

5279

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5280

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5281

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5282

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5283

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5284

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

5285

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5286

"code": "A String", # [Output Only] The error type identifier for this error.

5287

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5288

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

5289

},

5290

],

5291

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5292

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5293

"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.

5294

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5295

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5296

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5297

"name": "A String", # [Output Only] Name of the operation.

5298

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5299

"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.

5300

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5301

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5302

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5303

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5304

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5305

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5306

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5307

"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.

5308

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5309

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5310

{

5311

"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.

5312

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5313

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5314

{

5315

"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).

5316

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5317

},

5318

],

5319

"message": "A String", # [Output Only] A human-readable description of the warning code.

5320

},

5321

],

5322

"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]

5327

<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]

5328

<pre>Changes the machine type for a stopped instance to the machine type specified in the request.

5329

5330

Args:

5331

project: string, Project ID for this request. (required)

5332

zone: string, The name of the zone for this request. (required)

5333

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5334

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5335

The object takes the form of:

5336

5337

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5338

"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]

5339

}

5340

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5341

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.

5342

5343

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.

5344

5345

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]

5346

5347

Returns:

5348

An object of the form:

5349

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5350

{ # Represents an Operation resource.

5351

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5352

# Google Compute Engine has three Operation resources:

5353

#

5354

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5355

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5356

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5357

#

5358

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5359

# - For global operations, use the `globalOperations` resource.

5360

# - For regional operations, use the `regionOperations` resource.

5361

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5362

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5363

# 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]

5364

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5365

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5366

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5367

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5368

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5369

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5370

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5371

"code": "A String", # [Output Only] The error type identifier for this error.

5372

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5373

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5374

},

5375

],

5376

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5377

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5378

"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.

5379

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5380

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5381

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5382

"name": "A String", # [Output Only] Name of the operation.

5383

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5384

"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.

5385

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5386

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5387

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5388

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5389

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5390

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5391

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5392

"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.

5393

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5394

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5395

{

5396

"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.

5397

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5398

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5399

{

5400

"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).

5401

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5402

},

5403

],

5404

"message": "A String", # [Output Only] A human-readable description of the warning code.

5405

},

5406

],

5407

"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]

5412

<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]

5413

<pre>Sets metadata for the specified instance to the data included in the request.

5414

5415

Args:

5416

project: string, Project ID for this request. (required)

5417

zone: string, The name of the zone for this request. (required)

5418

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5419

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5420

The object takes the form of:

5421

5422

{ # A metadata key/value entry.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5423

"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]

5424

#

5425

# 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]

5426

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

5427

{

5428

"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.

5429

"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).

5430

},

5431

],

5432

"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]

5433

}

5434

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5435

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.

5436

5437

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.

5438

5439

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]

5440

5441

Returns:

5442

An object of the form:

5443

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5444

{ # Represents an Operation resource.

5445

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5446

# Google Compute Engine has three Operation resources:

5447

#

5448

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5449

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5450

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5451

#

5452

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5453

# - For global operations, use the `globalOperations` resource.

5454

# - For regional operations, use the `regionOperations` resource.

5455

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5456

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5457

# 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]

5458

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5459

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5460

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5461

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5462

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5463

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5464

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5465

"code": "A String", # [Output Only] The error type identifier for this error.

5466

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5467

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5468

},

5469

],

5470

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5471

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5472

"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.

5473

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5474

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5475

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5476

"name": "A String", # [Output Only] Name of the operation.

5477

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5478

"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.

5479

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5480

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5481

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5482

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5483

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5484

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5485

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5486

"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.

5487

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5488

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5489

{

5490

"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.

5491

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5492

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5493

{

5494

"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).

5495

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5496

},

5497

],

5498

"message": "A String", # [Output Only] A human-readable description of the warning code.

5499

},

5500

],

5501

"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]

5506

<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]

5507

<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]

5508

5509

Args:

5510

project: string, Project ID for this request. (required)

5511

zone: string, The name of the zone for this request. (required)

5512

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5513

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

5514

The object takes the form of:

5515

5516

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5517

"minCpuPlatform": "A String", # Minimum cpu/platform this instance should be started at.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

5518

}

5519

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5520

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.

5521

5522

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.

5523

5524

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]

5525

5526

Returns:

5527

An object of the form:

5528

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5529

{ # Represents an Operation resource.

5530

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5531

# Google Compute Engine has three Operation resources:

5532

#

5533

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5534

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5535

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5536

#

5537

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5538

# - For global operations, use the `globalOperations` resource.

5539

# - For regional operations, use the `regionOperations` resource.

5540

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5541

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5542

# 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]

5543

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5544

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5545

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5546

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5547

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5548

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5549

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5550

"code": "A String", # [Output Only] The error type identifier for this error.

5551

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5552

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5553

},

5554

],

5555

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5556

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5557

"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.

5558

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5559

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5560

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5561

"name": "A String", # [Output Only] Name of the operation.

5562

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5563

"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.

5564

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5565

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5566

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5567

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5568

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5569

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5570

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5571

"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.

5572

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5573

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5574

{

5575

"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.

5576

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5577

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5578

{

5579

"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).

5580

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5581

},

5582

],

5583

"message": "A String", # [Output Only] A human-readable description of the warning code.

5584

},

5585

],

5586

"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]

5591

<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]

5592

<pre>Sets name of an instance.

5593

5594

Args:

5595

project: string, Project ID for this request. (required)

5596

zone: string, The name of the zone for this request. (required)

5597

instance: string, The instance name for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5598

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5599

The object takes the form of:

5600

5601

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5602

"currentName": "A String", # The current name of this resource, used to prevent conflicts. Provide the latest name when making a request to change name.

5603

"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]

5604

}

5605

5606

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.

5607

5608

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.

5609

5610

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

5611

5612

Returns:

5613

An object of the form:

5614

5615

{ # Represents an Operation resource.

5616

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5617

# Google Compute Engine has three Operation resources:

5618

#

5619

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5620

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5621

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5622

#

5623

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5624

# - For global operations, use the `globalOperations` resource.

5625

# - For regional operations, use the `regionOperations` resource.

5626

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5627

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5628

# 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]

5629

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5630

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5631

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5632

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5633

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5634

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

5635

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5636

"code": "A String", # [Output Only] The error type identifier for this error.

5637

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5638

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

5639

},

5640

],

5641

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5642

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5643

"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.

5644

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5645

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5646

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5647

"name": "A String", # [Output Only] Name of the operation.

5648

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5649

"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.

5650

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5651

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5652

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5653

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5654

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5655

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5656

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5657

"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.

5658

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5659

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5660

{

5661

"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.

5662

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5663

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5664

{

5665

"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).

5666

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5667

},

5668

],

5669

"message": "A String", # [Output Only] A human-readable description of the warning code.

5670

},

5671

],

5672

"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]

5677

<code class="details" id="setScheduling">setScheduling(project, zone, instance, body=None, requestId=None)</code>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5678

<pre>Sets an instance's scheduling options. You can only call this method on a stopped instance, that is, a VM instance that is in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5679

5680

Args:

5681

project: string, Project ID for this request. (required)

5682

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5683

instance: string, Instance name for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5684

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5685

The object takes the form of:

5686

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5687

{ # Sets the scheduling options for an Instance. NextID: 13

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5688

"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.

5689

#

5690

# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

5691

"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.

5692

"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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5693

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after instance creation where the instance won't be scheduled for maintenance.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

5694

"maintenanceInterval": "A String", # Specifies whether this VM may be a stable fleet VM. Setting this to "Periodic" designates this VM as a Stable Fleet VM.

5695

#

5696

# See go/stable-fleet-ug for more details.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5697

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

5698

"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]

5699

{ # 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]

5700

"key": "A String", # Corresponds to the label key of Node resource.

5701

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

5702

"values": [ # Corresponds to the label values of Node resource.

5703

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5704

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5705

},

5706

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5707

"onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5708

"preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5709

}

5710

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5711

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.

5712

5713

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.

5714

5715

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]

5716

5717

Returns:

5718

An object of the form:

5719

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5720

{ # Represents an Operation resource.

5721

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5722

# Google Compute Engine has three Operation resources:

5723

#

5724

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5725

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5726

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5727

#

5728

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5729

# - For global operations, use the `globalOperations` resource.

5730

# - For regional operations, use the `regionOperations` resource.

5731

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5732

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5733

# 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]

5734

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5735

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5736

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5737

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5738

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5739

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5740

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5741

"code": "A String", # [Output Only] The error type identifier for this error.

5742

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5743

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5744

},

5745

],

5746

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5747

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5748

"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.

5749

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5750

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5751

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5752

"name": "A String", # [Output Only] Name of the operation.

5753

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5754

"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.

5755

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5756

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5757

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5758

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5759

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5760

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5761

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5762

"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.

5763

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5764

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5765

{

5766

"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.

5767

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5768

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5769

{

5770

"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).

5771

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5772

},

5773

],

5774

"message": "A String", # [Output Only] A human-readable description of the warning code.

5775

},

5776

],

5777

"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]

5782

<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]

5783

<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]

5784

5785

Args:

5786

project: string, Project ID for this request. (required)

5787

zone: string, The name of the zone for this request. (required)

5788

instance: string, Name of the instance resource to start. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5789

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5790

The object takes the form of:

5791

5792

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5793

"email": "A String", # Email address of the service account.

5794

"scopes": [ # The list of scopes to be made available for this service account.

5795

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5796

],

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5797

}

5798

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5799

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.

5800

5801

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.

5802

5803

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]

5804

5805

Returns:

5806

An object of the form:

5807

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5808

{ # Represents an Operation resource.

5809

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5810

# Google Compute Engine has three Operation resources:

5811

#

5812

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5813

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5814

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5815

#

5816

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5817

# - For global operations, use the `globalOperations` resource.

5818

# - For regional operations, use the `regionOperations` resource.

5819

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5820

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5821

# 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]

5822

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5823

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5824

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5825

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5826

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5827

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5828

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5829

"code": "A String", # [Output Only] The error type identifier for this error.

5830

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5831

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5832

},

5833

],

5834

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5835

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5836

"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.

5837

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5838

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5839

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5840

"name": "A String", # [Output Only] Name of the operation.

5841

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5842

"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.

5843

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5844

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5845

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5846

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5847

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5848

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5849

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5850

"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.

5851

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5852

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5853

{

5854

"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.

5855

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5856

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5857

{

5858

"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).

5859

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5860

},

5861

],

5862

"message": "A String", # [Output Only] A human-readable description of the warning code.

5863

},

5864

],

5865

"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]

5870

<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]

5871

<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.

5872

5873

Args:

5874

project: string, Project ID for this request. (required)

5875

zone: string, The name of the zone for this request. (required)

5876

instance: string, Name or id of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5877

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5878

The object takes the form of:

5879

5880

{ # The policy describes the baseline against which Instance boot integrity is measured.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5881

"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]

5882

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5883

5884

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.

5885

5886

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.

5887

5888

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

5889

5890

Returns:

5891

An object of the form:

5892

5893

{ # Represents an Operation resource.

5894

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5895

# Google Compute Engine has three Operation resources:

5896

#

5897

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5898

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5899

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5900

#

5901

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5902

# - For global operations, use the `globalOperations` resource.

5903

# - For regional operations, use the `regionOperations` resource.

5904

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5905

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5906

# 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]

5907

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5908

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5909

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5910

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5911

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5912

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5913

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5914

"code": "A String", # [Output Only] The error type identifier for this error.

5915

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5916

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5917

},

5918

],

5919

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5920

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5921

"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.

5922

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5923

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5924

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5925

"name": "A String", # [Output Only] Name of the operation.

5926

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5927

"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.

5928

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5929

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5930

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5931

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5932

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5933

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5934

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5935

"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.

5936

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5937

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5938

{

5939

"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.

5940

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5941

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5942

{

5943

"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).

5944

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5945

},

5946

],

5947

"message": "A String", # [Output Only] A human-readable description of the warning code.

5948

},

5949

],

5950

"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]

5955

<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]

5956

<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.

5957

5958

Args:

5959

project: string, Project ID for this request. (required)

5960

zone: string, The name of the zone for this request. (required)

5961

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5962

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5963

The object takes the form of:

5964

5965

{ # 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]

5966

"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]

5967

}

5968

5969

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.

5970

5971

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.

5972

5973

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

5974

5975

Returns:

5976

An object of the form:

5977

5978

{ # Represents an Operation resource.

5979

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5980

# Google Compute Engine has three Operation resources:

5981

#

5982

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5983

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5984

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5985

#

5986

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5987

# - For global operations, use the `globalOperations` resource.

5988

# - For regional operations, use the `regionOperations` resource.

5989

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5990

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5991

# 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]

5992

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5993

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5994

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5995

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5996

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5997

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5998

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5999

"code": "A String", # [Output Only] The error type identifier for this error.

6000

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6001

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6002

},

6003

],

6004

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6005

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6006

"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.

6007

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6008

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6009

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6010

"name": "A String", # [Output Only] Name of the operation.

6011

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6012

"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.

6013

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6014

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6015

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

6016

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6017

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6018

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6019

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6020

"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.

6021

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6022

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6023

{

6024

"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.

6025

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6026

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6027

{

6028

"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).

6029

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6030

},

6031

],

6032

"message": "A String", # [Output Only] A human-readable description of the warning code.

6033

},

6034

],

6035

"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]

6040

<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]

6041

<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]

6042

6043

Args:

6044

project: string, Project ID for this request. (required)

6045

zone: string, The name of the zone for this request. (required)

6046

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6047

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6048

The object takes the form of:

6049

6050

{ # A set of instance tags.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6051

"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]

6052

#

6053

# To see the latest fingerprint, make get() request to the instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6054

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

6055

"A String",

6056

],

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6057

}

6058

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6059

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.

6060

6061

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.

6062

6063

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]

6064

6065

Returns:

6066

An object of the form:

6067

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6068

{ # Represents an Operation resource.

6069

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6070

# Google Compute Engine has three Operation resources:

6071

#

6072

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6073

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6074

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6075

#

6076

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6077

# - For global operations, use the `globalOperations` resource.

6078

# - For regional operations, use the `regionOperations` resource.

6079

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6080

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6081

# 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]

6082

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6083

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6084

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6085

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6086

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6087

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6088

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6089

"code": "A String", # [Output Only] The error type identifier for this error.

6090

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6091

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6092

},

6093

],

6094

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6095

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6096

"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.

6097

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6098

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6099

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6100

"name": "A String", # [Output Only] Name of the operation.

6101

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6102

"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.

6103

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6104

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6105

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

6106

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6107

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6108

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6109

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6110

"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.

6111

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6112

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6113

{

6114

"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.

6115

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6116

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6117

{

6118

"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).

6119

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6120

},

6121

],

6122

"message": "A String", # [Output Only] A human-readable description of the warning code.

6123

},

6124

],

6125

"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]

6130

<code class="details" id="simulateMaintenanceEvent">simulateMaintenanceEvent(project, zone, instance)</code>

6131

<pre>Simulates a maintenance event on the instance.

6132

6133

Args:

6134

project: string, Project ID for this request. (required)

6135

zone: string, The name of the zone for this request. (required)

6136

instance: string, Name of the instance scoping this request. (required)

6137

6138

Returns:

6139

An object of the form:

6140

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6141

{ # Represents an Operation resource.

6142

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6143

# Google Compute Engine has three Operation resources:

6144

#

6145

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6146

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6147

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6148

#

6149

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6150

# - For global operations, use the `globalOperations` resource.

6151

# - For regional operations, use the `regionOperations` resource.

6152

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6153

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6154

# 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]

6155

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6156

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6157

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6158

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6159

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6160

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

6161

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6162

"code": "A String", # [Output Only] The error type identifier for this error.

6163

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6164

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

6165

},

6166

],

6167

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6168

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6169

"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.

6170

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6171

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6172

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6173

"name": "A String", # [Output Only] Name of the operation.

6174

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6175

"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.

6176

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6177

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6178

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

6179

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6180

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6181

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6182

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6183

"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.

6184

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6185

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6186

{

6187

"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.

6188

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6189

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6190

{

6191

"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).

6192

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6193

},

6194

],

6195

"message": "A String", # [Output Only] A human-readable description of the warning code.

6196

},

6197

],

6198

"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]

6204

<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]

6205

6206

Args:

6207

project: string, Project ID for this request. (required)

6208

zone: string, The name of the zone for this request. (required)

6209

instance: string, Name of the instance resource to start. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6210

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.

6211

6212

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.

6213

6214

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]

6215

6216

Returns:

6217

An object of the form:

6218

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6219

{ # Represents an Operation resource.

6220

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6221

# Google Compute Engine has three Operation resources:

6222

#

6223

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6224

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6225

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6226

#

6227

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6228

# - For global operations, use the `globalOperations` resource.

6229

# - For regional operations, use the `regionOperations` resource.

6230

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6231

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6232

# 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]

6233

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6234

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6235

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6236

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6237

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6238

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6239

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6240

"code": "A String", # [Output Only] The error type identifier for this error.

6241

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6242

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6243

},

6244

],

6245

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6246

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6247

"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.

6248

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6249

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6250

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6251

"name": "A String", # [Output Only] Name of the operation.

6252

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6253

"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.

6254

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6255

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6256

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

6257

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6258

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6259

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6260

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6261

"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.

6262

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6263

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6264

{

6265

"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.

6266

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6267

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6268

{

6269

"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).

6270

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6271

},

6272

],

6273

"message": "A String", # [Output Only] A human-readable description of the warning code.

6274

},

6275

],

6276

"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]

6281

<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]

6282

<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]

6283

6284

Args:

6285

project: string, Project ID for this request. (required)

6286

zone: string, The name of the zone for this request. (required)

6287

instance: string, Name of the instance resource to start. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6288

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6289

The object takes the form of:

6290

6291

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6292

"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]

6293

#

6294

# In order to start the instance, the disk url and its corresponding key must be provided.

6295

#

6296

# If the disk is not protected with a customer-supplied encryption key it should not be specified.

6297

{

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6298

"diskEncryptionKey": { # Decrypts data associated with the disk with a customer-supplied encryption key.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6299

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

6300

"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.

6301

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

6302

"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]

6303

#

6304

# The key must meet the following requirements before you can provide it to Compute Engine:

6305

# - 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]

6306

# - 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]

6307

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6308

"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]

6309

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6310

"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]

6311

},

6312

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6313

"instanceEncryptionKey": { # Decrypts data associated with an instance that is protected with a customer-supplied encryption key.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6314

#

6315

# 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.

6316

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

6317

"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.

6318

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

6319

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

6320

#

6321

# The key must meet the following requirements before you can provide it to Compute Engine:

6322

# - The key is wrapped using a RSA public key certificate provided by Google.

6323

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

6324

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

6325

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

6326

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6327

}

6328

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6329

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.

6330

6331

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.

6332

6333

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]

6334

6335

Returns:

6336

An object of the form:

6337

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6338

{ # Represents an Operation resource.

6339

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6340

# Google Compute Engine has three Operation resources:

6341

#

6342

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6343

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6344

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6345

#

6346

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6347

# - For global operations, use the `globalOperations` resource.

6348

# - For regional operations, use the `regionOperations` resource.

6349

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6350

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6351

# 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]

6352

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6353

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6354

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6355

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6356

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6357

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6358

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6359

"code": "A String", # [Output Only] The error type identifier for this error.

6360

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6361

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6362

},

6363

],

6364

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6365

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6366

"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.

6367

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6368

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6369

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6370

"name": "A String", # [Output Only] Name of the operation.

6371

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6372

"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.

6373

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6374

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6375

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

6376

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6377

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6378

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6379

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6380

"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.

6381

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6382

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6383

{

6384

"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.

6385

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6386

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6387

{

6388

"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).

6389

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6390

},

6391

],

6392

"message": "A String", # [Output Only] A human-readable description of the warning code.

6393

},

6394

],

6395

"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]

6400

<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]

6401

<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]

6402

6403

Args:

6404

project: string, Project ID for this request. (required)

6405

zone: string, The name of the zone for this request. (required)

6406

instance: string, Name of the instance resource to stop. (required)

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

6407

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]

6408

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.

6409

6410

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.

6411

6412

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]

6413

6414

Returns:

6415

An object of the form:

6416

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6417

{ # Represents an Operation resource.

6418

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6419

# Google Compute Engine has three Operation resources:

6420

#

6421

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6422

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6423

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6424

#

6425

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6426

# - For global operations, use the `globalOperations` resource.

6427

# - For regional operations, use the `regionOperations` resource.

6428

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6429

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6430

# 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]

6431

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6432

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6433

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6434

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6435

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6436

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6437

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6438

"code": "A String", # [Output Only] The error type identifier for this error.

6439

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6440

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6441

},

6442

],

6443

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6444

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6445

"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.

6446

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6447

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6448

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6449

"name": "A String", # [Output Only] Name of the operation.

6450

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6451

"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.

6452

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6453

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6454

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

6455

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6456

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6457

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6458

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6459

"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.

6460

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6461

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6462

{

6463

"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.

6464

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6465

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6466

{

6467

"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).

6468

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6469

},

6470

],

6471

"message": "A String", # [Output Only] A human-readable description of the warning code.

6472

},

6473

],

6474

"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]

6479

<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]

6480

<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.

6481

6482

Args:

6483

project: string, Project ID for this request. (required)

6484

zone: string, The name of the zone for this request. (required)

6485

instance: string, Name of the instance resource to suspend. (required)

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

6486

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]

6487

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.

6488

6489

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.

6490

6491

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]

6492

6493

Returns:

6494

An object of the form:

6495

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6496

{ # Represents an Operation resource.

6497

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6498

# Google Compute Engine has three Operation resources:

6499

#

6500

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6501

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6502

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6503

#

6504

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6505

# - For global operations, use the `globalOperations` resource.

6506

# - For regional operations, use the `regionOperations` resource.

6507

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6508

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6509

# 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]

6510

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6511

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6512

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6513

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6514

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6515

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6516

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6517

"code": "A String", # [Output Only] The error type identifier for this error.

6518

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6519

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6520

},

6521

],

6522

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6523

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6524

"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.

6525

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6526

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6527

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6528

"name": "A String", # [Output Only] Name of the operation.

6529

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6530

"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.

6531

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6532

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6533

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

6534

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6535

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6536

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6537

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6538

"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.

6539

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6540

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6541

{

6542

"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.

6543

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6544

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6545

{

6546

"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).

6547

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6548

},

6549

],

6550

"message": "A String", # [Output Only] A human-readable description of the warning code.

6551

},

6552

],

6553

"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]

6558

<code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6559

<pre>Returns permissions that a caller has on the specified resource.

6560

6561

Args:

6562

project: string, Project ID for this request. (required)

6563

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6564

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6565

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6566

The object takes the form of:

6567

6568

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6569

"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.

6570

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

],

}

Returns:

An object of the form:

6577

6578

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6579

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.

6580

"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]

6586

<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]

6587

<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.

6588

6589

Args:

6590

project: string, Project ID for this request. (required)

6591

zone: string, The name of the zone for this request. (required)

6592

instance: string, Name of the instance resource to update. (required)

6593

body: object, The request body.

6594

The object takes the form of:

6595

6596

{ # Represents an Instance resource.

6597

#

6598

# 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 ==)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6599

"advancedMachineFeatures": { # Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of an Image (e.g., whether or not the OS in the Image supports nested virtualization being enabled or disabled). # Controls for advanced machine-related behavior features.

6600

"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).

6601

"threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.

6602

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6603

"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.

6604

"confidentialInstanceConfig": { # A set of Confidential Instance options.

6605

"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]

6606

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6607

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

6608

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

6609

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

6610

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

6611

"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]

6612

{ # An instance-attached disk resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6613

"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).

6614

"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.

6615

"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.

6616

#

6617

# If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6618

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6619

#

6620

# 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.

6621

#

6622

# 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.

6623

#

6624

# 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.

6625

#

6626

# 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]

6627

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

6628

"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.

6629

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

6630

"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]

6631

#

6632

# The key must meet the following requirements before you can provide it to Compute Engine:

6633

# - The key is wrapped using a RSA public key certificate provided by Google.

6634

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

6635

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6636

"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]

6637

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6638

"diskSizeGb": "A String", # The size of the disk in GB.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

6639

"forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6640

"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.

6641

{ # Guest OS features.

6642

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

6643

},

6644

],

6645

"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.

6646

"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]

6647

#

6648

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

6649

#

6650

# 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]

6651

"description": "A String", # An optional description. Provide this property when creating the disk.

6652

"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.

6653

"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.

6654

"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]

6655

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

6656

#

6657

#

6658

# 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:

6659

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType

6660

# - projects/project/zones/zone/diskTypes/diskType

6661

# - 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]

6662

"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]

6663

#

6664

# Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

6665

{ # Guest OS features.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6666

"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]

6667

},

6668

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6669

"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.

6670

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6671

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

6672

"multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6673

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6674

"provisionedIops": "A String", # Indicates how many IOPS must be provisioned for the disk.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6675

"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

6676

"A String",

6677

],

6678

"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.

6679

"A String",

6680

],

6681

"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]

6682

#

6683

# 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:

6684

# projects/debian-cloud/global/images/family/debian-9

6685

#

6686

#

6687

# Alternatively, use a specific version of a public operating system image:

6688

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

6689

#

6690

#

6691

# To create a disk with a custom image that you created, specify the image name in the following format:

6692

# global/images/my-custom-image

6693

#

6694

#

6695

# 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:

6696

# global/images/family/my-image-family

6697

#

6698

#

6699

# If the source image is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6700

"sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6701

#

6702

# 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.

6703

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

6704

"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.

6705

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

6706

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

6707

#

6708

# The key must meet the following requirements before you can provide it to Compute Engine:

6709

# - The key is wrapped using a RSA public key certificate provided by Google.

6710

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

6711

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

6712

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

6713

},

6714

"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.

6715

#

6716

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

6717

# global/snapshots/my-backup

6718

#

6719

#

6720

# If the source snapshot is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6721

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6722

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

6723

"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.

6724

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

6725

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

6726

#

6727

# The key must meet the following requirements before you can provide it to Compute Engine:

6728

# - The key is wrapped using a RSA public key certificate provided by Google.

6729

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

6730

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

6731

"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]

6732

},

6733

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6734

"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.

6735

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

6736

"licenses": [ # [Output Only] Any valid publicly visible licenses.

6737

"A String",

6738

],

6739

"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.

6740

"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.

6741

"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

6742

"dbs": [ # The Key Database (db).

6743

{

6744

"content": "A String", # The raw content in the secure keys file.

6745

"fileType": "A String", # The file type of source file.

6746

},

6747

],

6748

"dbxs": [ # The forbidden key database (dbx).

6749

{

6750

"content": "A String", # The raw content in the secure keys file.

6751

"fileType": "A String", # The file type of source file.

6752

},

6753

],

6754

"keks": [ # The Key Exchange Key (KEK).

6755

{

6756

"content": "A String", # The raw content in the secure keys file.

6757

"fileType": "A String", # The file type of source file.

6758

},

6759

],

6760

"pk": { # The Platform Key (PK).

6761

"content": "A String", # The raw content in the secure keys file.

6762

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6763

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6764

},

6765

"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]

6766

#

6767

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

6768

#

6769

# 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]

6770

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

6771

"userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of URLs to the license resource. Unlike regular licenses, user provided licenses can be modified after the disk is created.

6772

"A String",

6773

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6774

},

6775

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6776

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

6777

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6778

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6779

"eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.

6780

"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.

6781

#

6782

# To see the latest fingerprint, make get() request to the instance.

6783

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

6784

{ # A specification of the type and number of accelerator cards attached to the instance.

6785

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

6786

"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.

6787

},

6788

],

6789

"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.

6790

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6791

"instanceEncryptionKey": { # Encrypts or decrypts data for an instance with a customer-supplied encryption key.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6792

#

6793

# 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.

6794

#

6795

# 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.

6796

#

6797

# 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.

6798

#

6799

# 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.

6800

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

6801

"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.

6802

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

6803

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

6804

#

6805

# The key must meet the following requirements before you can provide it to Compute Engine:

6806

# - The key is wrapped using a RSA public key certificate provided by Google.

6807

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

6808

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

6809

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

6810

},

6811

"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.

6812

"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.

6813

#

6814

# To see the latest fingerprint, make get() request to the instance.

6815

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

6816

"a_key": "A String",

6817

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

6818

"lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format.

6819

"lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format.

6820

"lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6821

"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:

6822

# zones/us-central1-f/machineTypes/n1-standard-1

6823

#

6824

#

6825

# 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):

6826

# zones/zone/machineTypes/custom-CPUS-MEMORY

6827

#

6828

#

6829

# For example: zones/us-central1-f/machineTypes/custom-4-5120

6830

#

6831

# For a full list of restrictions, read the Specifications for custom machine types.

6832

"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

6833

"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.

6834

#

6835

# To see the latest fingerprint, make a get() request to retrieve the resource.

6836

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

6837

{

6838

"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.

6839

"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).

6840

},

6841

],

6842

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

6843

},

6844

"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".

6845

"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.

6846

"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.

6847

{ # A network interface resource attached to an instance.

6848

"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.

6849

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

6850

"externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.

6851

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6852

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

6853

"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.

6854

"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.

6855

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

6856

#

6857

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

6858

#

6859

# 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.

6860

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

6861

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

6862

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

6863

"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.

6864

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

6865

},

6866

],

6867

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

6868

{ # An alias IP range attached to an instance's network interface.

6869

"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).

6870

"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.

6871

},

6872

],

6873

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

6874

"internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range.

6875

"ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.

6876

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

6877

"externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.

6878

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

6879

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

6880

"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.

6881

"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.

6882

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

6883

#

6884

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

6885

#

6886

# 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.

6887

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

6888

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

6889

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

6890

"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.

6891

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

6892

},

6893

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6894

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

6895

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

6896

"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.

6897

"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.

6898

#

6899

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

6900

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

6901

# - projects/project/global/networks/network

6902

# - global/networks/default

6903

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

6904

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

6905

"queueCount": 42, # The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.

6906

"stackType": "A String", # The stack type for this network interface to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used.

6907

#

6908

# This field can be both set at instance creation and update network interface operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6909

"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:

6910

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

6911

# - regions/region/subnetworks/subnetwork

6912

},

6913

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6914

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6915

"preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api.

6916

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.

6917

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.

6918

"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.

6919

"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.

6920

"values": [ # Corresponds to the label values of a reservation resource.

"A String",

],

},

"resourcePolicies": [ # Resource policies applied to this instance.

6925

"A String",

6926

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6927

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

6928

"scheduling": { # Sets the scheduling options for an Instance. NextID: 13 # Sets the scheduling options for this instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6929

"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.

6930

#

6931

# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

6932

"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.

6933

"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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

6934

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after instance creation where the instance won't be scheduled for maintenance.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

6935

"maintenanceInterval": "A String", # Specifies whether this VM may be a stable fleet VM. Setting this to "Periodic" designates this VM as a Stable Fleet VM.

6936

#

6937

# See go/stable-fleet-ug for more details.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6938

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

6939

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

6940

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

6941

"key": "A String", # Corresponds to the label key of Node resource.

6942

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

6943

"values": [ # Corresponds to the label values of Node resource.

"A String",

],

},

],

"onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

6949

"preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6950

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6951

"secureLabels": [ # Secure labels to apply to this instance. These can be later modified by the update method. Maximum number of secure labels allowed is 300.

6952

"A String",

6953

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6954

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

6955

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

6956

"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

6957

#

6958

# 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.

6959

{ # A service account.

6960

"email": "A String", # Email address of the service account.

6961

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

6967

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

6968

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

6969

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

6970

},

6971

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

6972

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

6973

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6974

"shieldedVmConfig": { # A set of Shielded VM options. # Deprecating, please use shielded_instance_config.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6975

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

6976

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

6977

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

6978

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6979

"shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured. # Deprecating, please use shielded_instance_integrity_policy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6980

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

6981

},

6982

"sourceMachineImage": "A String", # Source machine image

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6983

"sourceMachineImageEncryptionKey": { # Source GMI encryption key when creating an instance from GMI.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6984

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

6985

"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.

6986

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

6987

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

6988

#

6989

# The key must meet the following requirements before you can provide it to Compute Engine:

6990

# - The key is wrapped using a RSA public key certificate provided by Google.

6991

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

6992

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

6993

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

6994

},

6995

"startRestricted": True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

6996

"status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6997

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

6998

"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.

6999

"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.

7000

#

7001

# To see the latest fingerprint, make get() request to the instance.

7002

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

7007

"date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use start_time_window instead.

7008

"time": "A String", # [Output Only] The time when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use start_time_window instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7009

"type": "A String", # Defines the type of maintenance.

7010

},

7011

"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]

7012

}

7013

7014

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]

7020

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]

7026

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.

7027

7028

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.

7029

7030

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]

7031

7032

Returns:

7033

An object of the form:

7034

7035

{ # Represents an Operation resource.

7036

#

7037

# Google Compute Engine has three Operation resources:

7038

#

7039

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

7040

#

7041

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

7042

#

7043

# Operations can be global, regional or zonal.

7044

# - For global operations, use the `globalOperations` resource.

7045

# - For regional operations, use the `regionOperations` resource.

7046

# - For zonal operations, use the `zonalOperations` resource.

7047

#

7048

# 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]

7049

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

7050

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

7051

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

7052

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

7053

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

7054

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7055

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7056

"code": "A String", # [Output Only] The error type identifier for this error.

7057

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

7058

"message": "A String", # [Output Only] An optional, human-readable error message.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7059

},

7060

],

7061

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7062

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

7063

"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.

7064

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

7065

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

7066

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

7067

"name": "A String", # [Output Only] Name of the operation.

7068

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

7069

"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.

7070

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

7071

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

7072

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

7073

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

7074

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

7075

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

7076

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

7077

"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.

7078

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

7079

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

7080

{

7081

"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.

7082

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

7083

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

7084

{

7085

"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).

7086

"value": "A String", # [Output Only] A warning data value corresponding to the key.

7087

},

7088

],

7089

"message": "A String", # [Output Only] A human-readable description of the warning code.

7090

},

7091

],

7092

"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]

7098

<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]

7099

7100

Args:

7101

project: string, Project ID for this request. (required)

7102

zone: string, The name of the zone for this request. (required)

7103

instance: string, The instance name for this request. (required)

7104

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]

7105

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

7106

The object takes the form of:

7107

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7108

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

7109

"externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.

7110

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7111

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

7112

"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.

7113

"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.

7114

"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]

7115

#

7116

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

7117

#

7118

# 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]

7119

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

7120

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

7121

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

7122

"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.

7123

"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]

7124

}

7125

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7126

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.

7127

7128

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.

7129

7130

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]

7131

7132

Returns:

7133

An object of the form:

7134

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7135

{ # Represents an Operation resource.

7136

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7137

# Google Compute Engine has three Operation resources:

7138

#

7139

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

7140

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7141

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

7142

#

7143

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7144

# - For global operations, use the `globalOperations` resource.

7145

# - For regional operations, use the `regionOperations` resource.

7146

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7147

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7148

# 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]

7149

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

7150

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

7151

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

7152

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

7153

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

7154

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7155

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7156

"code": "A String", # [Output Only] The error type identifier for this error.

7157

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

7158

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7159

},

7160

],

7161

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7162

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

7163

"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.

7164

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

7165

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

7166

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

7167

"name": "A String", # [Output Only] Name of the operation.

7168

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

7169

"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.

7170

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

7171

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

7172

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

7173

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

7174

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

7175

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

7176

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

7177

"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.

7178

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

7179

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

7180

{

7181

"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.

7182

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

7183

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

7184

{

7185

"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).

7186

"value": "A String", # [Output Only] A warning data value corresponding to the key.

7187

},

7188

],

7189

"message": "A String", # [Output Only] A human-readable description of the warning code.

7190

},

7191

],

7192

"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]

7197

<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]

7198

<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.

7199

7200

Args:

7201

project: string, Project ID for this request. (required)

7202

zone: string, The name of the zone for this request. (required)

7203

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7204

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7205

The object takes the form of:

7206

7207

{ # A set of Display Device options

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7208

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7209

}

7210

7211

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.

7212

7213

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.

7214

7215

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

7216

7217

Returns:

7218

An object of the form:

7219

7220

{ # Represents an Operation resource.

7221

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7222

# Google Compute Engine has three Operation resources:

7223

#

7224

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

7225

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7226

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

7227

#

7228

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7229

# - For global operations, use the `globalOperations` resource.

7230

# - For regional operations, use the `regionOperations` resource.

7231

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7232

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7233

# 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]

7234

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

7235

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

7236

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

7237

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

7238

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

7239

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

7240

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7241

"code": "A String", # [Output Only] The error type identifier for this error.

7242

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

7243

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

7244

},

7245

],

7246

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7247

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

7248

"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.

7249

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

7250

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

7251

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

7252

"name": "A String", # [Output Only] Name of the operation.

7253

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

7254

"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.

7255

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

7256

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

7257

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

7258

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

7259

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

7260

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

7261

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

7262

"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.

7263

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

7264

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

7265

{

7266

"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.

7267

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

7268

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

7269

{

7270

"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).

7271

"value": "A String", # [Output Only] A warning data value corresponding to the key.

7272

},

7273

],

7274

"message": "A String", # [Output Only] A human-readable description of the warning code.

7275

},

7276

],

7277

"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]

7281

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7282

<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]

7283

<pre>Updates an instance's network interface. This method follows PATCH semantics.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

7284

7285

Args:

7286

project: string, Project ID for this request. (required)

7287

zone: string, The name of the zone for this request. (required)

7288

instance: string, The instance name for this request. (required)

7289

networkInterface: string, The name of the network interface to update. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7290

body: object, The request body.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

7291

The object takes the form of:

7292

7293

{ # A network interface resource attached to an instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7294

"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.

7295

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

7296

"externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.

7297

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7298

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

7299

"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.

7300

"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.

7301

"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]

7302

#

7303

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

7304

#

7305

# 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]

7306

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

7307

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

7308

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

7309

"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.

7310

"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]

7311

},

7312

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7313

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

7314

{ # An alias IP range attached to an instance's network interface.

7315

"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).

7316

"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.

7317

},

7318

],

7319

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

7320

"internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range.

7321

"ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.

7322

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

7323

"externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.

7324

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

7325

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

7326

"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.

7327

"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.

7328

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

7329

#

7330

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

7331

#

7332

# 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.

7333

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

7334

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

7335

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

7336

"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.

7337

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

7338

},

7339

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7340

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

7341

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

7342

"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.

7343

"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]

7344

#

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

7345

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

7346

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

7347

# - projects/project/global/networks/network

7348

# - global/networks/default

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7349

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

7350

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

7351

"queueCount": 42, # The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.

7352

"stackType": "A String", # The stack type for this network interface to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used.

7353

#

7354

# This field can be both set at instance creation and update network interface operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7355

"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:

7356

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

7357

# - regions/region/subnetworks/subnetwork

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

7358

}

7359

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7360

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.

7361

7362

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.

7363

7364

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]

7365

7366

Returns:

7367

An object of the form:

7368

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7369

{ # Represents an Operation resource.

7370

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7371

# Google Compute Engine has three Operation resources:

7372

#

7373

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

7374

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7375

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

7376

#

7377

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7378

# - For global operations, use the `globalOperations` resource.

7379

# - For regional operations, use the `regionOperations` resource.

7380

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7381

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7382

# 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]

7383

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

7384

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

7385

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

7386

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

7387

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

7388

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7389

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7390

"code": "A String", # [Output Only] The error type identifier for this error.

7391

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

7392

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7393

},

7394

],

7395

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7396

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

7397

"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.

7398

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

7399

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

7400

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

7401

"name": "A String", # [Output Only] Name of the operation.

7402

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

7403

"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.

7404

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

7405

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

7406

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

7407

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

7408

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

7409

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

7410

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

7411

"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.

7412

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

7413

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

7414

{

7415

"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.

7416

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

7417

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

7418

{

7419

"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).

7420

"value": "A String", # [Output Only] A warning data value corresponding to the key.

7421

},

7422

],

7423

"message": "A String", # [Output Only] A human-readable description of the warning code.

7424

},

7425

],

7426

"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]

7431

<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]

7432

<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.

7433

7434

Args:

7435

project: string, Project ID for this request. (required)

7436

zone: string, The name of the zone for this request. (required)

7437

instance: string, Name or id of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7438

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7439

The object takes the form of:

7440

7441

{ # A set of Shielded Instance options.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7442

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

7443

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

7444

"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]

7445

}

7446

7447

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.

7448

7449

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.

7450

7451

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

7452

7453

Returns:

7454

An object of the form:

7455

7456

{ # Represents an Operation resource.

7457

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7458

# Google Compute Engine has three Operation resources:

7459

#

7460

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

7461

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7462

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

7463

#

7464

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7465

# - For global operations, use the `globalOperations` resource.

7466

# - For regional operations, use the `regionOperations` resource.

7467

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7468

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7469

# 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]

7470

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

7471

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

7472

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

7473

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

7474

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

7475

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7476

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7477

"code": "A String", # [Output Only] The error type identifier for this error.

7478

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

7479

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7480

},

7481

],

7482

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7483

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

7484

"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.

7485

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

7486

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

7487

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

7488

"name": "A String", # [Output Only] Name of the operation.

7489

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

7490

"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.

7491

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

7492

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

7493

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

7494

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

7495

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

7496

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

7497

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

7498

"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.

7499

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

7500

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

7501

{

7502

"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.

7503

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

7504

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

7505

{

7506

"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).

7507

"value": "A String", # [Output Only] A warning data value corresponding to the key.

7508

},

7509

],

7510

"message": "A String", # [Output Only] A human-readable description of the warning code.

7511

},

7512

],

7513

"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]

7518

<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]

7519

<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.

7520

7521

Args:

7522

project: string, Project ID for this request. (required)

7523

zone: string, The name of the zone for this request. (required)

7524

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7525

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7526

The object takes the form of:

7527

7528

{ # A set of Shielded VM options.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7529

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

7530

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

7531

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7532

}

7533

7534

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.

7535

7536

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.

7537

7538

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

7539

7540

Returns:

7541

An object of the form:

7542

7543

{ # Represents an Operation resource.

7544

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7545

# Google Compute Engine has three Operation resources:

7546

#

7547

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

7548

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7549

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

7550

#

7551

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7552

# - For global operations, use the `globalOperations` resource.

7553

# - For regional operations, use the `regionOperations` resource.

7554

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7555

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7556

# 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]

7557

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

7558

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

7559

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

7560

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

7561

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

7562

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

7563

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7564

"code": "A String", # [Output Only] The error type identifier for this error.

7565

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

7566

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

7567

},

7568

],

7569

},

Bu Sun Kim