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

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

810

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

811

"A String",

812

],

Bu Sun Kim

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

[diff] [blame]

813

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

814

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

815

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

816

#

817

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

818

{ # A service account.

819

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

820

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

"A String",

],

},

],

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

826

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

827

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

828

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

829

},

830

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

831

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

832

},

Dmitry Frenkel

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

[diff] [blame]

833

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

834

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

835

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

836

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

837

},

Dmitry Frenkel

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

[diff] [blame]

838

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

839

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

840

},

841

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

Dmitry Frenkel

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

[diff] [blame]

842

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

Bu Sun Kim

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

[diff] [blame]

843

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

844

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

845

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

846

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

847

#

848

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

849

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

850

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

851

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

852

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

853

},

854

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

855

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

856

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

857

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

858

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

859

#

860

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

861

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

866

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

867

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

868

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

869

},

870

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

871

},

872

],

Bu Sun Kim

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

[diff] [blame]

873

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

874

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

875

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

876

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

Sai Cheemalapati

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

[diff] [blame]

877

{

Bu Sun Kim

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

[diff] [blame]

878

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

879

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

Sai Cheemalapati

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

[diff] [blame]

880

},

881

],

Bu Sun Kim

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

[diff] [blame]

882

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

Sai Cheemalapati

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

[diff] [blame]

883

},

884

},

885

},

Bu Sun Kim

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

[diff] [blame]

886

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

887

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

888

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

889

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

890

"A String",

891

],

892

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

893

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

894

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

895

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

Bu Sun Kim

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

[diff] [blame]

896

{

Bu Sun Kim

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

[diff] [blame]

897

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

898

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

899

},

900

],

Bu Sun Kim

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

[diff] [blame]

901

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

902

},

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>

908

<pre>Retrieves the next page of results.

909

910

Args:

911

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

912

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

913

914

Returns:

Bu Sun Kim

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

[diff] [blame]

915

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

Sai Cheemalapati

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

[diff] [blame]

916

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]

921

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

922

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

923

924

Args:

925

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

926

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

927

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

Dan O'Meara

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

[diff] [blame]

928

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

929

The object takes the form of:

930

931

{ # An instance-attached disk resource.

Bu Sun Kim

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

[diff] [blame]

932

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

933

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

934

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

935

#

936

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

937

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

Sai Cheemalapati

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

[diff] [blame]

938

#

939

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

940

#

941

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

942

#

943

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

944

#

945

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

946

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

947

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

948

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

949

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

950

#

951

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

952

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

953

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

954

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

Bu Sun Kim

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

[diff] [blame]

955

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

956

},

Bu Sun Kim

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

[diff] [blame]

957

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

Bu Sun Kim

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

[diff] [blame]

958

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

959

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

960

{ # Guest OS features.

961

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

962

},

963

],

964

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

965

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

966

#

967

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

968

#

969

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

970

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

971

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

972

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

973

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

974

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

975

#

Bu Sun Kim

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

[diff] [blame]

976

#

Sai Cheemalapati

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

[diff] [blame]

977

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

978

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

979

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

980

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

981

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

982

#

983

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

984

{ # Guest OS features.

Bu Sun Kim

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

[diff] [blame]

985

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

986

},

987

],

Bu Sun Kim

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

[diff] [blame]

988

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

989

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

990

},

Bu Sun Kim

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

[diff] [blame]

991

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

992

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

993

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

994

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

995

"A String",

996

],

997

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

998

"A String",

999

],

1000

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

1001

#

Bu Sun Kim

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

[diff] [blame]

1002

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

1003

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

Sai Cheemalapati

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

[diff] [blame]

1004

#

Sai Cheemalapati

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

[diff] [blame]

1005

#

1006

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

Bu Sun Kim

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

[diff] [blame]

1007

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

Sai Cheemalapati

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

[diff] [blame]

1008

#

Sai Cheemalapati

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

[diff] [blame]

1009

#

Bu Sun Kim

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

[diff] [blame]

1010

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

1011

# global/images/my-custom-image

Sai Cheemalapati

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

[diff] [blame]

1012

#

Sai Cheemalapati

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

[diff] [blame]

1013

#

Bu Sun Kim

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

[diff] [blame]

1014

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

1015

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

Sai Cheemalapati

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

[diff] [blame]

1016

#

Jon Wayne Parrott

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

[diff] [blame]

1017

#

1018

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

Dmitry Frenkel

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

[diff] [blame]

1019

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

1020

#

1021

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

1022

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

1023

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

1024

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

1025

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

1026

#

1027

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

1028

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

1029

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

1030

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

1031

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

1032

},

1033

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

1034

#

1035

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

1036

# global/snapshots/my-backup

1037

#

1038

#

1039

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

Dmitry Frenkel

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

[diff] [blame]

1040

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

Bu Sun Kim

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

[diff] [blame]

1041

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

1042

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

1043

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

1044

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

1045

#

1046

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

1047

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

1048

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

1049

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

1050

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

1051

},

1052

},

Bu Sun Kim

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

[diff] [blame]

1053

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

1054

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

1055

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

1056

"A String",

1057

],

1058

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

1059

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

1060

"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

1061

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

1062

{

1063

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

1064

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

1065

},

1066

],

1067

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

1068

{

1069

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

1070

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

1071

},

1072

],

1073

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

1074

{

1075

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

1076

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

1077

},

1078

],

1079

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

1080

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

1081

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

Bu Sun Kim

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

[diff] [blame]

1082

},

Bu Sun Kim

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

[diff] [blame]

1083

},

1084

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

1085

#

1086

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

1087

#

1088

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

1089

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

1090

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

1091

"A String",

1092

],

Sai Cheemalapati

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

[diff] [blame]

1093

}

1094

Dmitry Frenkel

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

[diff] [blame]

1095

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]

1096

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.

1097

1098

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.

1099

1100

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]

1101

1102

Returns:

1103

An object of the form:

1104

Bu Sun Kim

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

[diff] [blame]

1105

{ # Represents an Operation resource.

1106

#

Dan O'Meara

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

[diff] [blame]

1107

# Google Compute Engine has three Operation resources:

1108

#

1109

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

1110

#

Bu Sun Kim

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

[diff] [blame]

1111

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

1112

#

1113

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

1114

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

1115

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

1116

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

Bu Sun Kim

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

[diff] [blame]

1117

#

Dan O'Meara

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

[diff] [blame]

1118

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

1119

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

1120

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

1121

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

1122

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

1123

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

1124

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

Dan O'Meara

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

[diff] [blame]

1125

{

Bu Sun Kim

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

[diff] [blame]

1126

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

1127

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

1128

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

Dan O'Meara

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

[diff] [blame]

1129

},

1130

],

1131

},

Bu Sun Kim

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

[diff] [blame]

1132

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

1133

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

1134

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

1135

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

1136

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

1137

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

1138

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

1139

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

1140

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

1141

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

1142

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

1143

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

1144

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

1145

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

1146

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

1147

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

1148

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

1149

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

1150

{

1151

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

1152

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

1153

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

1154

{

1155

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

1156

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

1157

},

1158

],

1159

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

1160

},

1161

],

1162

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

1168

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

1169

1170

Args:

1171

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

1172

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

1173

body: object, The request body.

1174

The object takes the form of:

1175

1176

{

Bu Sun Kim

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

[diff] [blame]

1177

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

Bu Sun Kim

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

[diff] [blame]

1178

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

1179

#

1180

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

1181

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

1182

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

1183

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

1184

},

Bu Sun Kim

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

[diff] [blame]

1185

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

1186

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

1187

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

1188

},

Bu Sun Kim

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

[diff] [blame]

1189

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

1190

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

1191

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

1192

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

1193

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

1194

{ # An instance-attached disk resource.

Bu Sun Kim

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

[diff] [blame]

1195

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

1196

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

1197

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

1198

#

1199

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

1200

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

Dan O'Meara

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

[diff] [blame]

1201

#

1202

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

1203

#

1204

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

1205

#

1206

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

1207

#

1208

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

1209

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

1210

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

1211

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

1212

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

1213

#

1214

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

1215

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

1216

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

1217

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

Bu Sun Kim

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

[diff] [blame]

1218

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

1219

},

Bu Sun Kim

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

[diff] [blame]

1220

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

Bu Sun Kim

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

[diff] [blame]

1221

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

1222

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

1223

{ # Guest OS features.

1224

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

1225

},

1226

],

1227

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

1228

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

1229

#

1230

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

1231

#

1232

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

1233

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

1234

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

1235

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

1236

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

1237

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

1238

#

1239

#

1240

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

1241

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

1242

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

1243

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

1244

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

1245

#

1246

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

1247

{ # Guest OS features.

Bu Sun Kim

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

[diff] [blame]

1248

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

1249

},

1250

],

Bu Sun Kim

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

[diff] [blame]

1251

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

1252

"a_key": "A String",

Dan O'Meara

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

[diff] [blame]

1253

},

Bu Sun Kim

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

[diff] [blame]

1254

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

1255

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

1256

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

1257

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

1258

"A String",

1259

],

1260

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

1261

"A String",

1262

],

1263

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

1264

#

1265

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

1266

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

1267

#

1268

#

1269

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

1270

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

1271

#

1272

#

1273

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

1274

# global/images/my-custom-image

1275

#

1276

#

1277

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

1278

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

1279

#

1280

#

1281

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

Dmitry Frenkel

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

[diff] [blame]

1282

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

1283

#

1284

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

1285

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

1286

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

1287

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

1288

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

1289

#

1290

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

1291

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

1292

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

1293

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

1294

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

1295

},

1296

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

1297

#

1298

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

1299

# global/snapshots/my-backup

1300

#

1301

#

1302

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

Dmitry Frenkel

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

[diff] [blame]

1303

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

Bu Sun Kim

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

[diff] [blame]

1304

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

1305

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

1306

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

1307

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

1308

#

1309

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

1310

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

1311

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

1312

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

1313

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

1314

},

1315

},

Bu Sun Kim

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

[diff] [blame]

1316

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

1317

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

1318

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

1319

"A String",

1320

],

1321

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

1322

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

1323

"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

1324

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

1325

{

1326

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

1327

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

1328

},

1329

],

1330

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

1331

{

1332

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

1333

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

1334

},

1335

],

1336

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

1337

{

1338

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

1339

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

1340

},

1341

],

1342

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

1343

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

1344

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

Dan O'Meara

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

[diff] [blame]

1345

},

Bu Sun Kim

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

[diff] [blame]

1346

},

1347

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

1348

#

1349

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

1350

#

1351

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

1352

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

1353

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

1354

"A String",

1355

],

Dan O'Meara

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

[diff] [blame]

1356

},

1357

],

Bu Sun Kim

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

[diff] [blame]

1358

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

1359

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

Dan O'Meara

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

[diff] [blame]

1360

},

Bu Sun Kim

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

[diff] [blame]

1361

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

1362

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

1363

#

1364

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

1365

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

1366

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

1367

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

1368

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

1369

},

1370

],

1371

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

1372

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

1373

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

1374

#

1375

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

1376

#

1377

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

1378

#

1379

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

1380

#

1381

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

1382

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

1383

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

1384

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

1385

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

1386

#

1387

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

1388

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

1389

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

1390

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

1391

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

1392

},

1393

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

1394

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

1395

#

1396

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

1397

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

1398

"a_key": "A String",

1399

},

Bu Sun Kim

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

[diff] [blame]

1400

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

1401

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

1402

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

Bu Sun Kim

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

[diff] [blame]

1403

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

1404

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

1405

#

1406

#

1407

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

1408

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

1409

#

1410

#

1411

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

1412

#

1413

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

1414

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

1415

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

1416

#

1417

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

1418

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

1419

{

1420

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

1421

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

1422

},

1423

],

1424

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

1425

},

1426

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

1427

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

1428

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

1429

{ # A network interface resource attached to an instance.

1430

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

1431

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

1432

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

1433

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

Bu Sun Kim

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

[diff] [blame]

1434

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

1435

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

1436

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

1437

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

1438

#

1439

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

1440

#

1441

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

1442

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

1443

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

1444

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

1445

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

1446

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

1447

},

1448

],

1449

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

1450

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

1451

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

1452

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

1453

},

1454

],

1455

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

1456

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

1457

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

1458

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

1459

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

1460

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

1461

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

1462

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

1463

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

1464

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

1465

#

1466

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

1467

#

1468

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

1469

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

1470

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

1471

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

1472

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

1473

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

1474

},

1475

],

Bu Sun Kim

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

[diff] [blame]

1476

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

1477

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

1478

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

1479

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

1480

#

1481

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

1482

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

1483

# - projects/project/global/networks/network

1484

# - global/networks/default

1485

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

1486

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

1487

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

1488

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

1489

#

1490

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

1491

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

1492

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

1493

# - regions/region/subnetworks/subnetwork

1494

},

1495

],

Dmitry Frenkel

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

[diff] [blame]

1496

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

Bu Sun Kim

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

[diff] [blame]

1497

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

1498

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

1499

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

1500

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

1501

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

1502

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

"A String",

],

},

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

1507

"A String",

1508

],

Dmitry Frenkel

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

[diff] [blame]

1509

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

1510

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

1511

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

1512

#

1513

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

1514

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

1515

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

1516

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

1517

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

1518

#

1519

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

Bu Sun Kim

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

[diff] [blame]

1520

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

1521

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

1522

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

1523

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

1524

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

1525

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

1531

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

1532

},

Dmitry Frenkel

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

[diff] [blame]

1533

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

1534

"A String",

1535

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

1536

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

1537

"A String",

1538

],

Bu Sun Kim

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

[diff] [blame]

1539

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

1540

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

1541

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

1542

#

1543

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

1544

{ # A service account.

1545

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

1546

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

"A String",

],

},

],

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

1552

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

1553

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

1554

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

1555

},

1556

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

1557

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

1558

},

Dmitry Frenkel

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

[diff] [blame]

1559

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

1560

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

1561

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

1562

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

1563

},

Dmitry Frenkel

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

[diff] [blame]

1564

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

1565

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

1566

},

1567

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

Dmitry Frenkel

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

[diff] [blame]

1568

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

Bu Sun Kim

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

[diff] [blame]

1569

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

1570

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

1571

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

1572

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

1573

#

1574

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

1575

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

1576

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

1577

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

1578

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

1579

},

1580

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

1581

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

1582

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

1583

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

1584

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

1585

#

1586

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

1587

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

1592

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

1593

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

1594

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

1595

},

1596

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

1597

},

Bu Sun Kim

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

[diff] [blame]

1598

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

1599

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

1600

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

1601

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

1602

},

1603

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

1604

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

1605

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

1606

},

1607

"description": "A String", # An optional text description for the instances that are created from these properties.

1608

"disks": [ # An array of disks that are associated with the instances that are created from these properties.

1609

{ # An instance-attached disk resource.

1610

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

1611

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

1612

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

1613

#

1614

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

1615

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

1616

#

1617

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

1618

#

1619

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

1620

#

1621

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

1622

#

1623

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

1624

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

1625

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

1626

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

1627

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

1628

#

1629

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

1630

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

1631

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

1632

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

1633

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

1634

},

1635

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

Bu Sun Kim

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

[diff] [blame]

1636

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

1637

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

1638

{ # Guest OS features.

1639

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

1640

},

1641

],

1642

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

1643

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

1644

#

1645

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

1646

#

1647

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

1648

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

1649

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

1650

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

1651

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

1652

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

1653

#

1654

#

1655

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

1656

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

1657

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

1658

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

1659

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

1660

#

1661

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

1662

{ # Guest OS features.

1663

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

1664

},

1665

],

1666

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

1667

"a_key": "A String",

1668

},

1669

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

1670

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

1671

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

1672

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

1673

"A String",

1674

],

1675

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

1676

"A String",

1677

],

1678

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

1679

#

1680

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

1681

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

1682

#

1683

#

1684

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

1685

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

1686

#

1687

#

1688

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

1689

# global/images/my-custom-image

1690

#

1691

#

1692

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

1693

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

1694

#

1695

#

1696

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

1697

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

1698

#

1699

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

1700

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

1701

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

1702

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

1703

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

1704

#

1705

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

1706

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

1707

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

1708

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

1709

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

1710

},

1711

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

1712

#

1713

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

1714

# global/snapshots/my-backup

1715

#

1716

#

1717

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

1718

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

1719

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

1720

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

1721

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

1722

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

1723

#

1724

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

1725

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

1726

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

1727

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

1728

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

1729

},

1730

},

1731

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

1732

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

1733

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

1734

"A String",

1735

],

1736

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

1737

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

1738

"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

1739

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

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

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

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

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

1752

{

1753

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

1754

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

1755

},

1756

],

1757

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

1758

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

1759

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

1760

},

1761

},

1762

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

1763

#

1764

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

1765

#

1766

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

1767

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

1768

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

1769

"A String",

1770

],

Dmitry Frenkel

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

[diff] [blame]

1771

},

1772

],

1773

"displayDevice": { # A set of Display Device options # Display Device properties to enable support for remote display products like: Teradici, VNC and TeamViewer

1774

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

1775

},

1776

"guestAccelerators": [ # A list of guest accelerator cards' type and count to use for instances created from these properties.

1777

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

1778

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

1779

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

1780

},

1781

],

1782

"labels": { # Labels to apply to instances that are created from these properties.

1783

"a_key": "A String",

1784

},

1785

"machineType": "A String", # The machine type to use for instances that are created from these properties.

1786

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

1787

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

1788

#

1789

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

1790

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

1791

{

1792

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

1793

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

1794

},

1795

],

1796

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

1797

},

1798

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

1799

"networkInterfaces": [ # An array of network access configurations for this interface.

1800

{ # A network interface resource attached to an instance.

1801

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

1802

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

1803

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

1804

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

Dmitry Frenkel

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

[diff] [blame]

1805

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

1806

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

1807

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

1808

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

1809

#

1810

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

1811

#

1812

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

1813

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

1814

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

1815

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

1816

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

1817

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

1818

},

1819

],

1820

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

1821

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

1822

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

1823

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

1824

},

1825

],

1826

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

1827

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

1828

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

1829

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

1830

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

1831

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

1832

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

1833

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

1834

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

1835

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

1836

#

1837

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

1838

#

1839

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

1840

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

1841

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

1842

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

1843

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

1844

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

1845

},

1846

],

Dmitry Frenkel

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

[diff] [blame]

1847

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

1848

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

1849

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

1850

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

1851

#

1852

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

1853

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

1854

# - projects/project/global/networks/network

1855

# - global/networks/default

1856

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

1857

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

1858

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

1859

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

1860

#

1861

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

1862

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

1863

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

1864

# - regions/region/subnetworks/subnetwork

1865

},

1866

],

1867

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

1868

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

1869

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

1870

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

1871

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

1872

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

1877

"A String",

1878

],

1879

"scheduling": { # Sets the scheduling options for an Instance. NextID: 13 # Specifies the scheduling options for the instances that are created from these properties.

1880

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

1881

#

1882

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

1883

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

1884

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

1885

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

1886

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

1887

#

1888

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

Dmitry Frenkel

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

[diff] [blame]

1889

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

1890

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

1891

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

1892

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

1893

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

1894

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

1900

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

1901

},

1902

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

1903

{ # A service account.

1904

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

1905

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

"A String",

],

},

],

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

1911

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

1912

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

1913

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

1914

},

1915

"shieldedVmConfig": { # A set of Shielded VM options. # Specifies the Shielded VM options for the instances that are created from these properties.

1916

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

1917

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

1918

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

1919

},

1920

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

1921

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

1922

#

1923

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

1924

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

1929

"locationPolicy": { # Configuration for location policy among multiple possible locations (e.g. preferences for zone selection among zones in a single region).

1930

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

1931

"a_key": {

1932

"preference": "A String",

1933

},

1934

},

1935

},

Bu Sun Kim

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

[diff] [blame]

1936

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

1937

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

1938

"predefinedNames": [ # List of predefined names. The number of names provided must be equal to count.

1939

"A String",

Dan O'Meara

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

[diff] [blame]

1940

],

Dmitry Frenkel

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

[diff] [blame]

1941

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

1942

#

1943

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

1944

# - https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate

1945

# - projects/project/global/instanceTemplates/instanceTemplate

1946

# - global/instanceTemplates/instanceTemplate

Dmitry Frenkel

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

[diff] [blame]

1947

#

1948

# This field is optional.

Dan O'Meara

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

[diff] [blame]

1949

}

1950

1951

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.

1952

1953

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.

1954

1955

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

1956

1957

Returns:

1958

An object of the form:

1959

1960

{ # Represents an Operation resource.

1961

#

1962

# Google Compute Engine has three Operation resources:

1963

#

1964

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

1965

#

1966

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

1967

#

1968

# Operations can be global, regional or zonal.

1969

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

1970

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

1971

# - For zonal operations, use the `zonalOperations` resource.

1972

#

1973

# 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]

1974

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1975

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1976

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1977

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1978

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1979

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1980

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1981

"code": "A String", # [Output Only] The error type identifier for this error.

1982

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1983

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1984

},

1985

],

1986

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1987

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1988

"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.

1989

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

1990

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1991

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1992

"name": "A String", # [Output Only] Name of the operation.

1993

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1994

"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.

1995

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

1996

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1997

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1998

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1999

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2000

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2001

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2002

"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.

2003

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2004

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2005

{

2006

"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.

2007

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2008

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2009

{

2010

"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).

2011

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2012

},

2013

],

2014

"message": "A String", # [Output Only] A human-readable description of the warning code.

2015

},

2016

],

2017

"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]

2022

<code class="details" id="close">close()</code>

2023

<pre>Close httplib2 connections.</pre>

</div>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

2027

<code class="details" id="delete">delete(project, zone, instance, requestId=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2028

<pre>Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance.

2029

2030

Args:

2031

project: string, Project ID for this request. (required)

2032

zone: string, The name of the zone for this request. (required)

2033

instance: string, Name of the instance resource to delete. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2034

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.

2035

2036

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.

2037

2038

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]

2039

2040

Returns:

2041

An object of the form:

2042

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2043

{ # Represents an Operation resource.

2044

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2045

# Google Compute Engine has three Operation resources:

2046

#

2047

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2048

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2049

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2050

#

2051

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2052

# - For global operations, use the `globalOperations` resource.

2053

# - For regional operations, use the `regionOperations` resource.

2054

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2055

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2056

# 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]

2057

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2058

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2059

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2060

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2061

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2062

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2063

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2064

"code": "A String", # [Output Only] The error type identifier for this error.

2065

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2066

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2067

},

2068

],

2069

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2070

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2071

"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.

2072

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2073

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2074

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2075

"name": "A String", # [Output Only] Name of the operation.

2076

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2077

"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.

2078

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2079

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2080

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2081

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2082

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2083

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2084

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2085

"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.

2086

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2087

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2088

{

2089

"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.

2090

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2091

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2092

{

2093

"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).

2094

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2095

},

2096

],

2097

"message": "A String", # [Output Only] A human-readable description of the warning code.

2098

},

2099

],

2100

"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]

2105

<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]

2106

<pre>Deletes an access config from an instance's network interface.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2107

2108

Args:

2109

project: string, Project ID for this request. (required)

2110

zone: string, The name of the zone for this request. (required)

2111

instance: string, The instance name for this request. (required)

2112

accessConfig: string, The name of the access config to delete. (required)

2113

networkInterface: string, The name of the network interface. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2114

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.

2115

2116

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.

2117

2118

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]

2119

2120

Returns:

2121

An object of the form:

2122

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2123

{ # Represents an Operation resource.

2124

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2125

# Google Compute Engine has three Operation resources:

2126

#

2127

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2128

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2129

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2130

#

2131

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2132

# - For global operations, use the `globalOperations` resource.

2133

# - For regional operations, use the `regionOperations` resource.

2134

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2135

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2136

# 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]

2137

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2138

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2139

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2140

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2141

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2142

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2143

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2144

"code": "A String", # [Output Only] The error type identifier for this error.

2145

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2146

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2147

},

2148

],

2149

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2150

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2151

"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.

2152

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2153

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2154

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2155

"name": "A String", # [Output Only] Name of the operation.

2156

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2157

"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.

2158

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2159

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2160

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2161

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2162

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2163

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2164

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2165

"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.

2166

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2167

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2168

{

2169

"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.

2170

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2171

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2172

{

2173

"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).

2174

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2175

},

2176

],

2177

"message": "A String", # [Output Only] A human-readable description of the warning code.

2178

},

2179

],

2180

"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]

2185

<code class="details" id="detachDisk">detachDisk(project, zone, instance, deviceName, requestId=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2186

<pre>Detaches a disk from an instance.

2187

2188

Args:

2189

project: string, Project ID for this request. (required)

2190

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2191

instance: string, Instance name for this request. (required)

2192

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)

2193

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.

2194

2195

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.

2196

2197

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]

2198

2199

Returns:

2200

An object of the form:

2201

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2202

{ # Represents an Operation resource.

2203

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2204

# Google Compute Engine has three Operation resources:

2205

#

2206

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2207

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2208

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2209

#

2210

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2211

# - For global operations, use the `globalOperations` resource.

2212

# - For regional operations, use the `regionOperations` resource.

2213

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2214

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2215

# 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]

2216

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2217

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2218

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2219

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2220

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2221

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2222

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2223

"code": "A String", # [Output Only] The error type identifier for this error.

2224

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2225

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2226

},

2227

],

2228

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2229

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2230

"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.

2231

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2232

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2233

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2234

"name": "A String", # [Output Only] Name of the operation.

2235

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2236

"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.

2237

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2238

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2239

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2240

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2241

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2242

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2243

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2244

"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.

2245

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2246

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2247

{

2248

"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.

2249

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2250

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2251

{

2252

"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).

2253

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2254

},

2255

],

2256

"message": "A String", # [Output Only] A human-readable description of the warning code.

2257

},

2258

],

2259

"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]

2265

<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]

2266

2267

Args:

2268

project: string, Project ID for this request. (required)

2269

zone: string, The name of the zone for this request. (required)

2270

instance: string, Name of the instance resource to return. (required)

2271

2272

Returns:

2273

An object of the form:

2274

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2275

{ # Represents an Instance resource.

2276

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2277

# 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]

2278

"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.

2279

"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).

2280

"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.

2281

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2282

"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.

2283

"confidentialInstanceConfig": { # A set of Confidential Instance options.

2284

"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]

2285

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2286

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

2287

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

2288

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

2289

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2290

"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]

2291

{ # An instance-attached disk resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2292

"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).

2293

"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.

2294

"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.

2295

#

2296

# 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]

2297

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2298

#

2299

# 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.

2300

#

2301

# 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.

2302

#

2303

# 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.

2304

#

2305

# 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]

2306

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2307

"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.

2308

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2309

"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]

2310

#

2311

# The key must meet the following requirements before you can provide it to Compute Engine:

2312

# - 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]

2313

# - 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]

2314

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2315

"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]

2316

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2317

"diskSizeGb": "A String", # The size of the disk in GB.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2318

"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]

2319

"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.

2320

{ # Guest OS features.

2321

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

2322

},

2323

],

2324

"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.

2325

"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]

2326

#

2327

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

2328

#

2329

# 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]

2330

"description": "A String", # An optional description. Provide this property when creating the disk.

2331

"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.

2332

"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.

2333

"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]

2334

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

2335

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2336

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2337

# 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:

2338

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType

2339

# - projects/project/zones/zone/diskTypes/diskType

2340

# - 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]

2341

"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]

2342

#

2343

# Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

2344

{ # Guest OS features.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2345

"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]

2346

},

2347

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2348

"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.

2349

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2350

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2351

"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]

2352

"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]

2353

"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]

2354

"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

2355

"A String",

2356

],

2357

"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.

2358

"A String",

2359

],

2360

"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]

2361

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2362

# 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:

2363

# projects/debian-cloud/global/images/family/debian-9

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2364

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2365

#

2366

# Alternatively, use a specific version of a public operating system image:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2367

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2368

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2369

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2370

# To create a disk with a custom image that you created, specify the image name in the following format:

2371

# global/images/my-custom-image

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2372

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2373

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2374

# 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:

2375

# global/images/family/my-image-family

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2376

#

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2377

#

2378

# If the source image is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2379

"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]

2380

#

2381

# 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.

2382

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2383

"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.

2384

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2385

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

2386

#

2387

# The key must meet the following requirements before you can provide it to Compute Engine:

2388

# - The key is wrapped using a RSA public key certificate provided by Google.

2389

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

2390

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

2391

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

2392

},

2393

"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.

2394

#

2395

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

2396

# global/snapshots/my-backup

2397

#

2398

#

2399

# If the source snapshot is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2400

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2401

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2402

"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.

2403

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2404

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

2405

#

2406

# The key must meet the following requirements before you can provide it to Compute Engine:

2407

# - The key is wrapped using a RSA public key certificate provided by Google.

2408

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

2409

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

2410

"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]

2411

},

2412

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2413

"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.

2414

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

2415

"licenses": [ # [Output Only] Any valid publicly visible licenses.

2416

"A String",

2417

],

2418

"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.

2419

"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.

2420

"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

2421

"dbs": [ # The Key Database (db).

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

"dbxs": [ # The forbidden key database (dbx).

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

"keks": [ # The Key Exchange Key (KEK).

2434

{

2435

"content": "A String", # The raw content in the secure keys file.

2436

"fileType": "A String", # The file type of source file.

2437

},

2438

],

2439

"pk": { # The Platform Key (PK).

2440

"content": "A String", # The raw content in the secure keys file.

2441

"fileType": "A String", # The file type of source file.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2442

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2443

},

2444

"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]

2445

#

2446

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

2447

#

2448

# 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]

2449

"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]

2450

"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.

2451

"A String",

2452

],

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2453

},

2454

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2455

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

2456

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2457

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2458

"eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.

2459

"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.

2460

#

2461

# To see the latest fingerprint, make get() request to the instance.

2462

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

2463

{ # A specification of the type and number of accelerator cards attached to the instance.

2464

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

2465

"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.

2466

},

2467

],

2468

"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.

2469

"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]

2470

"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]

2471

#

2472

# 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.

2473

#

2474

# 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.

2475

#

2476

# 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.

2477

#

2478

# 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.

2479

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2480

"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.

2481

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2482

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

2483

#

2484

# The key must meet the following requirements before you can provide it to Compute Engine:

2485

# - The key is wrapped using a RSA public key certificate provided by Google.

2486

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

2487

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

2488

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

2489

},

2490

"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.

2491

"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.

2492

#

2493

# To see the latest fingerprint, make get() request to the instance.

2494

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

2495

"a_key": "A String",

2496

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2497

"lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format.

2498

"lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format.

2499

"lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2500

"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:

2501

# zones/us-central1-f/machineTypes/n1-standard-1

2502

#

2503

#

2504

# 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):

2505

# zones/zone/machineTypes/custom-CPUS-MEMORY

2506

#

2507

#

2508

# For example: zones/us-central1-f/machineTypes/custom-4-5120

2509

#

2510

# For a full list of restrictions, read the Specifications for custom machine types.

2511

"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

2512

"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.

2513

#

2514

# To see the latest fingerprint, make a get() request to retrieve the resource.

2515

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

2516

{

2517

"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.

2518

"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).

2519

},

2520

],

2521

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

2522

},

2523

"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".

2524

"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.

2525

"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.

2526

{ # A network interface resource attached to an instance.

2527

"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.

2528

{ # 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]

2529

"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.

2530

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2531

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

2532

"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.

2533

"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.

2534

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

2535

#

2536

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

2537

#

2538

# 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.

2539

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

2540

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

2541

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

2542

"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.

2543

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

2544

},

2545

],

2546

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

2547

{ # An alias IP range attached to an instance's network interface.

2548

"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).

2549

"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.

2550

},

2551

],

2552

"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]

2553

"internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range.

2554

"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.

2555

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

2556

"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.

2557

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

2558

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

2559

"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.

2560

"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.

2561

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

2562

#

2563

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

2564

#

2565

# 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.

2566

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

2567

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

2568

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

2569

"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.

2570

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

2571

},

2572

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2573

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

2574

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

2575

"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.

2576

"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.

2577

#

2578

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

2579

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

2580

# - projects/project/global/networks/network

2581

# - global/networks/default

2582

"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]

2583

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

2584

"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.

2585

"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.

2586

#

2587

# 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]

2588

"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:

2589

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

2590

# - regions/region/subnetworks/subnetwork

2591

},

2592

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2593

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2594

"preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api.

2595

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.

2596

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.

2597

"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.

2598

"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.

2599

"values": [ # Corresponds to the label values of a reservation resource.

"A String",

],

},

"resourcePolicies": [ # Resource policies applied to this instance.

2604

"A String",

2605

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2606

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

2607

"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]

2608

"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.

2609

#

2610

# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

2611

"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.

2612

"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]

2613

"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]

2614

"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.

2615

#

2616

# See go/stable-fleet-ug for more details.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2617

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

2618

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

2619

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

2620

"key": "A String", # Corresponds to the label key of Node resource.

2621

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

2622

"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]

2628

"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]

2629

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2630

"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.

2631

"A String",

2632

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

2633

"secureTags": [ # Secure tags to apply to this instance. These can be later modified by the update method. Maximum number of secure tags allowed is 300.

2634

"A String",

2635

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2636

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

2637

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2638

"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

2639

#

2640

# 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.

2641

{ # A service account.

2642

"email": "A String", # Email address of the service account.

2643

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

2649

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

2650

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

2651

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

2652

},

2653

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

2654

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

2655

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2656

"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]

2657

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

2658

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

2659

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

2660

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2661

"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]

2662

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

2663

},

2664

"sourceMachineImage": "A String", # Source machine image

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2665

"sourceMachineImageEncryptionKey": { # Source GMI encryption key when creating an instance from GMI.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2666

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2667

"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.

2668

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2669

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

2670

#

2671

# The key must meet the following requirements before you can provide it to Compute Engine:

2672

# - The key is wrapped using a RSA public key certificate provided by Google.

2673

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

2674

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

2675

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

2676

},

2677

"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]

2678

"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]

2679

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

2680

"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.

2681

"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.

2682

#

2683

# To see the latest fingerprint, make get() request to the instance.

2684

"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]

2689

"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.

2690

"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]

2691

"type": "A String", # Defines the type of maintenance.

2692

},

2693

"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]

2698

<code class="details" id="getEffectiveFirewalls">getEffectiveFirewalls(project, zone, instance, networkInterface)</code>

2699

<pre>Returns effective firewalls applied to an interface of the instance.

2700

2701

Args:

2702

project: string, Project ID for this request. (required)

2703

zone: string, The name of the zone for this request. (required)

2704

instance: string, Name of the instance scoping this request. (required)

2705

networkInterface: string, The name of the network interface to get the effective firewalls. (required)

2706

2707

Returns:

2708

An object of the form:

2709

2710

{

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

2711

"firewallPolicys": [ # Effective firewalls from firewall policies.

2712

{

2713

"displayName": "A String", # [Output Only] The display name of the firewall policy.

2714

"name": "A String", # [Output Only] The name of the firewall policy.

2715

"rules": [ # The rules that apply to the network.

2716

{ # 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).

2717

"action": "A String", # The Action to perform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502.

2718

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2719

"direction": "A String", # The direction in which this rule applies.

2720

"disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.

2721

"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.

2722

"kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules

2723

"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.

2724

"destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 256.

2725

"A String",

2726

],

2727

"layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.

2728

{

2729

"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.

2730

"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.

2731

#

2732

# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

"A String",

],

},

],

"srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 256.

2738

"A String",

2739

],

2740

"srcSecureLabels": [ # List of firewall label values, which should be matched at the source of the traffic. Maximum number of source label values allowed is 256.

"A String",

],

},

"priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.

2745

"ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule.

2746

"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.

2747

"A String",

2748

],

2749

"targetSecureLabels": [ # A list of secure labels that controls which instances the firewall rule applies to. If targetSecureLabel are specified, then the firewall rule applies only to instances in the VPC network that have one of those secure labels. targetSecureLabel may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureLabel are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label values allowed is 256.

2750

"A String",

2751

],

2752

"targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.

"A String",

],

},

],

"type": "A String", # [Output Only] The type of the firewall policy.

2758

},

2759

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2760

"firewalls": [ # Effective firewalls on the instance.

2761

{ # Represents a Firewall Rule resource.

2762

#

2763

# Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules.

2764

"allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

2765

{

2766

"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.

2767

"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.

2768

#

2769

# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

"A String",

],

},

],

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

2775

"denied": [ # The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.

2776

{

2777

"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.

2778

"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.

2779

#

2780

# 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.

2786

"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.

2787

"A String",

2788

],

2789

"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.

2790

"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]

2791

"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]

2792

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

2793

"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]

2794

"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]

2795

"enable": True or False, # This field denotes whether to enable logging for a particular firewall rule.

2796

"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.

2797

},

2798

"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.

2799

"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:

2800

# global/networks/default

2801

# 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:

2802

# - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network

2803

# - projects/myproject/global/networks/my-network

2804

# - global/networks/default

2805

"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`.

2806

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2807

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2808

"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.

2809

"A String",

2810

],

2811

"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.

2812

"A String",

2813

],

2814

"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.

2815

"A String",

2816

],

2817

"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.

2818

"A String",

2819

],

2820

"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]

2826

{ # A pruned SecurityPolicy containing ID and any applicable firewall rules.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2827

"id": "A String", # The unique identifier for the security policy. This identifier is defined by the server.

2828

"rules": [ # The rules that apply to the network.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2829

{ # 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]

2830

"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.

2831

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2832

"direction": "A String", # The direction in which this rule applies. This field may only be specified when versioned_expr is set to FIREWALL.

2833

"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]

2834

#

2835

# 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]

2836

"kind": "compute#securityPolicyRule", # [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules

2837

"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.

2838

"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.

2839

"destIpRanges": [ # CIDR IP address range.

2840

#

2841

# This field may only be specified when versioned_expr is set to FIREWALL.

2842

"A String",

2843

],

2844

"destPorts": [ # Pairs of IP protocols and ports that the rule should match.

2845

#

2846

# This field may only be specified when versioned_expr is set to FIREWALL.

2847

{

2848

"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.

2849

"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.

2850

#

2851

# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

2852

#

2853

# 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.

2859

#

2860

# This field may only be specified when versioned_expr is set to FIREWALL.

2861

{

2862

"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.

2863

"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.

2864

#

2865

# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

2866

#

2867

# 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]

2872

"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]

2877

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2878

# Example (Comparison):

2879

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2880

# 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]

2881

#

2882

# Example (Equality):

2883

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2884

# 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]

2885

#

2886

# Example (Logic):

2887

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2888

# 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]

2889

#

2890

# Example (Data Manipulation):

2891

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2892

# 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]

2893

#

2894

# 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]

2895

"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.

2896

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

2897

"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.

2898

"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]

2899

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2900

"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]

2901

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2902

"preview": True or False, # If set to true, the specified action is not enforced.

2903

"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.

2904

"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]

2905

"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'.

2906

"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'.

2907

"count": 42, # Number of HTTP(S) requests for calculating the threshold.

2908

"intervalSec": 42, # Interval over which the threshold is computed.

2909

},

2910

"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]

2911

"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".

2912

"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.

2913

"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]

2914

"rateLimitThreshold": { # Threshold at which to begin ratelimiting.

2915

"count": 42, # Number of HTTP(S) requests for calculating the threshold.

2916

"intervalSec": 42, # Interval over which the threshold is computed.

2917

},

2918

"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]

2919

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

2920

"ruleNumber": "A String", # Identifier for the rule. This is only unique within the given security policy. This can only be set during rule creation, if rule number is not specified it will be generated by the server.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2921

"ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall security policy rule.

2922

"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.

2923

#

2924

# This field may only be specified when versioned_expr is set to FIREWALL.

2925

"A String",

2926

],

2927

"targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.

2928

"A String",

2929

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2930

},

2931

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2932

},

2933

],

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]

2938

<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]

2939

<pre>Returns the specified guest attributes entry.

2940

2941

Args:

2942

project: string, Project ID for this request. (required)

2943

zone: string, The name of the zone for this request. (required)

2944

instance: string, Name of the instance scoping this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2945

queryPath: string, Specifies the guest attributes path to be queried.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2946

variableKey: string, Specifies the key for the guest attributes entry.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2947

2948

Returns:

2949

An object of the form:

2950

2951

{ # A guest attributes entry.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2952

"kind": "compute#guestAttributes", # [Output Only] Type of the resource. Always compute#guestAttributes for guest attributes entry.

2953

"queryPath": "A String", # The path to be queried. This can be the default namespace ('/') or a nested namespace ('/\/') or a specified key ('/\/\')

2954

"queryValue": { # Array of guest attribute namespace/key/value tuples. # [Output Only] The value of the requested queried path.

2955

"items": [

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2956

{ # A guest attributes namespace/key/value entry.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2957

"key": "A String", # Key for the guest attribute entry.

2958

"namespace": "A String", # Namespace for the guest attribute entry.

2959

"value": "A String", # Value for the guest attribute entry.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2960

},

2961

],

2962

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2963

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

2964

"variableKey": "A String", # The key to search for.

2965

"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]

2970

<code class="details" id="getIamPolicy">getIamPolicy(project, zone, resource, optionsRequestedPolicyVersion=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2971

<pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists.

2972

2973

Args:

2974

project: string, Project ID for this request. (required)

2975

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2976

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2977

optionsRequestedPolicyVersion: integer, Requested IAM Policy version.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2978

2979

Returns:

2980

An object of the form:

2981

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2982

{ # 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]

2983

#

2984

#

2985

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2986

# 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]

2987

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2988

# 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]

2989

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2990

# **JSON example:**

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2991

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2992

# { "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]

2993

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2994

# **YAML example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2995

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2996

# 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]

2997

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2998

# 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]

2999

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3000

{ # 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]

3001

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3002

# 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]

3003

#

3004

# Example Policy with multiple AuditConfigs:

3005

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3006

# { "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]

3007

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3008

# 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]

3009

"auditLogConfigs": [ # The configuration for logging of each type of permission.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

3010

{ # Provides the configuration for logging a type of permissions. Example:

3011

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3012

# { "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]

3013

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3014

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

3015

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

3016

"A String",

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

3017

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3018

"ignoreChildExemptions": True or False,

3019

"logType": "A String", # The log type that this config enables.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

3020

},

3021

],

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]

3026

},

3027

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3028

"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]

3029

{ # Associates `members` with a `role`.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

3030

"bindingId": "A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3031

"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.

3032

#

3033

# If the condition evaluates to `true`, then this binding applies to the current request.

3034

#

3035

# 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.

3036

#

3037

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

3038

#

3039

# Example (Comparison):

3040

#

3041

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

3042

#

3043

# Example (Equality):

3044

#

3045

# 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'"

3050

#

3051

# Example (Data Manipulation):

3052

#

3053

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

3054

#

3055

# 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.

3056

"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.

3057

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

3058

"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.

3059

"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.

3060

},

3061

"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]

3062

#

3063

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

3064

#

3065

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

3066

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3067

# * `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]

3068

#

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

3069

#

3070

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3071

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

3072

#

3073

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

3074

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3075

# * `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.

3076

#

3077

# * `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.

3078

#

3079

# * `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.

3080

#

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3081

#

3082

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3083

# * `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]

3084

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3085

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3086

"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]

3087

},

3088

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3089

"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.

3090

#

3091

# **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.

3092

"iamOwned": True or False,

3093

"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.

3094

{ # A rule to be applied in a Policy.

3095

"action": "A String", # Required

3096

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

3097

{ # A condition to be met.

3098

"iam": "A String", # Trusted attributes supplied by the IAM system.

3099

"op": "A String", # An operator to apply the subject with.

3100

"svc": "A String", # Trusted attributes discharged by the service.

3101

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

3102

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

3108

"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.

3109

"A String",

3110

],

3111

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

3112

{ # Specifies what kind of log the caller must write

3113

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

3114

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

3115

"permissionType": "A String", # The type of the permission that was checked.

3116

},

3117

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

3118

},

3119

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

3120

#

3121

# 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.

3122

#

3123

# Field names correspond to IAM request parameters and field values are their respective values.

3124

#

3125

# 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.

3126

#

3127

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

3128

"customFields": [ # Custom fields.

3129

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

3130

"name": "A String", # Name is the field name.

3131

"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.

3132

},

3133

],

3134

"field": "A String", # The field value to attribute.

3135

"metric": "A String", # The metric to update.

3136

},

3137

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

3138

"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.

3143

"A String",

3144

],

3145

"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.

3151

#

3152

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

3153

#

3154

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

3155

#

3156

# * 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

3157

#

3158

# **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.

3159

#

3160

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

3161

#

3162

# 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]

3167

<code class="details" id="getScreenshot">getScreenshot(project, zone, instance)</code>

3168

<pre>Returns the screenshot from the specified instance.

3169

3170

Args:

3171

project: string, Project ID for this request. (required)

3172

zone: string, The name of the zone for this request. (required)

3173

instance: string, Name of the instance scoping this request. (required)

3174

3175

Returns:

3176

An object of the form:

3177

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3178

{ # An instance's screenshot.

3179

"contents": "A String", # [Output Only] The Base64-encoded screenshot data.

3180

"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]

3185

<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]

3186

<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]

3187

3188

Args:

3189

project: string, Project ID for this request. (required)

3190

zone: string, The name of the zone for this request. (required)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3191

instance: string, Name of the instance for this request. (required)

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3192

port: integer, Specifies which COM or serial port to retrieve data from.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3193

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`.

3194

3195

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.

3196

3197

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]

3198

3199

Returns:

3200

An object of the form:

3201

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3202

{ # An instance's serial console output.

3203

"contents": "A String", # [Output Only] The contents of the console output.

3204

"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]

3205

"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]

3206

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3207

"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]

3212

<code class="details" id="getShieldedInstanceIdentity">getShieldedInstanceIdentity(project, zone, instance)</code>

3213

<pre>Returns the Shielded Instance Identity of an instance

3214

3215

Args:

3216

project: string, Project ID for this request. (required)

3217

zone: string, The name of the zone for this request. (required)

3218

instance: string, Name or id of the instance scoping this request. (required)

3219

3220

Returns:

3221

An object of the form:

3222

3223

{ # A shielded Instance identity entry.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3224

"encryptionKey": { # A Shielded Instance Identity Entry. # An Endorsement Key (EK) made by the RSA 2048 algorithm issued to the Shielded Instance's vTPM.

3225

"ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.

3226

"ekPub": "A String", # A PEM-encoded public key.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3227

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3228

"kind": "compute#shieldedInstanceIdentity", # [Output Only] Type of the resource. Always compute#shieldedInstanceIdentity for shielded Instance identity entry.

3229

"signingKey": { # A Shielded Instance Identity Entry. # An Attestation Key (AK) made by the RSA 2048 algorithm issued to the Shielded Instance's vTPM.

3230

"ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.

3231

"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>

3238

<pre>Returns the Shielded VM Identity of an instance

3239

3240

Args:

3241

project: string, Project ID for this request. (required)

3242

zone: string, The name of the zone for this request. (required)

3243

instance: string, Name of the instance scoping this request. (required)

3244

3245

Returns:

3246

An object of the form:

3247

3248

{ # A shielded VM identity entry.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3249

"encryptionKey": { # A Shielded Instance Identity Entry. # An Endorsement Key (EK) issued to the Shielded VM's vTPM.

3250

"ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.

3251

"ekPub": "A String", # A PEM-encoded public key.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3252

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3253

"kind": "compute#shieldedVmIdentity", # [Output Only] Type of the resource. Always compute#shieldedVmIdentity for shielded VM identity entry.

3254

"signingKey": { # A Shielded Instance Identity Entry. # An Attestation Key (AK) issued to the Shielded VM's vTPM.

3255

"ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.

3256

"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]

3262

<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]

3263

<pre>Creates an instance resource in the specified project using the data included in the request.

3264

3265

Args:

3266

project: string, Project ID for this request. (required)

3267

zone: string, The name of the zone for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3268

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3269

The object takes the form of:

3270

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3271

{ # Represents an Instance resource.

3272

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3273

# 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]

3274

"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.

3275

"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).

3276

"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.

3277

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3278

"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.

3279

"confidentialInstanceConfig": { # A set of Confidential Instance options.

3280

"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]

3281

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3282

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

3283

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

3284

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

3285

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3286

"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]

3287

{ # An instance-attached disk resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3288

"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).

3289

"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.

3290

"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.

3291

#

3292

# 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]

3293

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3294

#

3295

# 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.

3296

#

3297

# 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.

3298

#

3299

# 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.

3300

#

3301

# 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]

3302

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3303

"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.

3304

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3305

"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]

3306

#

3307

# The key must meet the following requirements before you can provide it to Compute Engine:

3308

# - 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]

3309

# - 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]

3310

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3311

"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]

3312

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3313

"diskSizeGb": "A String", # The size of the disk in GB.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3314

"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]

3315

"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.

3316

{ # Guest OS features.

3317

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

3318

},

3319

],

3320

"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.

3321

"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]

3322

#

3323

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

3324

#

3325

# 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]

3326

"description": "A String", # An optional description. Provide this property when creating the disk.

3327

"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.

3328

"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.

3329

"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]

3330

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

3331

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3332

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3333

# 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:

3334

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType

3335

# - projects/project/zones/zone/diskTypes/diskType

3336

# - 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]

3337

"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]

3338

#

3339

# Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

3340

{ # Guest OS features.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3341

"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]

3342

},

3343

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3344

"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.

3345

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3346

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3347

"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]

3348

"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]

3349

"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]

3350

"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

3351

"A String",

3352

],

3353

"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.

3354

"A String",

3355

],

3356

"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]

3357

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3358

# 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:

3359

# projects/debian-cloud/global/images/family/debian-9

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3360

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3361

#

3362

# Alternatively, use a specific version of a public operating system image:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3363

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3364

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3365

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3366

# To create a disk with a custom image that you created, specify the image name in the following format:

3367

# global/images/my-custom-image

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3368

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3369

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3370

# 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:

3371

# global/images/family/my-image-family

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3372

#

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

3373

#

3374

# If the source image is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3375

"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]

3376

#

3377

# 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.

3378

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3379

"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.

3380

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3381

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

3382

#

3383

# The key must meet the following requirements before you can provide it to Compute Engine:

3384

# - The key is wrapped using a RSA public key certificate provided by Google.

3385

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

3386

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

3387

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

3388

},

3389

"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.

3390

#

3391

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

3392

# global/snapshots/my-backup

3393

#

3394

#

3395

# If the source snapshot is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3396

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3397

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3398

"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.

3399

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3400

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

3401

#

3402

# The key must meet the following requirements before you can provide it to Compute Engine:

3403

# - The key is wrapped using a RSA public key certificate provided by Google.

3404

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

3405

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

3406

"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]

3407

},

3408

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3409

"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.

3410

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

3411

"licenses": [ # [Output Only] Any valid publicly visible licenses.

3412

"A String",

3413

],

3414

"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.

3415

"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.

3416

"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

3417

"dbs": [ # The Key Database (db).

3418

{

3419

"content": "A String", # The raw content in the secure keys file.

3420

"fileType": "A String", # The file type of source file.

3421

},

3422

],

3423

"dbxs": [ # The forbidden key database (dbx).

3424

{

3425

"content": "A String", # The raw content in the secure keys file.

3426

"fileType": "A String", # The file type of source file.

3427

},

3428

],

3429

"keks": [ # The Key Exchange Key (KEK).

3430

{

3431

"content": "A String", # The raw content in the secure keys file.

3432

"fileType": "A String", # The file type of source file.

3433

},

3434

],

3435

"pk": { # The Platform Key (PK).

3436

"content": "A String", # The raw content in the secure keys file.

3437

"fileType": "A String", # The file type of source file.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3438

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3439

},

3440

"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]

3441

#

3442

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

3443

#

3444

# 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]

3445

"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]

3446

"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.

3447

"A String",

3448

],

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3449

},

3450

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3451

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

3452

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3453

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3454

"eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.

3455

"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.

3456

#

3457

# To see the latest fingerprint, make get() request to the instance.

3458

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

3459

{ # A specification of the type and number of accelerator cards attached to the instance.

3460

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

3461

"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.

3462

},

3463

],

3464

"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.

3465

"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]

3466

"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]

3467

#

3468

# 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.

3469

#

3470

# 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.

3471

#

3472

# 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.

3473

#

3474

# 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.

3475

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3476

"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.

3477

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3478

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

3479

#

3480

# The key must meet the following requirements before you can provide it to Compute Engine:

3481

# - The key is wrapped using a RSA public key certificate provided by Google.

3482

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

3483

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

3484

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

3485

},

3486

"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.

3487

"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.

3488

#

3489

# To see the latest fingerprint, make get() request to the instance.

3490

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

3491

"a_key": "A String",

3492

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3493

"lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format.

3494

"lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format.

3495

"lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3496

"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:

3497

# zones/us-central1-f/machineTypes/n1-standard-1

3498

#

3499

#

3500

# 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):

3501

# zones/zone/machineTypes/custom-CPUS-MEMORY

3502

#

3503

#

3504

# For example: zones/us-central1-f/machineTypes/custom-4-5120

3505

#

3506

# For a full list of restrictions, read the Specifications for custom machine types.

3507

"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

3508

"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.

3509

#

3510

# To see the latest fingerprint, make a get() request to retrieve the resource.

3511

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

3512

{

3513

"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.

3514

"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).

3515

},

3516

],

3517

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

3518

},

3519

"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".

3520

"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.

3521

"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.

3522

{ # A network interface resource attached to an instance.

3523

"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.

3524

{ # 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]

3525

"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.

3526

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3527

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

3528

"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.

3529

"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.

3530

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

3531

#

3532

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

3533

#

3534

# 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.

3535

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

3536

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

3537

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

3538

"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.

3539

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

3540

},

3541

],

3542

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

3543

{ # An alias IP range attached to an instance's network interface.

3544

"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).

3545

"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.

3546

},

3547

],

3548

"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]

3549

"internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range.

3550

"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.

3551

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

3552

"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.

3553

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

3554

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

3555

"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.

3556

"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.

3557

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

3558

#

3559

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

3560

#

3561

# 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.

3562

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

3563

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

3564

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

3565

"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.

3566

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

3567

},

3568

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3569

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

3570

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

3571

"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.

3572

"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.

3573

#

3574

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

3575

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

3576

# - projects/project/global/networks/network

3577

# - global/networks/default

3578

"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]

3579

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

3580

"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.

3581

"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.

3582

#

3583

# 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]

3584

"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:

3585

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

3586

# - regions/region/subnetworks/subnetwork

3587

},

3588

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3589

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3590

"preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api.

3591

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.

3592

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.

3593

"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.

3594

"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.

3595

"values": [ # Corresponds to the label values of a reservation resource.

"A String",

],

},

"resourcePolicies": [ # Resource policies applied to this instance.

3600

"A String",

3601

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3602

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

3603

"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]

3604

"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.

3605

#

3606

# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

3607

"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.

3608

"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]

3609

"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]

3610

"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.

3611

#

3612

# See go/stable-fleet-ug for more details.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3613

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

3614

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

3615

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

3616

"key": "A String", # Corresponds to the label key of Node resource.

3617

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

3618

"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]

3624

"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]

3625

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3626

"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.

3627

"A String",

3628

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

3629

"secureTags": [ # Secure tags to apply to this instance. These can be later modified by the update method. Maximum number of secure tags allowed is 300.

3630

"A String",

3631

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3632

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

3633

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

3634

"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

3635

#

3636

# 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.

3637

{ # A service account.

3638

"email": "A String", # Email address of the service account.

3639

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

3645

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

3646

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

3647

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

3648

},

3649

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

3650

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

3651

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3652

"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]

3653

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

3654

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

3655

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

3656

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3657

"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]

3658

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

3659

},

3660

"sourceMachineImage": "A String", # Source machine image

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3661

"sourceMachineImageEncryptionKey": { # Source GMI encryption key when creating an instance from GMI.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3662

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3663

"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.

3664

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3665

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

3666

#

3667

# The key must meet the following requirements before you can provide it to Compute Engine:

3668

# - The key is wrapped using a RSA public key certificate provided by Google.

3669

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

3670

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

3671

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

3672

},

3673

"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]

3674

"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]

3675

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

3676

"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.

3677

"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.

3678

#

3679

# To see the latest fingerprint, make get() request to the instance.

3680

"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]

3685

"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.

3686

"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]

3687

"type": "A String", # Defines the type of maintenance.

3688

},

3689

"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]

3690

}

3691

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3692

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.

3693

3694

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.

3695

3696

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]

3697

sourceInstanceTemplate: string, Specifies instance template to create the instance.

3698

3699

This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to an instance template:

3700

- https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate

3701

- projects/project/global/instanceTemplates/instanceTemplate

3702

- global/instanceTemplates/instanceTemplate

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3703

sourceMachineImage: string, Specifies the machine image to use to create the instance.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3704

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3705

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]

3706

- https://www.googleapis.com/compute/v1/projects/project/global/global/machineImages/machineImage

3707

- projects/project/global/global/machineImages/machineImage

3708

- global/machineImages/machineImage

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3709

3710

Returns:

3711

An object of the form:

3712

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3713

{ # Represents an Operation resource.

3714

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3715

# Google Compute Engine has three Operation resources:

3716

#

3717

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

3718

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3719

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

3720

#

3721

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3722

# - For global operations, use the `globalOperations` resource.

3723

# - For regional operations, use the `regionOperations` resource.

3724

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3725

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3726

# 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]

3727

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3728

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3729

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3730

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3731

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3732

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3733

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3734

"code": "A String", # [Output Only] The error type identifier for this error.

3735

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3736

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3737

},

3738

],

3739

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3740

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3741

"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.

3742

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3743

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3744

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3745

"name": "A String", # [Output Only] Name of the operation.

3746

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3747

"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.

3748

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3749

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3750

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

3751

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3752

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3753

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3754

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3755

"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.

3756

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3757

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3758

{

3759

"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.

3760

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

3761

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

3762

{

3763

"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).

3764

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3765

},

3766

],

3767

"message": "A String", # [Output Only] A human-readable description of the warning code.

3768

},

3769

],

3770

"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]

3775

<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]

3776

<pre>Retrieves the list of instances contained within the specified zone.

3777

3778

Args:

3779

project: string, Project ID for this request. (required)

3780

zone: string, The name of the zone for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3781

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]

3782

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3783

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]

3784

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3785

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]

3786

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3787

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) ```

3788

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`)

3789

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

3790

3791

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.

3792

3793

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

3794

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.

3795

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]

3796

3797

Returns:

3798

An object of the form:

3799

3800

{ # Contains a list of instances.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3801

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

3802

"items": [ # A list of Instance resources.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3803

{ # Represents an Instance resource.

3804

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3805

# 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]

3806

"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.

3807

"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).

3808

"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.

3809

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3810

"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.

3811

"confidentialInstanceConfig": { # A set of Confidential Instance options.

3812

"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]

3813

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3814

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

3815

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

3816

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

3817

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3818

"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]

3819

{ # An instance-attached disk resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3820

"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).

3821

"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.

3822

"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.

3823

#

3824

# 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]

3825

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3826

#

3827

# 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.

3828

#

3829

# 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.

3830

#

3831

# 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.

3832

#

3833

# 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]

3834

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3835

"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.

3836

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3837

"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]

3838

#

3839

# The key must meet the following requirements before you can provide it to Compute Engine:

3840

# - 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]

3841

# - 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]

3842

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3843

"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]

3844

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3845

"diskSizeGb": "A String", # The size of the disk in GB.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3846

"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]

3847

"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.

3848

{ # Guest OS features.

3849

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

3850

},

3851

],

3852

"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.

3853

"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]

3854

#

3855

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

3856

#

3857

# 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]

3858

"description": "A String", # An optional description. Provide this property when creating the disk.

3859

"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.

3860

"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.

3861

"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]

3862

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

3863

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3864

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3865

# 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:

3866

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType

3867

# - projects/project/zones/zone/diskTypes/diskType

3868

# - 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]

3869

"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]

3870

#

3871

# Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

3872

{ # Guest OS features.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3873

"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]

3874

},

3875

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3876

"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.

3877

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3878

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3879

"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]

3880

"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]

3881

"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]

3882

"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

3883

"A String",

3884

],

3885

"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.

3886

"A String",

3887

],

3888

"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]

3889

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3890

# 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:

3891

# projects/debian-cloud/global/images/family/debian-9

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3892

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3893

#

3894

# Alternatively, use a specific version of a public operating system image:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3895

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3896

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3897

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3898

# To create a disk with a custom image that you created, specify the image name in the following format:

3899

# global/images/my-custom-image

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3900

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3901

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3902

# 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:

3903

# global/images/family/my-image-family

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3904

#

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

3905

#

3906

# If the source image is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3907

"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]

3908

#

3909

# 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.

3910

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3911

"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.

3912

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3913

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

3914

#

3915

# The key must meet the following requirements before you can provide it to Compute Engine:

3916

# - The key is wrapped using a RSA public key certificate provided by Google.

3917

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

3918

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

3919

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

3920

},

3921

"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.

3922

#

3923

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

3924

# global/snapshots/my-backup

3925

#

3926

#

3927

# If the source snapshot is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3928

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3929

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3930

"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.

3931

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3932

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

3933

#

3934

# The key must meet the following requirements before you can provide it to Compute Engine:

3935

# - The key is wrapped using a RSA public key certificate provided by Google.

3936

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

3937

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

3938

"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]

3939

},

3940

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3941

"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.

3942

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

3943

"licenses": [ # [Output Only] Any valid publicly visible licenses.

3944

"A String",

3945

],

3946

"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.

3947

"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.

3948

"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

3949

"dbs": [ # The Key Database (db).

3950

{

3951

"content": "A String", # The raw content in the secure keys file.

3952

"fileType": "A String", # The file type of source file.

3953

},

3954

],

3955

"dbxs": [ # The forbidden key database (dbx).

3956

{

3957

"content": "A String", # The raw content in the secure keys file.

3958

"fileType": "A String", # The file type of source file.

3959

},

3960

],

3961

"keks": [ # The Key Exchange Key (KEK).

3962

{

3963

"content": "A String", # The raw content in the secure keys file.

3964

"fileType": "A String", # The file type of source file.

3965

},

3966

],

3967

"pk": { # The Platform Key (PK).

3968

"content": "A String", # The raw content in the secure keys file.

3969

"fileType": "A String", # The file type of source file.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3970

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3971

},

3972

"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]

3973

#

3974

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

3975

#

3976

# 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]

3977

"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]

3978

"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.

3979

"A String",

3980

],

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3981

},

3982

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3983

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

3984

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3985

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3986

"eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.

3987

"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.

3988

#

3989

# To see the latest fingerprint, make get() request to the instance.

3990

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

3991

{ # A specification of the type and number of accelerator cards attached to the instance.

3992

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

3993

"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.

3994

},

3995

],

3996

"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.

3997

"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]

3998

"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]

3999

#

4000

# 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.

4001

#

4002

# 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.

4003

#

4004

# 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.

4005

#

4006

# 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.

4007

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

4008

"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.

4009

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

4010

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

4011

#

4012

# The key must meet the following requirements before you can provide it to Compute Engine:

4013

# - The key is wrapped using a RSA public key certificate provided by Google.

4014

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

4015

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

4016

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

4017

},

4018

"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.

4019

"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.

4020

#

4021

# To see the latest fingerprint, make get() request to the instance.

4022

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

4023

"a_key": "A String",

4024

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4025

"lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format.

4026

"lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format.

4027

"lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4028

"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:

4029

# zones/us-central1-f/machineTypes/n1-standard-1

4030

#

4031

#

4032

# 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):

4033

# zones/zone/machineTypes/custom-CPUS-MEMORY

4034

#

4035

#

4036

# For example: zones/us-central1-f/machineTypes/custom-4-5120

4037

#

4038

# For a full list of restrictions, read the Specifications for custom machine types.

4039

"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

4040

"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.

4041

#

4042

# To see the latest fingerprint, make a get() request to retrieve the resource.

4043

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

4044

{

4045

"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.

4046

"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).

4047

},

4048

],

4049

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

4050

},

4051

"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".

4052

"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.

4053

"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.

4054

{ # A network interface resource attached to an instance.

4055

"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.

4056

{ # 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]

4057

"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.

4058

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4059

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

4060

"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.

4061

"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.

4062

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

4063

#

4064

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

4065

#

4066

# 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.

4067

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

4068

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

4069

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

4070

"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.

4071

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

4072

},

4073

],

4074

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

4075

{ # An alias IP range attached to an instance's network interface.

4076

"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).

4077

"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.

4078

},

4079

],

4080

"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]

4081

"internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range.

4082

"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.

4083

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

4084

"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.

4085

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

4086

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

4087

"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.

4088

"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.

4089

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

4090

#

4091

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

4092

#

4093

# 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.

4094

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

4095

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

4096

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

4097

"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.

4098

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

4099

},

4100

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4101

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

4102

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

4103

"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.

4104

"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.

4105

#

4106

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

4107

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

4108

# - projects/project/global/networks/network

4109

# - global/networks/default

4110

"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]

4111

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

4112

"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.

4113

"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.

4114

#

4115

# 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]

4116

"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:

4117

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

4118

# - regions/region/subnetworks/subnetwork

4119

},

4120

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4121

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4122

"preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api.

4123

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.

4124

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.

4125

"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.

4126

"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.

4127

"values": [ # Corresponds to the label values of a reservation resource.

"A String",

],

},

"resourcePolicies": [ # Resource policies applied to this instance.

4132

"A String",

4133

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4134

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

4135

"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]

4136

"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.

4137

#

4138

# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

4139

"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.

4140

"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]

4141

"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]

4142

"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.

4143

#

4144

# See go/stable-fleet-ug for more details.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4145

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

4146

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

4147

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

4148

"key": "A String", # Corresponds to the label key of Node resource.

4149

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

4150

"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]

4156

"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]

4157

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4158

"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.

4159

"A String",

4160

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

4161

"secureTags": [ # Secure tags to apply to this instance. These can be later modified by the update method. Maximum number of secure tags allowed is 300.

4162

"A String",

4163

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4164

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

4165

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

4166

"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

4167

#

4168

# 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.

4169

{ # A service account.

4170

"email": "A String", # Email address of the service account.

4171

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

4177

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

4178

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

4179

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

4180

},

4181

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

4182

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

4183

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4184

"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]

4185

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

4186

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

4187

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

4188

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4189

"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]

4190

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

4191

},

4192

"sourceMachineImage": "A String", # Source machine image

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4193

"sourceMachineImageEncryptionKey": { # Source GMI encryption key when creating an instance from GMI.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4194

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

4195

"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.

4196

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

4197

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

4198

#

4199

# The key must meet the following requirements before you can provide it to Compute Engine:

4200

# - The key is wrapped using a RSA public key certificate provided by Google.

4201

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

4202

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

4203

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

4204

},

4205

"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]

4206

"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]

4207

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

4208

"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.

4209

"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.

4210

#

4211

# To see the latest fingerprint, make get() request to the instance.

4212

"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]

4217

"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.

4218

"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]

4219

"type": "A String", # Defines the type of maintenance.

4220

},

4221

"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]

4222

},

4223

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4224

"kind": "compute#instanceList", # [Output Only] Type of resource. Always compute#instanceList for lists of Instance resources.

4225

"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.

4226

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

4227

"warning": { # [Output Only] Informational warning message.

4228

"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.

4229

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4230

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4231

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4232

"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).

4233

"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]

4234

},

4235

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4236

"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]

4237

},

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]

4242

<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]

4243

<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]

4244

4245

Args:

4246

project: string, Project ID for this request. (required)

4247

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4248

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]

4249

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]

4250

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4251

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]

4252

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4253

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]

4254

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4255

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]

4256

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]

4257

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

4258

4259

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.

4260

4261

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4262

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]

4263

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]

4264

4265

Returns:

4266

An object of the form:

4267

4268

{ # Contains a list of instance referrers.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4269

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

4270

"items": [ # A list of Reference resources.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4271

{ # Represents a reference to a resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4272

"kind": "compute#reference", # [Output Only] Type of the resource. Always compute#reference for references.

4273

"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]

4274

# - MEMBER_OF

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4275

"referrer": "A String", # URL of the resource which refers to the target.

4276

"target": "A String", # URL of the resource to which this reference points.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4277

},

4278

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4279

"kind": "compute#instanceListReferrers", # [Output Only] Type of resource. Always compute#instanceListReferrers for lists of Instance referrers.

4280

"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.

4281

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

4282

"warning": { # [Output Only] Informational warning message.

4283

"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.

4284

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4285

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4286

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4287

"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).

4288

"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]

4289

},

4290

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4291

"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]

4292

},

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>

4298

<pre>Retrieves the next page of results.

4299

4300

Args:

4301

previous_request: The request for the previous page. (required)

4302

previous_response: The response from the request for the previous page. (required)

4303

4304

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4305

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4306

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]

4311

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

4312

<pre>Retrieves the next page of results.

4313

4314

Args:

4315

previous_request: The request for the previous page. (required)

4316

previous_response: The response from the request for the previous page. (required)

4317

4318

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4319

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4320

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]

4325

<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]

4326

<pre>Removes resource policies from an instance.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4327

4328

Args:

4329

project: string, Project ID for this request. (required)

4330

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4331

instance: string, The instance name for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4332

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4333

The object takes the form of:

4334

4335

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4336

"resourcePolicies": [ # Resource policies to be removed from this instance.

4337

"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.

4342

4343

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.

4344

4345

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]

4346

4347

Returns:

4348

An object of the form:

4349

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4350

{ # Represents an Operation resource.

4351

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4352

# Google Compute Engine has three Operation resources:

4353

#

4354

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4355

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4356

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4357

#

4358

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4359

# - For global operations, use the `globalOperations` resource.

4360

# - For regional operations, use the `regionOperations` resource.

4361

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4362

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4363

# 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]

4364

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4365

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4366

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4367

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4368

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4369

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4370

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4371

"code": "A String", # [Output Only] The error type identifier for this error.

4372

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4373

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4374

},

4375

],

4376

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4377

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4378

"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.

4379

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4380

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4381

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4382

"name": "A String", # [Output Only] Name of the operation.

4383

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4384

"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.

4385

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4386

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4387

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

4388

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4389

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4390

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4391

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4392

"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.

4393

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4394

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4395

{

4396

"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.

4397

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4398

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4399

{

4400

"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).

4401

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4402

},

4403

],

4404

"message": "A String", # [Output Only] A human-readable description of the warning code.

4405

},

4406

],

4407

"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>

4413

<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.

4414

4415

Args:

4416

project: string, Project ID for this request. (required)

4417

zone: string, The name of the zone for this request. (required)

4418

instance: string, Name of the instance scoping this request. (required)

4419

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.

4420

4421

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.

4422

4423

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

4424

4425

Returns:

4426

An object of the form:

4427

4428

{ # Represents an Operation resource.

4429

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4430

# Google Compute Engine has three Operation resources:

4431

#

4432

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4433

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4434

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4435

#

4436

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4437

# - For global operations, use the `globalOperations` resource.

4438

# - For regional operations, use the `regionOperations` resource.

4439

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4440

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4441

# 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]

4442

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4443

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4444

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4445

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4446

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4447

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4448

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4449

"code": "A String", # [Output Only] The error type identifier for this error.

4450

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4451

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4452

},

4453

],

4454

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4455

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4456

"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.

4457

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4458

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4459

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4460

"name": "A String", # [Output Only] Name of the operation.

4461

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4462

"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.

4463

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4464

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4465

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

4466

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4467

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4468

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4469

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4470

"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.

4471

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4472

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4473

{

4474

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

4475

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4476

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4477

{

4478

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

4479

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4480

},

4481

],

4482

"message": "A String", # [Output Only] A human-readable description of the warning code.

4483

},

4484

],

4485

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

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]

4490

<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]

4491

<pre>Resumes an instance that was suspended using the instances().suspend method.

4492

4493

Args:

4494

project: string, Project ID for this request. (required)

4495

zone: string, The name of the zone for this request. (required)

4496

instance: string, Name of the instance resource to resume. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4497

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4498

The object takes the form of:

4499

4500

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4501

"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]

4502

#

4503

# In order to resume the instance, the disk url and its corresponding key must be provided.

4504

#

4505

# If the disk is not protected with a customer-supplied encryption key it should not be specified.

4506

{

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4507

"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]

4508

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

4509

"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.

4510

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

4511

"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]

4512

#

4513

# The key must meet the following requirements before you can provide it to Compute Engine:

4514

# - The key is wrapped using a RSA public key certificate provided by Google.

4515

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

4516

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4517

"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]

4518

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4519

"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]

4520

},

4521

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4522

"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]

4523

#

4524

# 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.

4525

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

4526

"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.

4527

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

4528

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

4529

#

4530

# The key must meet the following requirements before you can provide it to Compute Engine:

4531

# - The key is wrapped using a RSA public key certificate provided by Google.

4532

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

4533

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

4534

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

4535

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4536

}

4537

4538

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.

4539

4540

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.

4541

4542

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

4543

4544

Returns:

4545

An object of the form:

4546

4547

{ # Represents an Operation resource.

4548

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4549

# Google Compute Engine has three Operation resources:

4550

#

4551

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4552

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4553

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4554

#

4555

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4556

# - For global operations, use the `globalOperations` resource.

4557

# - For regional operations, use the `regionOperations` resource.

4558

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4559

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4560

# 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]

4561

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4562

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4563

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4564

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4565

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4566

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4567

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4568

"code": "A String", # [Output Only] The error type identifier for this error.

4569

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4570

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4571

},

4572

],

4573

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4574

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4575

"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.

4576

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4577

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4578

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4579

"name": "A String", # [Output Only] Name of the operation.

4580

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4581

"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.

4582

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4583

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4584

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

4585

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4586

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4587

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4588

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4589

"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.

4590

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4591

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4592

{

4593

"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.

4594

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4595

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4596

{

4597

"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).

4598

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4599

},

4600

],

4601

"message": "A String", # [Output Only] A human-readable description of the warning code.

4602

},

4603

],

4604

"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>

4610

<pre>Sets deletion protection on the instance.

4611

4612

Args:

4613

project: string, Project ID for this request. (required)

4614

zone: string, The name of the zone for this request. (required)

4615

resource: string, Name or id of the resource for this request. (required)

4616

deletionProtection: boolean, Whether the resource should be protected against deletion.

4617

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.

4618

4619

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.

4620

4621

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

4622

4623

Returns:

4624

An object of the form:

4625

4626

{ # Represents an Operation resource.

4627

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4628

# Google Compute Engine has three Operation resources:

4629

#

4630

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4631

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4632

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4633

#

4634

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4635

# - For global operations, use the `globalOperations` resource.

4636

# - For regional operations, use the `regionOperations` resource.

4637

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4638

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4639

# 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]

4640

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4641

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4642

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4643

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4644

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4645

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4646

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4647

"code": "A String", # [Output Only] The error type identifier for this error.

4648

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4649

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4650

},

4651

],

4652

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4653

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4654

"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.

4655

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4656

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4657

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4658

"name": "A String", # [Output Only] Name of the operation.

4659

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4660

"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.

4661

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4662

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4663

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

4664

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4665

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4666

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4667

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4668

"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.

4669

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4670

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4671

{

4672

"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.

4673

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4674

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4675

{

4676

"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).

4677

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4678

},

4679

],

4680

"message": "A String", # [Output Only] A human-readable description of the warning code.

4681

},

4682

],

4683

"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]

4688

<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]

4689

<pre>Sets the auto-delete flag for a disk attached to an instance.

4690

4691

Args:

4692

project: string, Project ID for this request. (required)

4693

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4694

instance: string, The instance name for this request. (required)

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4695

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]

4696

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)

4697

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.

4698

4699

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.

4700

4701

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]

4702

4703

Returns:

4704

An object of the form:

4705

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4706

{ # Represents an Operation resource.

4707

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4708

# Google Compute Engine has three Operation resources:

4709

#

4710

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4711

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4712

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4713

#

4714

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4715

# - For global operations, use the `globalOperations` resource.

4716

# - For regional operations, use the `regionOperations` resource.

4717

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4718

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4719

# 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]

4720

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4721

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4722

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4723

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4724

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4725

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4726

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4727

"code": "A String", # [Output Only] The error type identifier for this error.

4728

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4729

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4730

},

4731

],

4732

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4733

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4734

"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.

4735

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4736

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4737

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4738

"name": "A String", # [Output Only] Name of the operation.

4739

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4740

"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.

4741

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4742

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4743

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

4744

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4745

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4746

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4747

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4748

"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.

4749

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4750

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4751

{

4752

"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.

4753

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4754

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4755

{

4756

"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).

4757

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4758

},

4759

],

4760

"message": "A String", # [Output Only] A human-readable description of the warning code.

4761

},

4762

],

4763

"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]

4768

<code class="details" id="setIamPolicy">setIamPolicy(project, zone, resource, body=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4769

<pre>Sets the access control policy on the specified resource. Replaces any existing policy.

4770

4771

Args:

4772

project: string, Project ID for this request. (required)

4773

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4774

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4775

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4776

The object takes the form of:

4777

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4778

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4779

"bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings.

4780

{ # Associates `members` with a `role`.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

4781

"bindingId": "A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4782

"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.

4783

#

4784

# If the condition evaluates to `true`, then this binding applies to the current request.

4785

#

4786

# 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.

4787

#

4788

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

4789

#

4790

# Example (Comparison):

4791

#

4792

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

4793

#

4794

# Example (Equality):

4795

#

4796

# 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'"

4801

#

4802

# Example (Data Manipulation):

4803

#

4804

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

4805

#

4806

# 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.

4807

"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.

4808

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

4809

"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.

4810

"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.

4811

},

4812

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

4813

#

4814

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

4815

#

4816

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

4817

#

4818

# * `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`.

4823

#

4824

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

4825

#

4826

# * `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.

4827

#

4828

# * `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.

4829

#

4830

# * `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`.

4835

"A String",

4836

],

4837

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

4838

},

4839

],

4840

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.

4841

"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]

4842

#

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4843

#

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4844

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4845

# 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]

4846

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4847

# 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]

4848

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4849

# **JSON example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4850

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4851

# { "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]

4852

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4853

# **YAML example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4854

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4855

# 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]

4856

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4857

# 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]

4858

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4859

{ # 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]

4860

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4861

# 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]

4862

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4863

# Example Policy with multiple AuditConfigs:

4864

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4865

# { "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]

4866

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4867

# 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]

4868

"auditLogConfigs": [ # The configuration for logging of each type of permission.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4869

{ # Provides the configuration for logging a type of permissions. Example:

4870

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4871

# { "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]

4872

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4873

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

4874

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

4875

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4876

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4877

"ignoreChildExemptions": True or False,

4878

"logType": "A String", # The log type that this config enables.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4879

},

4880

],

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]

4885

},

4886

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4887

"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]

4888

{ # Associates `members` with a `role`.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

4889

"bindingId": "A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4890

"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.

4891

#

4892

# If the condition evaluates to `true`, then this binding applies to the current request.

4893

#

4894

# 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.

4895

#

4896

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

4897

#

4898

# Example (Comparison):

4899

#

4900

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

4901

#

4902

# Example (Equality):

4903

#

4904

# 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'"

4909

#

4910

# Example (Data Manipulation):

4911

#

4912

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

4913

#

4914

# 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.

4915

"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.

4916

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

4917

"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.

4918

"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.

4919

},

4920

"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]

4921

#

4922

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

4923

#

4924

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

4925

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4926

# * `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`.

4931

#

4932

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

4933

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4934

# * `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.

4935

#

4936

# * `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.

4937

#

4938

# * `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.

4939

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4940

#

4941

#

4942

# * `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]

4943

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4944

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4945

"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]

4946

},

4947

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4948

"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.

4949

#

4950

# **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.

4951

"iamOwned": True or False,

4952

"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.

4953

{ # A rule to be applied in a Policy.

4954

"action": "A String", # Required

4955

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

4956

{ # A condition to be met.

4957

"iam": "A String", # Trusted attributes supplied by the IAM system.

4958

"op": "A String", # An operator to apply the subject with.

4959

"svc": "A String", # Trusted attributes discharged by the service.

4960

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

4961

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

4967

"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.

4968

"A String",

4969

],

4970

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

4971

{ # Specifies what kind of log the caller must write

4972

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

4973

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

4974

"permissionType": "A String", # The type of the permission that was checked.

4975

},

4976

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

4977

},

4978

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

4979

#

4980

# 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.

4981

#

4982

# Field names correspond to IAM request parameters and field values are their respective values.

4983

#

4984

# 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.

4985

#

4986

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

4987

"customFields": [ # Custom fields.

4988

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

4989

"name": "A String", # Name is the field name.

4990

"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.

4991

},

4992

],

4993

"field": "A String", # The field value to attribute.

4994

"metric": "A String", # The metric to update.

4995

},

4996

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

4997

"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.

5002

"A String",

5003

],

5004

"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.

5005

"A String",

5006

],

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5007

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5008

],

5009

"version": 42, # Specifies the format of the policy.

5010

#

5011

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

5012

#

5013

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

5014

#

5015

# * 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

5016

#

5017

# **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.

5018

#

5019

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

5020

#

5021

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

5022

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5023

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

Returns:

An object of the form:

5028

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5029

{ # 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]

5030

#

5031

#

5032

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5033

# 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]

5034

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5035

# 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]

5036

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5037

# **JSON example:**

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5038

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5039

# { "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]

5040

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5041

# **YAML example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5042

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5043

# 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]

5044

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5045

# 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]

5046

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

5047

{ # 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]

5048

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5049

# 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]

5050

#

5051

# Example Policy with multiple AuditConfigs:

5052

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5053

# { "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]

5054

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5055

# 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]

5056

"auditLogConfigs": [ # The configuration for logging of each type of permission.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

5057

{ # Provides the configuration for logging a type of permissions. Example:

5058

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5059

# { "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]

5060

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5061

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

5062

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

5063

"A String",

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

5064

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5065

"ignoreChildExemptions": True or False,

5066

"logType": "A String", # The log type that this config enables.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

5067

},

5068

],

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]

5073

},

5074

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5075

"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]

5076

{ # Associates `members` with a `role`.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

5077

"bindingId": "A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5078

"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.

5079

#

5080

# If the condition evaluates to `true`, then this binding applies to the current request.

5081

#

5082

# 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.

5083

#

5084

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

5085

#

5086

# Example (Comparison):

5087

#

5088

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

5089

#

5090

# Example (Equality):

5091

#

5092

# 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'"

5097

#

5098

# Example (Data Manipulation):

5099

#

5100

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

5101

#

5102

# 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.

5103

"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.

5104

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

5105

"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.

5106

"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.

5107

},

5108

"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]

5109

#

5110

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

5111

#

5112

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

5113

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5114

# * `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]

5115

#

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

5116

#

5117

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5118

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

5119

#

5120

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

5121

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5122

# * `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.

5123

#

5124

# * `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.

5125

#

5126

# * `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.

5127

#

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

5128

#

5129

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5130

# * `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]

5131

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5132

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5133

"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]

5134

},

5135

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5136

"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.

5137

#

5138

# **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.

5139

"iamOwned": True or False,

5140

"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.

5141

{ # A rule to be applied in a Policy.

5142

"action": "A String", # Required

5143

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

5144

{ # A condition to be met.

5145

"iam": "A String", # Trusted attributes supplied by the IAM system.

5146

"op": "A String", # An operator to apply the subject with.

5147

"svc": "A String", # Trusted attributes discharged by the service.

5148

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

5149

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

5155

"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.

5156

"A String",

5157

],

5158

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

5159

{ # Specifies what kind of log the caller must write

5160

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

5161

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

5162

"permissionType": "A String", # The type of the permission that was checked.

5163

},

5164

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

5165

},

5166

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

5167

#

5168

# 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.

5169

#

5170

# Field names correspond to IAM request parameters and field values are their respective values.

5171

#

5172

# 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.

5173

#

5174

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

5175

"customFields": [ # Custom fields.

5176

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

5177

"name": "A String", # Name is the field name.

5178

"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.

5179

},

5180

],

5181

"field": "A String", # The field value to attribute.

5182

"metric": "A String", # The metric to update.

5183

},

5184

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

5185

"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.

5190

"A String",

5191

],

5192

"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.

5198

#

5199

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

5200

#

5201

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

5202

#

5203

# * 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

5204

#

5205

# **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.

5206

#

5207

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

5208

#

5209

# 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]

5214

<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]

5215

<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]

5216

5217

Args:

5218

project: string, Project ID for this request. (required)

5219

zone: string, The name of the zone for this request. (required)

5220

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5221

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5222

The object takes the form of:

5223

5224

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5225

"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.

5226

"labels": {

5227

"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]

5231

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.

5232

5233

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.

5234

5235

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]

5236

5237

Returns:

5238

An object of the form:

5239

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5240

{ # Represents an Operation resource.

5241

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5242

# Google Compute Engine has three Operation resources:

5243

#

5244

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5245

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5246

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5247

#

5248

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5249

# - For global operations, use the `globalOperations` resource.

5250

# - For regional operations, use the `regionOperations` resource.

5251

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5252

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5253

# 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]

5254

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5255

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5256

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5257

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5258

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5259

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5260

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5261

"code": "A String", # [Output Only] The error type identifier for this error.

5262

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5263

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5264

},

5265

],

5266

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5267

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5268

"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.

5269

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5270

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5271

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5272

"name": "A String", # [Output Only] Name of the operation.

5273

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5274

"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.

5275

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5276

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5277

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5278

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5279

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5280

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5281

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5282

"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.

5283

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5284

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5285

{

5286

"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.

5287

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5288

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5289

{

5290

"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).

5291

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5292

},

5293

],

5294

"message": "A String", # [Output Only] A human-readable description of the warning code.

5295

},

5296

],

5297

"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]

5302

<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]

5303

<pre>Changes the number and/or type of accelerator for a stopped instance to the values specified in the request.

5304

5305

Args:

5306

project: string, Project ID for this request. (required)

5307

zone: string, The name of the zone for this request. (required)

5308

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5309

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

5310

The object takes the form of:

5311

5312

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5313

"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]

5314

{ # 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]

5315

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

5316

"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]

5321

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.

5322

5323

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.

5324

5325

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]

5326

5327

Returns:

5328

An object of the form:

5329

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5330

{ # Represents an Operation resource.

5331

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5332

# Google Compute Engine has three Operation resources:

5333

#

5334

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5335

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5336

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5337

#

5338

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5339

# - For global operations, use the `globalOperations` resource.

5340

# - For regional operations, use the `regionOperations` resource.

5341

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5342

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5343

# 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]

5344

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5345

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5346

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5347

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5348

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5349

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

5350

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5351

"code": "A String", # [Output Only] The error type identifier for this error.

5352

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5353

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

5354

},

5355

],

5356

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5357

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5358

"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.

5359

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5360

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5361

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5362

"name": "A String", # [Output Only] Name of the operation.

5363

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5364

"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.

5365

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5366

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5367

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5368

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5369

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5370

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5371

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5372

"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.

5373

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5374

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5375

{

5376

"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.

5377

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5378

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5379

{

5380

"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).

5381

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5382

},

5383

],

5384

"message": "A String", # [Output Only] A human-readable description of the warning code.

5385

},

5386

],

5387

"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]

5392

<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]

5393

<pre>Changes the machine type for a stopped instance to the machine type specified in the request.

5394

5395

Args:

5396

project: string, Project ID for this request. (required)

5397

zone: string, The name of the zone for this request. (required)

5398

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5399

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5400

The object takes the form of:

5401

5402

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5403

"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]

5404

}

5405

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5406

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.

5407

5408

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.

5409

5410

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]

5411

5412

Returns:

5413

An object of the form:

5414

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5415

{ # Represents an Operation resource.

5416

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5417

# Google Compute Engine has three Operation resources:

5418

#

5419

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5420

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5421

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5422

#

5423

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5424

# - For global operations, use the `globalOperations` resource.

5425

# - For regional operations, use the `regionOperations` resource.

5426

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5427

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5428

# 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]

5429

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5430

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5431

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5432

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5433

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5434

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5435

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5436

"code": "A String", # [Output Only] The error type identifier for this error.

5437

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5438

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5439

},

5440

],

5441

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5442

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5443

"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.

5444

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5445

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5446

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5447

"name": "A String", # [Output Only] Name of the operation.

5448

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5449

"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.

5450

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5451

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5452

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5453

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5454

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5455

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5456

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5457

"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.

5458

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5459

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5460

{

5461

"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.

5462

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5463

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5464

{

5465

"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).

5466

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5467

},

5468

],

5469

"message": "A String", # [Output Only] A human-readable description of the warning code.

5470

},

5471

],

5472

"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]

5477

<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]

5478

<pre>Sets metadata for the specified instance to the data included in the request.

5479

5480

Args:

5481

project: string, Project ID for this request. (required)

5482

zone: string, The name of the zone for this request. (required)

5483

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5484

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5485

The object takes the form of:

5486

5487

{ # A metadata key/value entry.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5488

"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]

5489

#

5490

# 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]

5491

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

5492

{

5493

"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.

5494

"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).

5495

},

5496

],

5497

"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]

5498

}

5499

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5500

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.

5501

5502

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.

5503

5504

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]

5505

5506

Returns:

5507

An object of the form:

5508

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5509

{ # Represents an Operation resource.

5510

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5511

# Google Compute Engine has three Operation resources:

5512

#

5513

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5514

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5515

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5516

#

5517

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5518

# - For global operations, use the `globalOperations` resource.

5519

# - For regional operations, use the `regionOperations` resource.

5520

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5521

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5522

# 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]

5523

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5524

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5525

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5526

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5527

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5528

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5529

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5530

"code": "A String", # [Output Only] The error type identifier for this error.

5531

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5532

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5533

},

5534

],

5535

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5536

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5537

"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.

5538

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5539

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5540

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5541

"name": "A String", # [Output Only] Name of the operation.

5542

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5543

"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.

5544

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5545

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5546

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5547

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5548

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5549

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5550

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5551

"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.

5552

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5553

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5554

{

5555

"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.

5556

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5557

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5558

{

5559

"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).

5560

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5561

},

5562

],

5563

"message": "A String", # [Output Only] A human-readable description of the warning code.

5564

},

5565

],

5566

"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]

5571

<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]

5572

<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]

5573

5574

Args:

5575

project: string, Project ID for this request. (required)

5576

zone: string, The name of the zone for this request. (required)

5577

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5578

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

5579

The object takes the form of:

5580

5581

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5582

"minCpuPlatform": "A String", # Minimum cpu/platform this instance should be started at.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

5583

}

5584

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5585

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.

5586

5587

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.

5588

5589

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]

5590

5591

Returns:

5592

An object of the form:

5593

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5594

{ # Represents an Operation resource.

5595

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5596

# Google Compute Engine has three Operation resources:

5597

#

5598

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5599

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5600

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5601

#

5602

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5603

# - For global operations, use the `globalOperations` resource.

5604

# - For regional operations, use the `regionOperations` resource.

5605

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5606

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5607

# 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]

5608

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5609

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5610

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5611

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5612

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5613

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5614

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5615

"code": "A String", # [Output Only] The error type identifier for this error.

5616

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5617

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5618

},

5619

],

5620

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5621

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5622

"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.

5623

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5624

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5625

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5626

"name": "A String", # [Output Only] Name of the operation.

5627

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5628

"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.

5629

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5630

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5631

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5632

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5633

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5634

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5635

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5636

"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.

5637

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5638

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5639

{

5640

"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.

5641

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5642

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5643

{

5644

"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).

5645

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5646

},

5647

],

5648

"message": "A String", # [Output Only] A human-readable description of the warning code.

5649

},

5650

],

5651

"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]

5656

<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]

5657

<pre>Sets name of an instance.

5658

5659

Args:

5660

project: string, Project ID for this request. (required)

5661

zone: string, The name of the zone for this request. (required)

5662

instance: string, The instance name for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5663

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5664

The object takes the form of:

5665

5666

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5667

"currentName": "A String", # The current name of this resource, used to prevent conflicts. Provide the latest name when making a request to change name.

5668

"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]

5669

}

5670

5671

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.

5672

5673

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.

5674

5675

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

5676

5677

Returns:

5678

An object of the form:

5679

5680

{ # Represents an Operation resource.

5681

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5682

# Google Compute Engine has three Operation resources:

5683

#

5684

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5685

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5686

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5687

#

5688

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5689

# - For global operations, use the `globalOperations` resource.

5690

# - For regional operations, use the `regionOperations` resource.

5691

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5692

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5693

# 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]

5694

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5695

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5696

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5697

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5698

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5699

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

5700

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5701

"code": "A String", # [Output Only] The error type identifier for this error.

5702

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5703

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

5704

},

5705

],

5706

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5707

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5708

"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.

5709

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5710

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5711

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5712

"name": "A String", # [Output Only] Name of the operation.

5713

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5714

"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.

5715

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5716

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5717

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5718

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5719

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5720

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5721

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5722

"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.

5723

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5724

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5725

{

5726

"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.

5727

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5728

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5729

{

5730

"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).

5731

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5732

},

5733

],

5734

"message": "A String", # [Output Only] A human-readable description of the warning code.

5735

},

5736

],

5737

"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]

5742

<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]

5743

<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]

5744

5745

Args:

5746

project: string, Project ID for this request. (required)

5747

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5748

instance: string, Instance name for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5749

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5750

The object takes the form of:

5751

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5752

{ # Sets the scheduling options for an Instance. NextID: 13

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5753

"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.

5754

#

5755

# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

5756

"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.

5757

"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]

5758

"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]

5759

"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.

5760

#

5761

# See go/stable-fleet-ug for more details.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5762

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

5763

"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]

5764

{ # 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]

5765

"key": "A String", # Corresponds to the label key of Node resource.

5766

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

5767

"values": [ # Corresponds to the label values of Node resource.

5768

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5769

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5770

},

5771

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5772

"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]

5773

"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]

5774

}

5775

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5776

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.

5777

5778

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.

5779

5780

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]

5781

5782

Returns:

5783

An object of the form:

5784

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5785

{ # Represents an Operation resource.

5786

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5787

# Google Compute Engine has three Operation resources:

5788

#

5789

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5790

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5791

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5792

#

5793

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5794

# - For global operations, use the `globalOperations` resource.

5795

# - For regional operations, use the `regionOperations` resource.

5796

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5797

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5798

# 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]

5799

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5800

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5801

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5802

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5803

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5804

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5805

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5806

"code": "A String", # [Output Only] The error type identifier for this error.

5807

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5808

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5809

},

5810

],

5811

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5812

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5813

"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.

5814

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5815

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5816

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5817

"name": "A String", # [Output Only] Name of the operation.

5818

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5819

"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.

5820

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5821

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5822

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5823

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5824

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5825

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5826

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5827

"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.

5828

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5829

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5830

{

5831

"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.

5832

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5833

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5834

{

5835

"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).

5836

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5837

},

5838

],

5839

"message": "A String", # [Output Only] A human-readable description of the warning code.

5840

},

5841

],

5842

"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]

5847

<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]

5848

<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]

5849

5850

Args:

5851

project: string, Project ID for this request. (required)

5852

zone: string, The name of the zone for this request. (required)

5853

instance: string, Name of the instance resource to start. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5854

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5855

The object takes the form of:

5856

5857

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5858

"email": "A String", # Email address of the service account.

5859

"scopes": [ # The list of scopes to be made available for this service account.

5860

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5861

],

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5862

}

5863

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5864

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.

5865

5866

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.

5867

5868

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]

5869

5870

Returns:

5871

An object of the form:

5872

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5873

{ # Represents an Operation resource.

5874

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5875

# Google Compute Engine has three Operation resources:

5876

#

5877

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5878

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5879

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5880

#

5881

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5882

# - For global operations, use the `globalOperations` resource.

5883

# - For regional operations, use the `regionOperations` resource.

5884

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5885

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5886

# 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]

5887

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5888

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5889

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5890

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5891

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5892

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5893

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5894

"code": "A String", # [Output Only] The error type identifier for this error.

5895

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5896

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5897

},

5898

],

5899

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5900

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5901

"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.

5902

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5903

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5904

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5905

"name": "A String", # [Output Only] Name of the operation.

5906

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5907

"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.

5908

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5909

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5910

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5911

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5912

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5913

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5914

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5915

"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.

5916

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5917

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5918

{

5919

"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.

5920

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5921

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5922

{

5923

"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).

5924

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5925

},

5926

],

5927

"message": "A String", # [Output Only] A human-readable description of the warning code.

5928

},

5929

],

5930

"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]

5935

<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]

5936

<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.

5937

5938

Args:

5939

project: string, Project ID for this request. (required)

5940

zone: string, The name of the zone for this request. (required)

5941

instance: string, Name or id of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5942

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5943

The object takes the form of:

5944

5945

{ # The policy describes the baseline against which Instance boot integrity is measured.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5946

"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]

5947

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5948

5949

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.

5950

5951

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.

5952

5953

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

5954

5955

Returns:

5956

An object of the form:

5957

5958

{ # Represents an Operation resource.

5959

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5960

# Google Compute Engine has three Operation resources:

5961

#

5962

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5963

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5964

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5965

#

5966

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5967

# - For global operations, use the `globalOperations` resource.

5968

# - For regional operations, use the `regionOperations` resource.

5969

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5970

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5971

# 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]

5972

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5973

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5974

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5975

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5976

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5977

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5978

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5979

"code": "A String", # [Output Only] The error type identifier for this error.

5980

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5981

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5982

},

5983

],

5984

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5985

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5986

"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.

5987

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5988

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5989

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5990

"name": "A String", # [Output Only] Name of the operation.

5991

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5992

"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.

5993

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5994

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5995

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5996

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5997

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5998

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5999

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6000

"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.

6001

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6002

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6003

{

6004

"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.

6005

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6006

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6007

{

6008

"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).

6009

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6010

},

6011

],

6012

"message": "A String", # [Output Only] A human-readable description of the warning code.

6013

},

6014

],

6015

"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]

6020

<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]

6021

<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.

6022

6023

Args:

6024

project: string, Project ID for this request. (required)

6025

zone: string, The name of the zone for this request. (required)

6026

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6027

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6028

The object takes the form of:

6029

6030

{ # 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]

6031

"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]

6032

}

6033

6034

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.

6035

6036

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.

6037

6038

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

6039

6040

Returns:

6041

An object of the form:

6042

6043

{ # Represents an Operation resource.

6044

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6045

# Google Compute Engine has three Operation resources:

6046

#

6047

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6048

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6049

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6050

#

6051

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6052

# - For global operations, use the `globalOperations` resource.

6053

# - For regional operations, use the `regionOperations` resource.

6054

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6055

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6056

# 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]

6057

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6058

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6059

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6060

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6061

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6062

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6063

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6064

"code": "A String", # [Output Only] The error type identifier for this error.

6065

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6066

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6067

},

6068

],

6069

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6070

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6071

"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.

6072

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6073

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6074

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6075

"name": "A String", # [Output Only] Name of the operation.

6076

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6077

"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.

6078

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6079

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6080

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

6081

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6082

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6083

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6084

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6085

"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.

6086

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6087

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6088

{

6089

"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.

6090

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6091

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6092

{

6093

"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).

6094

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6095

},

6096

],

6097

"message": "A String", # [Output Only] A human-readable description of the warning code.

6098

},

6099

],

6100

"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]

6105

<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]

6106

<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]

6107

6108

Args:

6109

project: string, Project ID for this request. (required)

6110

zone: string, The name of the zone for this request. (required)

6111

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6112

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6113

The object takes the form of:

6114

6115

{ # A set of instance tags.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6116

"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]

6117

#

6118

# To see the latest fingerprint, make get() request to the instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6119

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

6120

"A String",

6121

],

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6122

}

6123

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6124

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.

6125

6126

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.

6127

6128

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]

6129

6130

Returns:

6131

An object of the form:

6132

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6133

{ # Represents an Operation resource.

6134

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6135

# Google Compute Engine has three Operation resources:

6136

#

6137

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6138

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6139

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6140

#

6141

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6142

# - For global operations, use the `globalOperations` resource.

6143

# - For regional operations, use the `regionOperations` resource.

6144

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6145

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6146

# 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]

6147

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6148

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6149

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6150

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6151

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6152

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6153

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6154

"code": "A String", # [Output Only] The error type identifier for this error.

6155

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6156

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6157

},

6158

],

6159

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6160

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6161

"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.

6162

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6163

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6164

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6165

"name": "A String", # [Output Only] Name of the operation.

6166

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6167

"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.

6168

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6169

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6170

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

6171

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6172

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6173

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6174

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6175

"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.

6176

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6177

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6178

{

6179

"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.

6180

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6181

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6182

{

6183

"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).

6184

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6185

},

6186

],

6187

"message": "A String", # [Output Only] A human-readable description of the warning code.

6188

},

6189

],

6190

"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]

6195

<code class="details" id="simulateMaintenanceEvent">simulateMaintenanceEvent(project, zone, instance)</code>

6196

<pre>Simulates a maintenance event on the instance.

6197

6198

Args:

6199

project: string, Project ID for this request. (required)

6200

zone: string, The name of the zone for this request. (required)

6201

instance: string, Name of the instance scoping this request. (required)

6202

6203

Returns:

6204

An object of the form:

6205

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6206

{ # Represents an Operation resource.

6207

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6208

# Google Compute Engine has three Operation resources:

6209

#

6210

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6211

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6212

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6213

#

6214

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6215

# - For global operations, use the `globalOperations` resource.

6216

# - For regional operations, use the `regionOperations` resource.

6217

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6218

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6219

# 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]

6220

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6221

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6222

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6223

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6224

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6225

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

6226

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6227

"code": "A String", # [Output Only] The error type identifier for this error.

6228

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6229

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

6230

},

6231

],

6232

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6233

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6234

"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.

6235

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6236

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6237

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6238

"name": "A String", # [Output Only] Name of the operation.

6239

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6240

"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.

6241

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6242

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6243

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

6244

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6245

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6246

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6247

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6248

"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.

6249

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6250

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6251

{

6252

"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.

6253

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6254

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6255

{

6256

"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).

6257

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6258

},

6259

],

6260

"message": "A String", # [Output Only] A human-readable description of the warning code.

6261

},

6262

],

6263

"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]

6269

<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]

6270

6271

Args:

6272

project: string, Project ID for this request. (required)

6273

zone: string, The name of the zone for this request. (required)

6274

instance: string, Name of the instance resource to start. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6275

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.

6276

6277

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.

6278

6279

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]

6280

6281

Returns:

6282

An object of the form:

6283

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6284

{ # Represents an Operation resource.

6285

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6286

# Google Compute Engine has three Operation resources:

6287

#

6288

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6289

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6290

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6291

#

6292

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6293

# - For global operations, use the `globalOperations` resource.

6294

# - For regional operations, use the `regionOperations` resource.

6295

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6296

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6297

# 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]

6298

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6299

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6300

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6301

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6302

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6303

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6304

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6305

"code": "A String", # [Output Only] The error type identifier for this error.

6306

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6307

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6308

},

6309

],

6310

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6311

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6312

"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.

6313

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6314

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6315

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6316

"name": "A String", # [Output Only] Name of the operation.

6317

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6318

"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.

6319

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6320

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6321

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

6322

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6323

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6324

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6325

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6326

"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.

6327

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6328

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6329

{

6330

"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.

6331

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6332

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6333

{

6334

"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).

6335

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6336

},

6337

],

6338

"message": "A String", # [Output Only] A human-readable description of the warning code.

6339

},

6340

],

6341

"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]

6346

<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]

6347

<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]

6348

6349

Args:

6350

project: string, Project ID for this request. (required)

6351

zone: string, The name of the zone for this request. (required)

6352

instance: string, Name of the instance resource to start. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6353

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6354

The object takes the form of:

6355

6356

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6357

"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]

6358

#

6359

# In order to start the instance, the disk url and its corresponding key must be provided.

6360

#

6361

# If the disk is not protected with a customer-supplied encryption key it should not be specified.

6362

{

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6363

"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]

6364

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

6365

"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.

6366

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

6367

"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]

6368

#

6369

# The key must meet the following requirements before you can provide it to Compute Engine:

6370

# - 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]

6371

# - 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]

6372

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6373

"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]

6374

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6375

"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]

6376

},

6377

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6378

"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]

6379

#

6380

# 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.

6381

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

6382

"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.

6383

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

6384

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

6385

#

6386

# The key must meet the following requirements before you can provide it to Compute Engine:

6387

# - The key is wrapped using a RSA public key certificate provided by Google.

6388

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

6389

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

6390

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

6391

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6392

}

6393

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6394

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.

6395

6396

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.

6397

6398

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]

6399

6400

Returns:

6401

An object of the form:

6402

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6403

{ # Represents an Operation resource.

6404

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6405

# Google Compute Engine has three Operation resources:

6406

#

6407

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6408

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6409

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6410

#

6411

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6412

# - For global operations, use the `globalOperations` resource.

6413

# - For regional operations, use the `regionOperations` resource.

6414

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6415

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6416

# 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]

6417

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6418

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6419

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6420

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6421

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6422

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6423

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6424

"code": "A String", # [Output Only] The error type identifier for this error.

6425

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6426

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6427

},

6428

],

6429

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6430

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6431

"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.

6432

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6433

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6434

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6435

"name": "A String", # [Output Only] Name of the operation.

6436

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6437

"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.

6438

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6439

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6440

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

6441

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6442

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6443

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6444

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6445

"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.

6446

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6447

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6448

{

6449

"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.

6450

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6451

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6452

{

6453

"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).

6454

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6455

},

6456

],

6457

"message": "A String", # [Output Only] A human-readable description of the warning code.

6458

},

6459

],

6460

"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]

6465

<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]

6466

<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]

6467

6468

Args:

6469

project: string, Project ID for this request. (required)

6470

zone: string, The name of the zone for this request. (required)

6471

instance: string, Name of the instance resource to stop. (required)

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

6472

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]

6473

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.

6474

6475

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.

6476

6477

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]

6478

6479

Returns:

6480

An object of the form:

6481

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6482

{ # Represents an Operation resource.

6483

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6484

# Google Compute Engine has three Operation resources:

6485

#

6486

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6487

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6488

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6489

#

6490

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6491

# - For global operations, use the `globalOperations` resource.

6492

# - For regional operations, use the `regionOperations` resource.

6493

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6494

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6495

# 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]

6496

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6497

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6498

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6499

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6500

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6501

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6502

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6503

"code": "A String", # [Output Only] The error type identifier for this error.

6504

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6505

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6506

},

6507

],

6508

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6509

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6510

"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.

6511

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6512

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6513

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6514

"name": "A String", # [Output Only] Name of the operation.

6515

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6516

"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.

6517

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6518

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6519

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

6520

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6521

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6522

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6523

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6524

"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.

6525

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6526

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6527

{

6528

"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.

6529

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6530

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6531

{

6532

"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).

6533

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6534

},

6535

],

6536

"message": "A String", # [Output Only] A human-readable description of the warning code.

6537

},

6538

],

6539

"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]

6544

<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]

6545

<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.

6546

6547

Args:

6548

project: string, Project ID for this request. (required)

6549

zone: string, The name of the zone for this request. (required)

6550

instance: string, Name of the instance resource to suspend. (required)

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

6551

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]

6552

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.

6553

6554

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.

6555

6556

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]

6557

6558

Returns:

6559

An object of the form:

6560

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6561

{ # Represents an Operation resource.

6562

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6563

# Google Compute Engine has three Operation resources:

6564

#

6565

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6566

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6567

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6568

#

6569

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6570

# - For global operations, use the `globalOperations` resource.

6571

# - For regional operations, use the `regionOperations` resource.

6572

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6573

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6574

# 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]

6575

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6576

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6577

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6578

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6579

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6580

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6581

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6582

"code": "A String", # [Output Only] The error type identifier for this error.

6583

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6584

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6585

},

6586

],

6587

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6588

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6589

"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.

6590

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6591

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6592

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6593

"name": "A String", # [Output Only] Name of the operation.

6594

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6595

"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.

6596

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6597

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6598

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

6599

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6600

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6601

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6602

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6603

"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.

6604

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6605

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6606

{

6607

"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.

6608

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6609

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6610

{

6611

"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).

6612

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6613

},

6614

],

6615

"message": "A String", # [Output Only] A human-readable description of the warning code.

6616

},

6617

],

6618

"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]

6623

<code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6624

<pre>Returns permissions that a caller has on the specified resource.

6625

6626

Args:

6627

project: string, Project ID for this request. (required)

6628

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6629

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6630

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6631

The object takes the form of:

6632

6633

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6634

"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.

6635

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

],

}

Returns:

An object of the form:

6642

6643

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6644

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.

6645

"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]

6651

<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]

6652

<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.

6653

6654

Args:

6655

project: string, Project ID for this request. (required)

6656

zone: string, The name of the zone for this request. (required)

6657

instance: string, Name of the instance resource to update. (required)

6658

body: object, The request body.

6659

The object takes the form of:

6660

6661

{ # Represents an Instance resource.

6662

#

6663

# 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]

6664

"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.

6665

"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).

6666

"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.

6667

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6668

"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.

6669

"confidentialInstanceConfig": { # A set of Confidential Instance options.

6670

"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]

6671

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6672

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

6673

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

6674

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

6675

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

6676

"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]

6677

{ # An instance-attached disk resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6678

"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).

6679

"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.

6680

"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.

6681

#

6682

# 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]

6683

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6684

#

6685

# 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.

6686

#

6687

# 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.

6688

#

6689

# 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.

6690

#

6691

# 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]

6692

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

6693

"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.

6694

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

6695

"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]

6696

#

6697

# The key must meet the following requirements before you can provide it to Compute Engine:

6698

# - The key is wrapped using a RSA public key certificate provided by Google.

6699

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

6700

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6701

"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]

6702

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6703

"diskSizeGb": "A String", # The size of the disk in GB.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

6704

"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]

6705

"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.

6706

{ # Guest OS features.

6707

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

6708

},

6709

],

6710

"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.

6711

"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]

6712

#

6713

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

6714

#

6715

# 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]

6716

"description": "A String", # An optional description. Provide this property when creating the disk.

6717

"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.

6718

"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.

6719

"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]

6720

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

6721

#

6722

#

6723

# 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:

6724

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType

6725

# - projects/project/zones/zone/diskTypes/diskType

6726

# - 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]

6727

"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]

6728

#

6729

# Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

6730

{ # Guest OS features.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6731

"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]

6732

},

6733

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6734

"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.

6735

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6736

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

6737

"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]

6738

"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]

6739

"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]

6740

"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

6741

"A String",

6742

],

6743

"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.

6744

"A String",

6745

],

6746

"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]

6747

#

6748

# 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:

6749

# projects/debian-cloud/global/images/family/debian-9

6750

#

6751

#

6752

# Alternatively, use a specific version of a public operating system image:

6753

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

6754

#

6755

#

6756

# To create a disk with a custom image that you created, specify the image name in the following format:

6757

# global/images/my-custom-image

6758

#

6759

#

6760

# 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:

6761

# global/images/family/my-image-family

6762

#

6763

#

6764

# If the source image is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6765

"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]

6766

#

6767

# 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.

6768

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

6769

"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.

6770

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

6771

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

6772

#

6773

# The key must meet the following requirements before you can provide it to Compute Engine:

6774

# - The key is wrapped using a RSA public key certificate provided by Google.

6775

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

6776

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

6777

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

6778

},

6779

"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.

6780

#

6781

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

6782

# global/snapshots/my-backup

6783

#

6784

#

6785

# If the source snapshot is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6786

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6787

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

6788

"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.

6789

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

6790

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

6791

#

6792

# The key must meet the following requirements before you can provide it to Compute Engine:

6793

# - The key is wrapped using a RSA public key certificate provided by Google.

6794

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

6795

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

6796

"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]

6797

},

6798

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6799

"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.

6800

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

6801

"licenses": [ # [Output Only] Any valid publicly visible licenses.

6802

"A String",

6803

],

6804

"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.

6805

"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.

6806

"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

6807

"dbs": [ # The Key Database (db).

6808

{

6809

"content": "A String", # The raw content in the secure keys file.

6810

"fileType": "A String", # The file type of source file.

6811

},

6812

],

6813

"dbxs": [ # The forbidden key database (dbx).

6814

{

6815

"content": "A String", # The raw content in the secure keys file.

6816

"fileType": "A String", # The file type of source file.

6817

},

6818

],

6819

"keks": [ # The Key Exchange Key (KEK).

6820

{

6821

"content": "A String", # The raw content in the secure keys file.

6822

"fileType": "A String", # The file type of source file.

6823

},

6824

],

6825

"pk": { # The Platform Key (PK).

6826

"content": "A String", # The raw content in the secure keys file.

6827

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6828

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6829

},

6830

"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]

6831

#

6832

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

6833

#

6834

# 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]

6835

"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]

6836

"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.

6837

"A String",

6838

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6839

},

6840

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6841

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

6842

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6843

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6844

"eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.

6845

"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.

6846

#

6847

# To see the latest fingerprint, make get() request to the instance.

6848

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

6849

{ # A specification of the type and number of accelerator cards attached to the instance.

6850

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

6851

"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.

6852

},

6853

],

6854

"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.

6855

"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]

6856

"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]

6857

#

6858

# 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.

6859

#

6860

# 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.

6861

#

6862

# 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.

6863

#

6864

# 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.

6865

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

6866

"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.

6867

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

6868

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

6869

#

6870

# The key must meet the following requirements before you can provide it to Compute Engine:

6871

# - The key is wrapped using a RSA public key certificate provided by Google.

6872

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

6873

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

6874

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

6875

},

6876

"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.

6877

"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.

6878

#

6879

# To see the latest fingerprint, make get() request to the instance.

6880

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

6881

"a_key": "A String",

6882

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

6883

"lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format.

6884

"lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format.

6885

"lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6886

"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:

6887

# zones/us-central1-f/machineTypes/n1-standard-1

6888

#

6889

#

6890

# 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):

6891

# zones/zone/machineTypes/custom-CPUS-MEMORY

6892

#

6893

#

6894

# For example: zones/us-central1-f/machineTypes/custom-4-5120

6895

#

6896

# For a full list of restrictions, read the Specifications for custom machine types.

6897

"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

6898

"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.

6899

#

6900

# To see the latest fingerprint, make a get() request to retrieve the resource.

6901

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

6902

{

6903

"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.

6904

"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).

6905

},

6906

],

6907

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

6908

},

6909

"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".

6910

"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.

6911

"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.

6912

{ # A network interface resource attached to an instance.

6913

"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.

6914

{ # 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]

6915

"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.

6916

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6917

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

6918

"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.

6919

"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.

6920

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

6921

#

6922

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

6923

#

6924

# 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.

6925

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

6926

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

6927

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

6928

"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.

6929

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

6930

},

6931

],

6932

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

6933

{ # An alias IP range attached to an instance's network interface.

6934

"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).

6935

"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.

6936

},

6937

],

6938

"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]

6939

"internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range.

6940

"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.

6941

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

6942

"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.

6943

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

6944

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

6945

"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.

6946

"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.

6947

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

6948

#

6949

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

6950

#

6951

# 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.

6952

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

6953

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

6954

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

6955

"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.

6956

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

6957

},

6958

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6959

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

6960

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

6961

"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.

6962

"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.

6963

#

6964

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

6965

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

6966

# - projects/project/global/networks/network

6967

# - global/networks/default

6968

"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]

6969

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

6970

"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.

6971

"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.

6972

#

6973

# 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]

6974

"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:

6975

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

6976

# - regions/region/subnetworks/subnetwork

6977

},

6978

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6979

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6980

"preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api.

6981

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.

6982

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.

6983

"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.

6984

"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.

6985

"values": [ # Corresponds to the label values of a reservation resource.

"A String",

],

},

"resourcePolicies": [ # Resource policies applied to this instance.

6990

"A String",

6991

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6992

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

6993

"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]

6994

"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.

6995

#

6996

# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

6997

"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.

6998

"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]

6999

"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]

7000

"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.

7001

#

7002

# See go/stable-fleet-ug for more details.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7003

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

7004

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

7005

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

7006

"key": "A String", # Corresponds to the label key of Node resource.

7007

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

7008

"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]

7014

"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]

7015

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

7016

"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.

7017

"A String",

7018

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

7019

"secureTags": [ # Secure tags to apply to this instance. These can be later modified by the update method. Maximum number of secure tags allowed is 300.

7020

"A String",

7021

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7022

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

7023

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

7024

"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

7025

#

7026

# 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.

7027

{ # A service account.

7028

"email": "A String", # Email address of the service account.

7029

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

7035

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

7036

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

7037

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

7038

},

7039

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

7040

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

7041

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

7042

"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]

7043

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

7044

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

7045

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

7046

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

7047

"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]

7048

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

7049

},

7050

"sourceMachineImage": "A String", # Source machine image

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

7051

"sourceMachineImageEncryptionKey": { # Source GMI encryption key when creating an instance from GMI.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7052

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

7053

"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.

7054

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

7055

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

7056

#

7057

# The key must meet the following requirements before you can provide it to Compute Engine:

7058

# - The key is wrapped using a RSA public key certificate provided by Google.

7059

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

7060

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

7061

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

7062

},

7063

"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]

7064

"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]

7065

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

7066

"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.

7067

"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.

7068

#

7069

# To see the latest fingerprint, make get() request to the instance.

7070

"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]

7075

"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.

7076

"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]

7077

"type": "A String", # Defines the type of maintenance.

7078

},

7079

"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]

7080

}

7081

7082

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]

7088

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]

7094

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.

7095

7096

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.

7097

7098

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]

7099

7100

Returns:

7101

An object of the form:

7102

7103

{ # Represents an Operation resource.

7104

#

7105

# Google Compute Engine has three Operation resources:

7106

#

7107

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

7108

#

7109

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

7110

#

7111

# Operations can be global, regional or zonal.

7112

# - For global operations, use the `globalOperations` resource.

7113

# - For regional operations, use the `regionOperations` resource.

7114

# - For zonal operations, use the `zonalOperations` resource.

7115

#

7116

# 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]

7117

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

7118

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

7119

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

7120

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

7121

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

7122

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7123

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7124

"code": "A String", # [Output Only] The error type identifier for this error.

7125

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

7126

"message": "A String", # [Output Only] An optional, human-readable error message.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7127

},

7128

],

7129

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7130

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

7131

"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.

7132

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

7133

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

7134

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

7135

"name": "A String", # [Output Only] Name of the operation.

7136

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

7137

"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.

7138

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

7139

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

7140

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

7141

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

7142

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

7143

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

7144

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

7145

"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.

7146

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

7147

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

7148

{

7149

"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.

7150

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

7151

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

7152

{

7153

"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).

7154

"value": "A String", # [Output Only] A warning data value corresponding to the key.

7155

},

7156

],

7157

"message": "A String", # [Output Only] A human-readable description of the warning code.

7158

},

7159

],

7160

"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]

7166

<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]

7167

7168

Args:

7169

project: string, Project ID for this request. (required)

7170

zone: string, The name of the zone for this request. (required)

7171

instance: string, The instance name for this request. (required)

7172

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]

7173

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

7174

The object takes the form of:

7175

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7176

{ # 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]

7177

"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.

7178

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7179

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

7180

"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.

7181

"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.

7182

"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]

7183

#

7184

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

7185

#

7186

# 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]

7187

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

7188

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

7189

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

7190

"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.

7191

"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]

7192

}

7193

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7194

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.

7195

7196

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.

7197

7198

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]

7199

7200

Returns:

7201

An object of the form:

7202

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7203

{ # Represents an Operation resource.

7204

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7205

# Google Compute Engine has three Operation resources:

7206

#

7207

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

7208

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7209

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

7210

#

7211

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7212

# - For global operations, use the `globalOperations` resource.

7213

# - For regional operations, use the `regionOperations` resource.

7214

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7215

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7216

# 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]

7217

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

7218

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

7219

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

7220

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

7221

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

7222

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7223

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7224

"code": "A String", # [Output Only] The error type identifier for this error.

7225

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

7226

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7227

},

7228

],

7229

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7230

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

7231

"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.

7232

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

7233

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

7234

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

7235

"name": "A String", # [Output Only] Name of the operation.

7236

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

7237

"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.

7238

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

7239

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

7240

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

7241

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

7242

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

7243

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

7244

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

7245

"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.

7246

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

7247

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

7248

{

7249

"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.

7250

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

7251

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

7252

{

7253

"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).

7254

"value": "A String", # [Output Only] A warning data value corresponding to the key.

7255

},

7256

],

7257

"message": "A String", # [Output Only] A human-readable description of the warning code.

7258

},

7259

],

7260

"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]

7265

<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]

7266

<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.

7267

7268

Args:

7269

project: string, Project ID for this request. (required)

7270

zone: string, The name of the zone for this request. (required)

7271

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7272

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7273

The object takes the form of:

7274

7275

{ # A set of Display Device options

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7276

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7277

}

7278

7279

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.

7280

7281

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.

7282

7283

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

7284

7285

Returns:

7286

An object of the form:

7287

7288

{ # Represents an Operation resource.

7289

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7290

# Google Compute Engine has three Operation resources:

7291

#

7292

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

7293

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7294

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

7295

#

7296

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7297

# - For global operations, use the `globalOperations` resource.

7298

# - For regional operations, use the `regionOperations` resource.

7299

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7300

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7301

# 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]

7302

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

7303

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

7304

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

7305

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

7306

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

7307

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

7308

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7309

"code": "A String", # [Output Only] The error type identifier for this error.

7310

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

7311

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

7312

},

7313

],

7314

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7315

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

7316

"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.

7317

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

7318

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

7319

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

7320

"name": "A String", # [Output Only] Name of the operation.

7321

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

7322

"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.

7323

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

7324

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

7325

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

7326

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

7327

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

7328

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

7329

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

7330

"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.

7331

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

7332

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

7333

{

7334

"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.

7335

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

7336

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

7337

{

7338

"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).

7339

"value": "A String", # [Output Only] A warning data value corresponding to the key.

7340

},

7341

],

7342

"message": "A String", # [Output Only] A human-readable description of the warning code.

7343

},

7344

],

7345

"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]

7349

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7350

<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]

7351

<pre>Updates an instance's network interface. This method follows PATCH semantics.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

7352

7353

Args:

7354

project: string, Project ID for this request. (required)

7355

zone: string, The name of the zone for this request. (required)

7356

instance: string, The instance name for this request. (required)

7357

networkInterface: string, The name of the network interface to update. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7358

body: object, The request body.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

7359

The object takes the form of:

7360

7361

{ # A network interface resource attached to an instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7362

"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.

7363

{ # 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]

7364

"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.

7365

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7366

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

7367

"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.

7368

"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.

7369

"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]

7370

#

7371

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

7372

#

7373

# 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]

7374

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

7375

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

7376

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

7377

"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.

7378

"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]

7379

},

7380

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7381

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

7382

{ # An alias IP range attached to an instance's network interface.

7383

"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).

7384

"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.

7385

},

7386

],

7387

"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]

7388

"internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range.

7389

"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.

7390

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

7391

"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.

7392

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

7393

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

7394

"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.

7395

"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.

7396

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

7397

#

7398

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

7399

#

7400

# 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.

7401

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

7402

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

7403

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

7404

"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.

7405

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

7406

},

7407

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7408

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

7409

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

7410

"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.

7411

"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]

7412

#

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

7413

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

7414

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

7415

# - projects/project/global/networks/network

7416

# - global/networks/default

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7417

"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]

7418

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

7419

"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.

7420

"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.

7421

#

7422

# 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]

7423

"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:

7424

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

7425

# - regions/region/subnetworks/subnetwork

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

7426

}

7427

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7428

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.

7429

7430

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.

7431

7432

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]

7433

7434

Returns:

7435

An object of the form:

7436

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7437

{ # Represents an Operation resource.

7438

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7439

# Google Compute Engine has three Operation resources:

7440

#

7441

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

7442

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7443

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

7444

#

7445

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7446

# - For global operations, use the `globalOperations` resource.

7447

# - For regional operations, use the `regionOperations` resource.

7448

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7449

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7450

# 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]

7451

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

7452

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

7453

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

7454

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

7455

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

7456

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7457

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7458

"code": "A String", # [Output Only] The error type identifier for this error.

7459

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

7460

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7461

},

7462

],

7463

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7464

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

7465

"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.

7466

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

7467

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

7468

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

7469

"name": "A String", # [Output Only] Name of the operation.

7470

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

7471

"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.

7472

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

7473

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

7474

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

7475

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

7476

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

7477

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

7478

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

7479

"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.

7480

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

7481

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

7482

{

7483

"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.

7484

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

7485

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

7486

{

7487

"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).

7488

"value": "A String", # [Output Only] A warning data value corresponding to the key.

7489

},

7490

],

7491

"message": "A String", # [Output Only] A human-readable description of the warning code.

7492

},

7493

],

7494

"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]

7499

<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]

7500

<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.

7501

7502

Args:

7503

project: string, Project ID for this request. (required)

7504

zone: string, The name of the zone for this request. (required)

7505

instance: string, Name or id of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7506

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7507

The object takes the form of:

7508

7509

{ # A set of Shielded Instance options.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7510

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

7511

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

7512

"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]

7513

}

7514

7515

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.

7516

7517

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.

7518

7519

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

7520

7521

Returns:

7522

An object of the form:

7523

7524

{ # Represents an Operation resource.

7525

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7526

# Google Compute Engine has three Operation resources:

7527

#

7528

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

7529

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7530

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

7531

#

7532

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7533

# - For global operations, use the `globalOperations` resource.

7534

# - For regional operations, use the `regionOperations` resource.

7535

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7536

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7537

# 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]

7538

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

7539

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

7540

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

7541

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

7542

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

7543

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7544

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7545

"code": "A String", # [Output Only] The error type identifier for this error.

7546

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

7547

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7548

},

7549

],

7550

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7551

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

7552

"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.

7553

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

7554

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

7555

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

7556

"name": "A String", # [Output Only] Name of the operation.

7557

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

7558

"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.

7559

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

7560

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

7561

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

7562

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

7563

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

7564

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

7565

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

7566

"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.

7567

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

7568

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

7569

{

7570

"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.

7571

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

7572

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

7573

{

7574

"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).

7575

"value": "A String", # [Output Only] A warning data value corresponding to the key.

7576

},

7577

],

7578

"message": "A String", # [Output Only] A human-readable description of the warning code.

7579

},

7580

],

7581

"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]

7586

<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]

7587

<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.

7588

7589

Args:

7590

project: string, Project ID for this request. (required)

7591

zone: string, The name of the zone for this request. (required)

7592

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7593

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7594

The object takes the form of:

7595

7596

{ # A set of Shielded VM options.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7597

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

7598

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

7599

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7600

}

7601

7602

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.

7603

7604

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.

7605

7606

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

7607

7608

Returns:

7609

An object of the form:

7610

7611

{ # Represents an Operation resource.

7612

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7613

# Google Compute Engine has three Operation resources:

7614

#

7615

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

7616

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7617

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

7618

#

7619

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7620

# - For global operations, use the `globalOperations` resource.

7621

# - For regional operations, use the `regionOperations` resource.

7622

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7623

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7624

# 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]

7625

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

7626

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

7627

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

7628

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

7629

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

7630

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

7631

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7632

"code": "A String", # [Output Only] The error type identifier for this error.

7633

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

7634

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

7635

},

7636

],

7637

},

Bu Sun Kim