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>

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

100

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

Sai Cheemalapati

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

[diff] [blame]

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

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

156

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

157

<p class="firstline">TODO(b/180520210): Add IAM permission for this API. Sends diagnostic interrupt to the instance.</p>

158

Bu Sun Kim

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

[diff] [blame]

159

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

160

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

Sai Cheemalapati

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

[diff] [blame]

161

Sai Cheemalapati

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

[diff] [blame]

162

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

163

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

164

Dan O'Meara

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

[diff] [blame]

165

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

Sai Cheemalapati

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

[diff] [blame]

166

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

167

Dan O'Meara

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

[diff] [blame]

168

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

169

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

170

Dan O'Meara

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

[diff] [blame]

171

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

172

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

173

Dan O'Meara

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

[diff] [blame]

174

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

175

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

176

Dan O'Meara

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

[diff] [blame]

177

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

178

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

179

Dan O'Meara

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

[diff] [blame]

180

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

181

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

182

Dan O'Meara

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

[diff] [blame]

183

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

184

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

Sai Cheemalapati

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

[diff] [blame]

185

Dan O'Meara

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

[diff] [blame]

186

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

187

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

188

Dan O'Meara

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

[diff] [blame]

189

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

190

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

191

Dan O'Meara

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

[diff] [blame]

192

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

193

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

194

Dan O'Meara

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

[diff] [blame]

195

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

196

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

197

Dan O'Meara

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

[diff] [blame]

198

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

199

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

200

Sai Cheemalapati

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

[diff] [blame]

201

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

202

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

203

204

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

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

Dan O'Meara

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

[diff] [blame]

207

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

208

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

209

Sai Cheemalapati

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

[diff] [blame]

210

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

211

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

212

Sai Cheemalapati

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

[diff] [blame]

213

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

214

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

215

Dan O'Meara

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

[diff] [blame]

216

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

Sai Cheemalapati

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

[diff] [blame]

217

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

218

Bu Sun Kim

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

[diff] [blame]

219

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

220

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

221

222

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

223

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

224

Dan O'Meara

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

[diff] [blame]

225

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

226

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

227

Dan O'Meara

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

[diff] [blame]

228

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

229

<p class="firstline">Updates an instance's network interface. This method can only update an interface's alias IP range and attached network. See Modifying alias IP ranges for an existing instance for instructions on changing alias IP ranges. See Migrating a VM between networks for instructions on migrating an interface. This method follows PATCH semantics.</p>

Bu Sun Kim

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

[diff] [blame]

230

Dan O'Meara

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

[diff] [blame]

231

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

232

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

233

Dan O'Meara

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

[diff] [blame]

234

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

235

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

236

<h3>Method Details</h3>

237

Dan O'Meara

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

[diff] [blame]

238

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

239

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

Sai Cheemalapati

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

[diff] [blame]

240

241

Args:

242

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

243

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

244

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

245

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]

246

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

247

The object takes the form of:

248

Bu Sun Kim

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

[diff] [blame]

249

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

250

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

251

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

Bu Sun Kim

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

[diff] [blame]

252

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

253

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

254

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

255

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

256

#

257

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

258

#

259

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

260

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

261

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

262

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

263

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

264

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

265

}

266

Bu Sun Kim

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

[diff] [blame]

267

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.

268

269

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.

270

271

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]

272

273

Returns:

274

An object of the form:

275

Bu Sun Kim

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

[diff] [blame]

276

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

277

#

278

# Google Compute Engine has three Operation resources:

279

#

280

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

281

#

282

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

283

#

284

# Operations can be global, regional or zonal.

285

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

286

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

287

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

288

#

289

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

290

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

291

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

292

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

293

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

294

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

295

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

Bu Sun Kim

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

[diff] [blame]

296

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

297

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

298

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

299

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

Bu Sun Kim

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

[diff] [blame]

300

},

301

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

302

},

303

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

304

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

305

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

306

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

307

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

308

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

309

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

310

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

311

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

312

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

313

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

314

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

315

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

316

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

317

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

318

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

319

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

320

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

321

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

322

{

323

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

324

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

325

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

326

{

327

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

328

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

329

},

330

],

331

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

332

},

333

],

334

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

335

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

339

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

340

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

341

342

Args:

343

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

344

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

345

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

Dan O'Meara

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

[diff] [blame]

346

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

347

The object takes the form of:

348

349

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

350

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

351

"A String",

352

],

353

}

Bu Sun Kim

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

[diff] [blame]

354

355

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.

356

357

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.

358

359

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

360

361

Returns:

362

An object of the form:

363

364

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

365

#

366

# Google Compute Engine has three Operation resources:

367

#

368

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

369

#

370

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

371

#

372

# Operations can be global, regional or zonal.

373

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

374

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

375

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

376

#

377

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

378

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

379

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

380

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

381

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

382

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

383

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

Bu Sun Kim

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

[diff] [blame]

384

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

385

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

386

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

387

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

Bu Sun Kim

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

[diff] [blame]

388

},

389

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

390

},

391

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

392

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

393

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

394

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

395

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

396

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

397

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

398

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

399

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

400

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

401

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

402

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

403

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

404

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

405

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

406

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

407

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

408

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

409

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

410

{

411

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

412

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

413

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

414

{

415

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

416

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

417

},

418

],

419

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

420

},

421

],

422

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

423

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

427

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

428

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

429

430

Args:

431

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

Dan O'Meara

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

[diff] [blame]

432

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]

433

Dan O'Meara

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

[diff] [blame]

434

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]

435

Dan O'Meara

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

[diff] [blame]

436

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]

437

Bu Sun Kim

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

[diff] [blame]

438

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]

439

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]

440

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

441

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

442

443

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.

444

445

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

446

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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

447

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

Sai Cheemalapati

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

[diff] [blame]

448

449

Returns:

450

An object of the form:

451

452

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

453

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

454

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

455

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

456

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

457

{ # Represents an Instance resource.

458

#

459

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

460

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

461

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

462

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

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

463

"visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

464

},

465

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

466

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

467

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

468

},

469

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

470

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

471

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

472

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

473

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

474

{ # An instance-attached disk resource.

475

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

476

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

477

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

478

#

479

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

480

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

481

#

482

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

483

#

484

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

485

#

486

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

487

#

488

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

489

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

490

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

491

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

492

"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

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

[diff] [blame]

493

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

494

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

495

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

496

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

497

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

498

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

499

},

500

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

501

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

502

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

503

{ # Guest OS features.

504

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

505

},

506

],

507

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

508

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

509

#

510

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

511

#

512

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

513

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

514

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

515

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

516

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

517

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

Sai Cheemalapati

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

[diff] [blame]

518

#

Sai Cheemalapati

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

[diff] [blame]

519

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

520

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

521

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

522

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

523

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

524

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

Sai Cheemalapati

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

[diff] [blame]

525

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

526

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

527

{ # Guest OS features.

528

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

529

},

530

],

531

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

532

"a_key": "A String",

533

},

534

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

535

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

536

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

537

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

538

"A String",

539

],

540

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

541

"A String",

542

],

543

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

544

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

545

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

546

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

547

#

548

#

549

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

550

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

551

#

552

#

553

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

554

# global/images/my-custom-image

555

#

556

#

557

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

558

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

559

#

560

#

561

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

562

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

563

#

564

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

Bu Sun Kim

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

[diff] [blame]

565

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

566

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

567

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

568

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

569

#

570

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

571

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

572

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

573

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

Bu Sun Kim

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

[diff] [blame]

574

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

575

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

576

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

Sai Cheemalapati

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

[diff] [blame]

577

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

578

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

579

# global/snapshots/my-backup

Sai Cheemalapati

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

[diff] [blame]

580

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

581

#

582

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

583

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

584

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

585

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

586

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

587

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

588

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

589

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

590

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

591

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

592

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

593

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

594

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

595

},

596

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

597

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

598

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

599

"A String",

600

],

601

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

602

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

603

"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

604

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

605

{

Bu Sun Kim

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

[diff] [blame]

606

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

607

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

Bu Sun Kim

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

[diff] [blame]

608

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

609

],

610

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

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

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

617

{

618

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

619

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

620

},

621

],

622

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

623

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

624

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

Bu Sun Kim

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

[diff] [blame]

625

},

Sai Cheemalapati

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

[diff] [blame]

626

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

627

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

Bu Sun Kim

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

[diff] [blame]

628

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

629

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

Bu Sun Kim

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

[diff] [blame]

630

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

631

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

632

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

633

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

Bu Sun Kim

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

[diff] [blame]

634

"A String",

635

],

636

},

Sai Cheemalapati

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

[diff] [blame]

637

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

638

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

639

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

640

},

641

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

642

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

643

#

644

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

645

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

646

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

647

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

648

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

649

},

650

],

651

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

652

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

653

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

654

#

655

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

656

#

657

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

658

#

659

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

660

#

661

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

662

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

663

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

664

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

665

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

666

#

667

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

668

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

669

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

670

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

671

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

672

},

673

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

674

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

675

#

676

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

677

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

678

"a_key": "A String",

679

},

680

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

681

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

682

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

683

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

684

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

685

#

686

#

687

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

688

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

689

#

690

#

691

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

692

#

693

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

694

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

695

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

696

#

697

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

698

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

699

{

700

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

701

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

702

},

703

],

704

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

705

},

706

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

707

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

708

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

709

{ # A network interface resource attached to an instance.

710

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

711

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

712

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

713

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

714

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

715

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

716

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

717

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

718

#

719

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

720

#

721

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

722

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

723

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

724

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

725

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

726

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

727

},

728

],

729

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

730

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

731

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

732

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

733

},

734

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

735

"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. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

736

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

737

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

738

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

739

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

740

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

741

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

742

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

743

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

744

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

745

#

746

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

747

#

748

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

749

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

750

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

751

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

752

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

753

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

754

},

755

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

756

"ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork.

757

#

758

# Valid only if stackType is IPV4_IPV6.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

759

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

760

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

761

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

762

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

763

#

764

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

765

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

766

# - projects/project/global/networks/network

767

# - global/networks/default

768

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

769

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

770

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

771

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

772

#

773

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

774

"subinterfaces": [ # SubInterfaces help enable L2 communication for the instance over subnetworks that support L2. Every network interface will get a default untagged (vlan not specified) subinterface. Users can specify additional tagged subinterfaces which are sub-fields to the Network Interface.

775

{

776

"ipAddress": "A String", # An IPv4 internal IP address to assign to the instance for this subinterface.

777

"subnetwork": "A String", # If specified, this subnetwork must belong to the same network as that of the network interface. If not specified the subnet of network interface will be used. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:

778

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

779

# - regions/region/subnetworks/subnetwork

780

"vlan": 42, # VLAN tag. Should match the VLAN(s) supported by the subnetwork to which this subinterface is connecting.

781

},

782

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

783

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

784

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

785

# - regions/region/subnetworks/subnetwork

786

},

787

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

788

"networkPerformanceConfig": {

789

"externalIpEgressBandwidthTier": "A String",

790

"totalEgressBandwidthTier": "A String",

791

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

792

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

793

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

794

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

795

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

796

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

797

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

798

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

"A String",

],

},

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

803

"A String",

804

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

805

"resourceStatus": { # Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls. # [Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field.

806

"scheduling": {

807

"availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.

808

},

809

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

810

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

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

811

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

812

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

813

#

814

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

815

"availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

816

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

817

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

818

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

819

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

820

#

821

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

822

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

823

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

824

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

825

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

826

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

827

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

833

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

834

},

835

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

836

"A String",

837

],

838

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

839

"A String",

840

],

841

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

842

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

843

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

844

#

845

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

846

{ # A service account.

847

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

848

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

"A String",

],

},

],

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

854

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

855

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

856

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

857

},

858

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

859

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

860

},

861

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

862

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

863

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

864

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

865

},

866

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

867

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

868

},

869

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

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

870

"sourceMachineImageEncryptionKey": { # Source machine image encryption key when creating an instance from a machine image.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

871

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

872

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

873

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

874

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

875

#

876

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

877

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

878

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

879

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

880

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

881

},

882

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

883

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

884

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

885

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

886

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

887

#

888

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

889

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

894

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

895

"startTimeWindow": { # Represents a window of time using two timestamps: `earliest` and `latest`. This timestamp values are in RFC3339 text format. # [Output Only] The start time window of the maintenance disruption.

896

"earliest": "A String",

897

"latest": "A String",

898

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

899

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

900

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

901

},

902

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

Bu Sun Kim

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

[diff] [blame]

903

},

904

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

905

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

906

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

907

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

908

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

909

{

910

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

911

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

912

},

913

],

914

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

915

},

Bu Sun Kim

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

[diff] [blame]

916

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

917

},

918

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

919

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

920

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

921

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

922

"A String",

923

],

924

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

925

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

926

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

927

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

928

{

929

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

930

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

931

},

932

],

933

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

934

},

935

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

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

940

<pre>Retrieves the next page of results.

941

942

Args:

943

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

944

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

945

946

Returns:

Bu Sun Kim

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

[diff] [blame]

947

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

Sai Cheemalapati

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

[diff] [blame]

948

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]

953

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

954

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

955

956

Args:

957

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

958

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

959

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

Dan O'Meara

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

[diff] [blame]

960

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

961

The object takes the form of:

962

963

{ # An instance-attached disk resource.

Bu Sun Kim

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

[diff] [blame]

964

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

965

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

966

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

967

#

968

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

969

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

Sai Cheemalapati

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

[diff] [blame]

970

#

971

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

972

#

973

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

974

#

975

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

976

#

977

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

978

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

979

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

980

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

981

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

982

#

983

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

984

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

985

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

986

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

Bu Sun Kim

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

[diff] [blame]

987

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

988

},

Bu Sun Kim

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

[diff] [blame]

989

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

Bu Sun Kim

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

[diff] [blame]

990

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

991

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

992

{ # Guest OS features.

993

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

994

},

995

],

996

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

997

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

998

#

999

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

1000

#

1001

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

1002

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

1003

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

1004

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

1005

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

1006

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

1007

#

Bu Sun Kim

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

[diff] [blame]

1008

#

Sai Cheemalapati

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

[diff] [blame]

1009

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

1010

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

1011

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

1012

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

1013

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

1014

#

1015

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

1016

{ # Guest OS features.

Bu Sun Kim

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

[diff] [blame]

1017

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

1018

},

1019

],

Bu Sun Kim

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

[diff] [blame]

1020

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

1021

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

1022

},

Bu Sun Kim

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

[diff] [blame]

1023

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

1024

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

1025

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

1026

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

1027

"A String",

1028

],

1029

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

1030

"A String",

1031

],

1032

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

1033

#

Bu Sun Kim

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

[diff] [blame]

1034

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

1035

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

Sai Cheemalapati

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

[diff] [blame]

1036

#

Sai Cheemalapati

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

[diff] [blame]

1037

#

1038

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

Bu Sun Kim

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

[diff] [blame]

1039

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

Sai Cheemalapati

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

[diff] [blame]

1040

#

Sai Cheemalapati

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

[diff] [blame]

1041

#

Bu Sun Kim

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

[diff] [blame]

1042

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

1043

# global/images/my-custom-image

Sai Cheemalapati

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

[diff] [blame]

1044

#

Sai Cheemalapati

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

[diff] [blame]

1045

#

Bu Sun Kim

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

[diff] [blame]

1046

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

1047

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

Sai Cheemalapati

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

[diff] [blame]

1048

#

Jon Wayne Parrott

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

[diff] [blame]

1049

#

1050

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

Dmitry Frenkel

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

[diff] [blame]

1051

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

1052

#

1053

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

1054

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

1055

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

1056

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

1057

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

1058

#

1059

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

1060

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

1061

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

1062

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

1063

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

1064

},

1065

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

1066

#

1067

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

1068

# global/snapshots/my-backup

1069

#

1070

#

1071

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

Dmitry Frenkel

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

[diff] [blame]

1072

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

Bu Sun Kim

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

[diff] [blame]

1073

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

1074

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

1075

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

1076

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

1077

#

1078

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

1079

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

1080

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

1081

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

1082

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

1083

},

1084

},

Bu Sun Kim

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

[diff] [blame]

1085

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

1086

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

1087

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

1088

"A String",

1089

],

1090

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

1091

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

1092

"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

1093

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

1094

{

1095

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

1096

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

1097

},

1098

],

1099

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

1100

{

1101

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

1102

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

1103

},

1104

],

1105

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

1106

{

1107

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

1108

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

1109

},

1110

],

1111

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

1112

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

1113

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

Bu Sun Kim

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

[diff] [blame]

1114

},

Bu Sun Kim

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

[diff] [blame]

1115

},

1116

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

1117

#

1118

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

1119

#

1120

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

1121

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

1122

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

1123

"A String",

1124

],

Sai Cheemalapati

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

[diff] [blame]

1125

}

1126

Dmitry Frenkel

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

[diff] [blame]

1127

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]

1128

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.

1129

1130

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.

1131

1132

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]

1133

1134

Returns:

1135

An object of the form:

1136

Bu Sun Kim

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

[diff] [blame]

1137

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1138

#

1139

# Google Compute Engine has three Operation resources:

1140

#

1141

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

1142

#

1143

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

1144

#

1145

# Operations can be global, regional or zonal.

1146

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

1147

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

1148

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

1149

#

1150

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

1151

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

1152

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

1153

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

1154

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

1155

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

1156

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

Bu Sun Kim

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

[diff] [blame]

1157

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1158

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

1159

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

1160

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

Bu Sun Kim

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

[diff] [blame]

1161

},

1162

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1163

},

1164

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

1165

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

1166

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

1167

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

1168

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

1169

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1170

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1171

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

1172

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

1173

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

1174

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

1175

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

1176

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

1177

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

1178

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

1179

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

1180

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

1181

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

1182

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

1183

{

1184

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

1185

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

1186

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

1187

{

1188

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

1189

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

1190

},

1191

],

1192

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

1193

},

1194

],

1195

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

1196

}</pre>

Dan O'Meara

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

[diff] [blame]

</div>

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

1201

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

1202

1203

Args:

1204

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

1205

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

1206

body: object, The request body.

1207

The object takes the form of:

1208

1209

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1210

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

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

1211

"instance": { # Represents an Instance resource. # DEPRECATED: Please use instance_properties instead.

Bu Sun Kim

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

[diff] [blame]

1212

#

Dan O'Meara

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

[diff] [blame]

1213

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

1214

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

1215

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

1216

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

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1217

"visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width.

Dmitry Frenkel

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

[diff] [blame]

1218

},

Bu Sun Kim

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

[diff] [blame]

1219

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

1220

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

1221

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

1222

},

Bu Sun Kim

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

[diff] [blame]

1223

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

1224

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

1225

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

1226

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

1227

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

1228

{ # An instance-attached disk resource.

Bu Sun Kim

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

[diff] [blame]

1229

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

1230

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

1231

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

1232

#

1233

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

1234

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

Sai Cheemalapati

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

[diff] [blame]

1235

#

1236

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

1237

#

1238

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

1239

#

1240

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

1241

#

1242

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

1243

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

1244

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

1245

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

1246

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

Sai Cheemalapati

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

[diff] [blame]

1247

#

1248

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

1249

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

Bu Sun Kim

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

[diff] [blame]

1250

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

1251

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

Bu Sun Kim

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

[diff] [blame]

1252

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

1253

},

Bu Sun Kim

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

[diff] [blame]

1254

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

Bu Sun Kim

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

[diff] [blame]

1255

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

1256

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

1257

{ # Guest OS features.

1258

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

1259

},

1260

],

1261

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

1262

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

1263

#

1264

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

1265

#

1266

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

1267

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

1268

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

1269

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

1270

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

1271

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

1272

#

Bu Sun Kim

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

[diff] [blame]

1273

#

Sai Cheemalapati

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

[diff] [blame]

1274

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

1275

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

1276

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

1277

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

1278

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

1279

#

1280

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

1281

{ # Guest OS features.

Bu Sun Kim

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

[diff] [blame]

1282

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

1283

},

1284

],

Bu Sun Kim

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

[diff] [blame]

1285

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

1286

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

1287

},

Bu Sun Kim

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

[diff] [blame]

1288

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

1289

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

1290

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

1291

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

1292

"A String",

1293

],

1294

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

1295

"A String",

1296

],

1297

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

1298

#

Bu Sun Kim

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

[diff] [blame]

1299

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

1300

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

Sai Cheemalapati

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

[diff] [blame]

1301

#

Sai Cheemalapati

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

[diff] [blame]

1302

#

1303

# Alternatively, use a specific version of a public operating system image:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1304

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1305

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1306

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1307

# To create a disk with a custom image that you created, specify the image name in the following format:

1308

# global/images/my-custom-image

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1309

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1310

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1311

# 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:

1312

# global/images/family/my-image-family

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1313

#

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1314

#

1315

# If the source image is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1316

"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]

1317

#

1318

# 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.

1319

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1320

"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.

1321

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1322

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

1323

#

1324

# The key must meet the following requirements before you can provide it to Compute Engine:

1325

# - The key is wrapped using a RSA public key certificate provided by Google.

1326

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1327

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1328

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

1329

},

1330

"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.

1331

#

1332

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

1333

# global/snapshots/my-backup

1334

#

1335

#

1336

# If the source snapshot is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1337

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1338

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1339

"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.

1340

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1341

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

1342

#

1343

# The key must meet the following requirements before you can provide it to Compute Engine:

1344

# - The key is wrapped using a RSA public key certificate provided by Google.

1345

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1346

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1347

"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]

1348

},

1349

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1350

"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.

1351

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

1352

"licenses": [ # [Output Only] Any valid publicly visible licenses.

1353

"A String",

1354

],

1355

"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.

1356

"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.

1357

"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

1358

"dbs": [ # The Key Database (db).

1359

{

1360

"content": "A String", # The raw content in the secure keys file.

1361

"fileType": "A String", # The file type of source file.

1362

},

1363

],

1364

"dbxs": [ # The forbidden key database (dbx).

1365

{

1366

"content": "A String", # The raw content in the secure keys file.

1367

"fileType": "A String", # The file type of source file.

1368

},

1369

],

1370

"keks": [ # The Key Exchange Key (KEK).

1371

{

1372

"content": "A String", # The raw content in the secure keys file.

1373

"fileType": "A String", # The file type of source file.

1374

},

1375

],

1376

"pk": { # The Platform Key (PK).

1377

"content": "A String", # The raw content in the secure keys file.

1378

"fileType": "A String", # The file type of source file.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1379

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1380

},

1381

"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]

1382

#

1383

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

1384

#

1385

# 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]

1386

"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]

1387

"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.

1388

"A String",

1389

],

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1390

},

1391

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1392

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

1393

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1394

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1395

"eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.

1396

"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.

1397

#

1398

# To see the latest fingerprint, make get() request to the instance.

1399

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

1400

{ # A specification of the type and number of accelerator cards attached to the instance.

1401

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

1402

"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.

1403

},

1404

],

1405

"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.

1406

"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]

1407

"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]

1408

#

1409

# 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.

1410

#

1411

# 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.

1412

#

1413

# 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.

1414

#

1415

# 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.

1416

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1417

"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.

1418

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1419

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

1420

#

1421

# The key must meet the following requirements before you can provide it to Compute Engine:

1422

# - The key is wrapped using a RSA public key certificate provided by Google.

1423

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1424

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1425

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

1426

},

1427

"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.

1428

"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.

1429

#

1430

# To see the latest fingerprint, make get() request to the instance.

1431

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

1432

"a_key": "A String",

1433

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1434

"lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format.

1435

"lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format.

1436

"lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1437

"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:

1438

# zones/us-central1-f/machineTypes/n1-standard-1

1439

#

1440

#

1441

# 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):

1442

# zones/zone/machineTypes/custom-CPUS-MEMORY

1443

#

1444

#

1445

# For example: zones/us-central1-f/machineTypes/custom-4-5120

1446

#

1447

# For a full list of restrictions, read the Specifications for custom machine types.

1448

"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

1449

"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.

1450

#

1451

# To see the latest fingerprint, make a get() request to retrieve the resource.

1452

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

1453

{

1454

"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.

1455

"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).

1456

},

1457

],

1458

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

1459

},

1460

"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".

1461

"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.

1462

"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.

1463

{ # A network interface resource attached to an instance.

1464

"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.

1465

{ # 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]

1466

"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.

1467

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1468

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

1469

"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.

1470

"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.

1471

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

1472

#

1473

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

1474

#

1475

# 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.

1476

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

1477

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

1478

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

1479

"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.

1480

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

1481

},

1482

],

1483

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

1484

{ # An alias IP range attached to an instance's network interface.

1485

"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).

1486

"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.

1487

},

1488

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1489

"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. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1490

"internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range.

1491

"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.

1492

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

1493

"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.

1494

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

1495

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

1496

"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.

1497

"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.

1498

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

1499

#

1500

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

1501

#

1502

# 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.

1503

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

1504

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

1505

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

1506

"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.

1507

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

1508

},

1509

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1510

"ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork.

1511

#

1512

# Valid only if stackType is IPV4_IPV6.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1513

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

1514

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

1515

"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.

1516

"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.

1517

#

1518

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

1519

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

1520

# - projects/project/global/networks/network

1521

# - global/networks/default

1522

"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]

1523

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

1524

"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.

1525

"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.

1526

#

1527

# This field can be both set at instance creation and update network interface operations.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1528

"subinterfaces": [ # SubInterfaces help enable L2 communication for the instance over subnetworks that support L2. Every network interface will get a default untagged (vlan not specified) subinterface. Users can specify additional tagged subinterfaces which are sub-fields to the Network Interface.

1529

{

1530

"ipAddress": "A String", # An IPv4 internal IP address to assign to the instance for this subinterface.

1531

"subnetwork": "A String", # If specified, this subnetwork must belong to the same network as that of the network interface. If not specified the subnet of network interface will be used. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:

1532

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

1533

# - regions/region/subnetworks/subnetwork

1534

"vlan": 42, # VLAN tag. Should match the VLAN(s) supported by the subnetwork to which this subinterface is connecting.

1535

},

1536

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1537

"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:

1538

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

1539

# - regions/region/subnetworks/subnetwork

1540

},

1541

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1542

"networkPerformanceConfig": {

1543

"externalIpEgressBandwidthTier": "A String",

1544

"totalEgressBandwidthTier": "A String",

1545

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1546

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1547

"preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api.

1548

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.

1549

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.

1550

"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.

1551

"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.

1552

"values": [ # Corresponds to the label values of a reservation resource.

"A String",

],

},

"resourcePolicies": [ # Resource policies applied to this instance.

1557

"A String",

1558

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1559

"resourceStatus": { # Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls. # [Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field.

1560

"scheduling": {

1561

"availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.

1562

},

1563

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1564

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1565

"scheduling": { # Sets the scheduling options for an Instance. NextID: 20 # Sets the scheduling options for this instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1566

"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.

1567

#

1568

# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1569

"availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1570

"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.

1571

"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]

1572

"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]

1573

"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.

1574

#

1575

# See go/stable-fleet-ug for more details.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1576

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

1577

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

1578

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

1579

"key": "A String", # Corresponds to the label key of Node resource.

1580

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

1581

"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]

1587

"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]

1588

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1589

"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.

1590

"A String",

1591

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1592

"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.

1593

"A String",

1594

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1595

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

1596

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1597

"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

1598

#

1599

# 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.

1600

{ # A service account.

1601

"email": "A String", # Email address of the service account.

1602

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

1608

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

1609

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

1610

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

1611

},

1612

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

1613

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

1614

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1615

"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]

1616

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

1617

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

1618

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

1619

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1620

"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]

1621

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

1622

},

1623

"sourceMachineImage": "A String", # Source machine image

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1624

"sourceMachineImageEncryptionKey": { # Source machine image encryption key when creating an instance from a machine image.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1625

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1626

"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.

1627

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1628

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

1629

#

1630

# The key must meet the following requirements before you can provide it to Compute Engine:

1631

# - The key is wrapped using a RSA public key certificate provided by Google.

1632

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1633

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1634

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

1635

},

1636

"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]

1637

"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]

1638

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

1639

"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.

1640

"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.

1641

#

1642

# To see the latest fingerprint, make get() request to the instance.

1643

"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]

1648

"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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1649

"startTimeWindow": { # Represents a window of time using two timestamps: `earliest` and `latest`. This timestamp values are in RFC3339 text format. # [Output Only] The start time window of the maintenance disruption.

1650

"earliest": "A String",

1651

"latest": "A String",

1652

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1653

"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]

1654

"type": "A String", # Defines the type of maintenance.

1655

},

1656

"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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1657

},

1658

"instanceProperties": { # The instance properties defining the VM instances to be created. Required if sourceInstanceTemplate is not provided.

1659

"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.

1660

"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).

1661

"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.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1662

"visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1663

},

1664

"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.

1665

"confidentialInstanceConfig": { # A set of Confidential Instance options. # Specifies the Confidential Instance options.

1666

"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.

1667

},

1668

"description": "A String", # An optional text description for the instances that are created from these properties.

1669

"disks": [ # An array of disks that are associated with the instances that are created from these properties.

1670

{ # An instance-attached disk resource.

1671

"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).

1672

"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.

1673

"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.

1674

#

1675

# 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.

1676

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.

1677

#

1678

# 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.

1679

#

1680

# 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.

1681

#

1682

# 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.

1683

#

1684

# Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.

1685

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1686

"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.

1687

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1688

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

1689

#

1690

# The key must meet the following requirements before you can provide it to Compute Engine:

1691

# - The key is wrapped using a RSA public key certificate provided by Google.

1692

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1693

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1694

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

1695

},

1696

"diskSizeGb": "A String", # The size of the disk in GB.

1697

"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.

1698

"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.

1699

{ # Guest OS features.

1700

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

1701

},

1702

],

1703

"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.

1704

"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.

1705

#

1706

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

1707

#

1708

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

1709

"description": "A String", # An optional description. Provide this property when creating the disk.

1710

"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.

1711

"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.

1712

"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:

1713

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

1714

#

1715

#

1716

# 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:

1717

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType

1718

# - projects/project/zones/zone/diskTypes/diskType

1719

# - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.

1720

"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.

1721

#

1722

# Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

1723

{ # Guest OS features.

1724

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

1725

},

1726

],

1727

"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.

1728

"a_key": "A String",

1729

},

1730

"multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.

1731

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

1732

"provisionedIops": "A String", # Indicates how many IOPS must be provisioned for the disk.

1733

"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

1734

"A String",

1735

],

1736

"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.

1737

"A String",

1738

],

1739

"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.

1740

#

1741

# 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:

1742

# projects/debian-cloud/global/images/family/debian-9

1743

#

1744

#

1745

# Alternatively, use a specific version of a public operating system image:

1746

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

1747

#

1748

#

1749

# To create a disk with a custom image that you created, specify the image name in the following format:

1750

# global/images/my-custom-image

1751

#

1752

#

1753

# 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:

1754

# global/images/family/my-image-family

1755

#

1756

#

1757

# If the source image is deleted later, this field will not be set.

1758

"sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

1759

#

1760

# 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.

1761

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1762

"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.

1763

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1764

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

1765

#

1766

# The key must meet the following requirements before you can provide it to Compute Engine:

1767

# - The key is wrapped using a RSA public key certificate provided by Google.

1768

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1769

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1770

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

1771

},

1772

"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.

1773

#

1774

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

1775

# global/snapshots/my-backup

1776

#

1777

#

1778

# If the source snapshot is deleted later, this field will not be set.

1779

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

1780

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1781

"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.

1782

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1783

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

1784

#

1785

# The key must meet the following requirements before you can provide it to Compute Engine:

1786

# - The key is wrapped using a RSA public key certificate provided by Google.

1787

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1788

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1789

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

1790

},

1791

},

1792

"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.

1793

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

1794

"licenses": [ # [Output Only] Any valid publicly visible licenses.

1795

"A String",

1796

],

1797

"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.

1798

"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.

1799

"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

1800

"dbs": [ # The Key Database (db).

1801

{

1802

"content": "A String", # The raw content in the secure keys file.

1803

"fileType": "A String", # The file type of source file.

1804

},

1805

],

1806

"dbxs": [ # The forbidden key database (dbx).

1807

{

1808

"content": "A String", # The raw content in the secure keys file.

1809

"fileType": "A String", # The file type of source file.

1810

},

1811

],

1812

"keks": [ # The Key Exchange Key (KEK).

1813

{

1814

"content": "A String", # The raw content in the secure keys file.

1815

"fileType": "A String", # The file type of source file.

1816

},

1817

],

1818

"pk": { # The Platform Key (PK).

1819

"content": "A String", # The raw content in the secure keys file.

1820

"fileType": "A String", # The file type of source file.

1821

},

1822

},

1823

"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.

1824

#

1825

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

1826

#

1827

# Note that for InstanceTemplate, specify the disk name, not the URL for the disk.

1828

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

1829

"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.

"A String",

],

},

],

"displayDevice": { # A set of Display Device options # Display Device properties to enable support for remote display products like: Teradici, VNC and TeamViewer

1835

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

1836

},

1837

"guestAccelerators": [ # A list of guest accelerator cards' type and count to use for instances created from these properties.

1838

{ # A specification of the type and number of accelerator cards attached to the instance.

1839

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

1840

"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.

1841

},

1842

],

1843

"labels": { # Labels to apply to instances that are created from these properties.

1844

"a_key": "A String",

1845

},

1846

"machineType": "A String", # The machine type to use for instances that are created from these properties.

1847

"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.

1848

"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.

1849

#

1850

# To see the latest fingerprint, make a get() request to retrieve the resource.

1851

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

1852

{

1853

"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.

1854

"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).

1855

},

1856

],

1857

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

1858

},

1859

"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.

1860

"networkInterfaces": [ # An array of network access configurations for this interface.

1861

{ # A network interface resource attached to an instance.

1862

"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.

1863

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

1864

"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.

1865

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

1866

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

1867

"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.

1868

"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.

1869

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

1870

#

1871

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

1872

#

1873

# 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.

1874

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

1875

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

1876

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

1877

"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.

1878

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

1879

},

1880

],

1881

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

1882

{ # An alias IP range attached to an instance's network interface.

1883

"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).

1884

"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.

1885

},

1886

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1887

"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. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1888

"internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range.

1889

"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.

1890

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

1891

"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.

1892

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

1893

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

1894

"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.

1895

"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.

1896

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

1897

#

1898

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

1899

#

1900

# 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.

1901

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

1902

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

1903

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

1904

"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.

1905

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

1906

},

1907

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1908

"ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork.

1909

#

1910

# Valid only if stackType is IPV4_IPV6.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1911

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

1912

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

1913

"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.

1914

"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.

1915

#

1916

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

1917

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

1918

# - projects/project/global/networks/network

1919

# - global/networks/default

1920

"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.

1921

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

1922

"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.

1923

"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.

1924

#

1925

# This field can be both set at instance creation and update network interface operations.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1926

"subinterfaces": [ # SubInterfaces help enable L2 communication for the instance over subnetworks that support L2. Every network interface will get a default untagged (vlan not specified) subinterface. Users can specify additional tagged subinterfaces which are sub-fields to the Network Interface.

1927

{

1928

"ipAddress": "A String", # An IPv4 internal IP address to assign to the instance for this subinterface.

1929

"subnetwork": "A String", # If specified, this subnetwork must belong to the same network as that of the network interface. If not specified the subnet of network interface will be used. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:

1930

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

1931

# - regions/region/subnetworks/subnetwork

1932

"vlan": 42, # VLAN tag. Should match the VLAN(s) supported by the subnetwork to which this subinterface is connecting.

1933

},

1934

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1935

"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:

1936

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

1937

# - regions/region/subnetworks/subnetwork

1938

},

1939

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1940

"networkPerformanceConfig": {

1941

"externalIpEgressBandwidthTier": "A String",

1942

"totalEgressBandwidthTier": "A String",

1943

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1944

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.

1945

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for VMs. If not specified, use INHERIT_FROM_SUBNETWORK as default.

1946

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that instances can consume from.

1947

"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.

1948

"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.

1949

"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.

1954

"A String",

1955

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1956

"scheduling": { # Sets the scheduling options for an Instance. NextID: 20 # Specifies the scheduling options for the instances that are created from these properties.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1957

"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.

1958

#

1959

# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1960

"availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1961

"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.

1962

"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.

1963

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after instance creation where the instance won't be scheduled for maintenance.

1964

"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.

1965

#

1966

# See go/stable-fleet-ug for more details.

1967

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

1968

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

1969

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

1970

"key": "A String", # Corresponds to the label key of Node resource.

1971

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

1972

"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.

1978

"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.

1979

},

1980

"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.

1981

{ # A service account.

1982

"email": "A String", # Email address of the service account.

1983

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

1989

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

1990

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

1991

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

1992

},

1993

"shieldedVmConfig": { # A set of Shielded VM options. # Specifies the Shielded VM options for the instances that are created from these properties.

1994

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

1995

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

1996

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

1997

},

1998

"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.

1999

"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.

2000

#

2001

# To see the latest fingerprint, make get() request to the instance.

2002

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

"A String",

],

},

},

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

2007

"locationPolicy": { # Configuration for location policy among multiple possible locations (e.g. preferences for zone selection among zones in a single region). # Policy for chosing target zone.

2008

"locations": { # Location configurations mapped by location name. Currently only zone names are supported and must be represented as valid internal URLs, such as zones/us-central1-a.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2009

"a_key": {

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

2010

"preference": "A String", # Preference for a given locaction: ALLOW or DENY.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2011

},

2012

},

2013

},

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

2014

"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 and instances already created will be deleted.

2015

"namePattern": "A String", # The string pattern used for the names of the VMs. Either name_pattern or per_instance_properties must be set. The pattern should contain one continuous sequence of placeholder hash characters (#) with each character corresponding to one digit of the generated instance name. Example: name_pattern of inst-#### will generate instance names such as inst-0001, inst-0002, ... . If there already exist instance(s) whose names match the name pattern in the same project and zone, then the generated instance numbers will start after the biggest existing number. For example, if there exists an instance with name inst-0050, then instance names generated using the pattern inst-#### will be inst-0051, inst-0052, etc. The name pattern placeholder #...# can contain up to 18 characters.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2016

"perInstanceProperties": { # Per-instance properties to be set on individual instances. Keys of this map specify requested instance names. Can be empty if name_pattern is used.

2017

"a_key": { # Per-instance properties to be set on individual instances. To be extended in the future.

2018

"name": "A String", # This field is only temporary. It will be removed. Do not use it.

2019

},

2020

},

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

2021

"predefinedNames": [ # DEPRECATED: Please use per_instance_properties instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2022

"A String",

2023

],

2024

"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.

2025

#

2026

# It can be a full or partial URL. For example, the following are all valid URLs to an instance template:

2027

# - https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate

2028

# - projects/project/global/instanceTemplates/instanceTemplate

2029

# - global/instanceTemplates/instanceTemplate

2030

#

2031

# This field is optional.

2032

}

2033

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).

2039

2040

Returns:

2041

An object of the form:

2042

2043

{ # Represents an Operation resource.

2044

#

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

#

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.

2052

# - For global operations, use the `globalOperations` resource.

2053

# - For regional operations, use the `regionOperations` resource.

2054

# - For zonal operations, use the `zonalOperations` resource.

2055

#

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 ==)

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.

2063

{

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.

},

],

},

"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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2076

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2077

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2078

"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.

2079

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2080

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2081

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2082

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2083

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2084

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2085

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2086

"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.

2087

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2088

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2089

{

2090

"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.

2091

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2092

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2093

{

2094

"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).

2095

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2096

},

2097

],

2098

"message": "A String", # [Output Only] A human-readable description of the warning code.

2099

},

2100

],

2101

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

}</pre>

</div>

<code class="details" id="close">close()</code>

2107

<pre>Close httplib2 connections.</pre>

</div>

<code class="details" id="delete">delete(project, zone, instance, requestId=None)</code>

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

2112

<pre>Deletes the specified Instance resource. For more information, see Deleting an instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2113

2114

Args:

2115

project: string, Project ID for this request. (required)

2116

zone: string, The name of the zone for this request. (required)

2117

instance: string, Name of the instance resource to delete. (required)

2118

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.

2119

2120

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.

2121

2122

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

2123

2124

Returns:

2125

An object of the form:

2126

2127

{ # Represents an Operation resource.

2128

#

2129

# Google Compute Engine has three Operation resources:

2130

#

2131

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2132

#

2133

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2134

#

2135

# Operations can be global, regional or zonal.

2136

# - For global operations, use the `globalOperations` resource.

2137

# - For regional operations, use the `regionOperations` resource.

2138

# - For zonal operations, use the `zonalOperations` resource.

2139

#

2140

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

2141

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2142

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2143

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2144

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2145

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2146

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

2147

{

2148

"code": "A String", # [Output Only] The error type identifier for this error.

2149

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2150

"message": "A String", # [Output Only] An optional, human-readable error message.

},

],

},

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2155

"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.

2156

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2157

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2158

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2159

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2160

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2161

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2162

"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.

2163

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2164

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2165

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2166

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2167

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2168

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2169

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2170

"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.

2171

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2172

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2173

{

2174

"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.

2175

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2176

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2177

{

2178

"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).

2179

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2180

},

2181

],

2182

"message": "A String", # [Output Only] A human-readable description of the warning code.

2183

},

2184

],

2185

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

}</pre>

</div>

<code class="details" id="deleteAccessConfig">deleteAccessConfig(project, zone, instance, accessConfig, networkInterface, requestId=None)</code>

2191

<pre>Deletes an access config from an instance's network interface.

2192

2193

Args:

2194

project: string, Project ID for this request. (required)

2195

zone: string, The name of the zone for this request. (required)

2196

instance: string, The instance name for this request. (required)

2197

accessConfig: string, The name of the access config to delete. (required)

2198

networkInterface: string, The name of the network interface. (required)

2199

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.

2200

2201

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.

2202

2203

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

2204

2205

Returns:

2206

An object of the form:

2207

2208

{ # Represents an Operation resource.

2209

#

2210

# Google Compute Engine has three Operation resources:

2211

#

2212

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2213

#

2214

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2215

#

2216

# Operations can be global, regional or zonal.

2217

# - For global operations, use the `globalOperations` resource.

2218

# - For regional operations, use the `regionOperations` resource.

2219

# - For zonal operations, use the `zonalOperations` resource.

2220

#

2221

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

2222

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2223

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2224

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2225

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2226

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2227

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

2228

{

2229

"code": "A String", # [Output Only] The error type identifier for this error.

2230

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2231

"message": "A String", # [Output Only] An optional, human-readable error message.

},

],

},

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2236

"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.

2237

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2238

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2239

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2240

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2241

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2242

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2243

"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.

2244

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2245

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2246

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2247

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2248

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2249

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2250

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2251

"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.

2252

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2253

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2254

{

2255

"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.

2256

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2257

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2258

{

2259

"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).

2260

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2261

},

2262

],

2263

"message": "A String", # [Output Only] A human-readable description of the warning code.

2264

},

2265

],

2266

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

}</pre>

</div>

<code class="details" id="detachDisk">detachDisk(project, zone, instance, deviceName, requestId=None)</code>

2272

<pre>Detaches a disk from an instance.

2273

2274

Args:

2275

project: string, Project ID for this request. (required)

2276

zone: string, The name of the zone for this request. (required)

2277

instance: string, Instance name for this request. (required)

2278

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)

2279

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.

2280

2281

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.

2282

2283

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

2284

2285

Returns:

2286

An object of the form:

2287

2288

{ # Represents an Operation resource.

2289

#

2290

# Google Compute Engine has three Operation resources:

2291

#

2292

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2293

#

2294

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2295

#

2296

# Operations can be global, regional or zonal.

2297

# - For global operations, use the `globalOperations` resource.

2298

# - For regional operations, use the `regionOperations` resource.

2299

# - For zonal operations, use the `zonalOperations` resource.

2300

#

2301

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

2302

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2303

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2304

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2305

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2306

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2307

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

2308

{

2309

"code": "A String", # [Output Only] The error type identifier for this error.

2310

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2311

"message": "A String", # [Output Only] An optional, human-readable error message.

},

],

},

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2316

"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.

2317

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2318

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2319

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2320

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2321

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2322

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2323

"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.

2324

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2325

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2326

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2327

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2328

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2329

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2330

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2331

"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.

2332

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2333

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2334

{

2335

"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.

2336

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2337

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2338

{

2339

"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).

2340

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2341

},

2342

],

2343

"message": "A String", # [Output Only] A human-readable description of the warning code.

2344

},

2345

],

2346

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

}</pre>

</div>

<code class="details" id="get">get(project, zone, instance)</code>

2352

<pre>Returns the specified Instance resource. Gets a list of available instances by making a list() request.

2353

2354

Args:

2355

project: string, Project ID for this request. (required)

2356

zone: string, The name of the zone for this request. (required)

2357

instance: string, Name of the instance resource to return. (required)

2358

2359

Returns:

2360

An object of the form:

2361

2362

{ # Represents an Instance resource.

2363

#

2364

# 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 ==)

2365

"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.

2366

"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).

2367

"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.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2368

"visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2369

},

2370

"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.

2371

"confidentialInstanceConfig": { # A set of Confidential Instance options.

2372

"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.

2373

},

2374

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

2375

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

2376

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

2377

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2378

"disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.

2379

{ # An instance-attached disk resource.

2380

"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).

2381

"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.

2382

"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.

2383

#

2384

# 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.

2385

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.

2386

#

2387

# 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.

2388

#

2389

# 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.

2390

#

2391

# 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.

2392

#

2393

# Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.

2394

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2395

"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.

2396

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2397

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

2398

#

2399

# The key must meet the following requirements before you can provide it to Compute Engine:

2400

# - The key is wrapped using a RSA public key certificate provided by Google.

2401

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

2402

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

2403

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

2404

},

2405

"diskSizeGb": "A String", # The size of the disk in GB.

2406

"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.

2407

"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.

2408

{ # Guest OS features.

2409

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

2410

},

2411

],

2412

"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.

2413

"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.

2414

#

2415

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

2416

#

2417

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

2418

"description": "A String", # An optional description. Provide this property when creating the disk.

2419

"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.

2420

"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.

2421

"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:

2422

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

2423

#

2424

#

2425

# 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:

2426

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType

2427

# - projects/project/zones/zone/diskTypes/diskType

2428

# - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.

2429

"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.

2430

#

2431

# Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

2432

{ # Guest OS features.

2433

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

2434

},

2435

],

2436

"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.

2437

"a_key": "A String",

2438

},

2439

"multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.

2440

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

2441

"provisionedIops": "A String", # Indicates how many IOPS must be provisioned for the disk.

2442

"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

2443

"A String",

2444

],

2445

"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.

2446

"A String",

2447

],

2448

"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.

2449

#

2450

# 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:

2451

# projects/debian-cloud/global/images/family/debian-9

2452

#

2453

#

2454

# Alternatively, use a specific version of a public operating system image:

2455

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

2456

#

2457

#

2458

# To create a disk with a custom image that you created, specify the image name in the following format:

2459

# global/images/my-custom-image

2460

#

2461

#

2462

# 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:

2463

# global/images/family/my-image-family

2464

#

2465

#

2466

# If the source image is deleted later, this field will not be set.

2467

"sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

2468

#

2469

# 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.

2470

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2471

"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.

2472

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2473

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

2474

#

2475

# The key must meet the following requirements before you can provide it to Compute Engine:

2476

# - The key is wrapped using a RSA public key certificate provided by Google.

2477

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

2478

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

2479

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

2480

},

2481

"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.

2482

#

2483

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

2484

# global/snapshots/my-backup

2485

#

2486

#

2487

# If the source snapshot is deleted later, this field will not be set.

2488

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

2489

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2490

"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.

2491

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2492

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

2493

#

2494

# The key must meet the following requirements before you can provide it to Compute Engine:

2495

# - The key is wrapped using a RSA public key certificate provided by Google.

2496

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

2497

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

2498

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

2499

},

2500

},

2501

"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.

2502

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

2503

"licenses": [ # [Output Only] Any valid publicly visible licenses.

2504

"A String",

2505

],

2506

"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.

2507

"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.

2508

"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

2509

"dbs": [ # The Key Database (db).

2510

{

2511

"content": "A String", # The raw content in the secure keys file.

2512

"fileType": "A String", # The file type of source file.

2513

},

2514

],

2515

"dbxs": [ # The forbidden key database (dbx).

2516

{

2517

"content": "A String", # The raw content in the secure keys file.

2518

"fileType": "A String", # The file type of source file.

2519

},

2520

],

2521

"keks": [ # The Key Exchange Key (KEK).

2522

{

2523

"content": "A String", # The raw content in the secure keys file.

2524

"fileType": "A String", # The file type of source file.

2525

},

2526

],

2527

"pk": { # The Platform Key (PK).

2528

"content": "A String", # The raw content in the secure keys file.

2529

"fileType": "A String", # The file type of source file.

2530

},

2531

},

2532

"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.

2533

#

2534

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

2535

#

2536

# Note that for InstanceTemplate, specify the disk name, not the URL for the disk.

2537

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

2538

"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.

"A String",

],

},

],

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

2544

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

2545

},

2546

"eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.

2547

"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.

2548

#

2549

# To see the latest fingerprint, make get() request to the instance.

2550

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

2551

{ # A specification of the type and number of accelerator cards attached to the instance.

2552

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

2553

"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.

2554

},

2555

],

2556

"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.

2557

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

2558

"instanceEncryptionKey": { # Encrypts or decrypts data for an instance with a customer-supplied encryption key.

2559

#

2560

# 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.

2561

#

2562

# 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.

2563

#

2564

# 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.

2565

#

2566

# 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.

2567

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2568

"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.

2569

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2570

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

2571

#

2572

# The key must meet the following requirements before you can provide it to Compute Engine:

2573

# - The key is wrapped using a RSA public key certificate provided by Google.

2574

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

2575

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

2576

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

2577

},

2578

"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.

2579

"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.

2580

#

2581

# To see the latest fingerprint, make get() request to the instance.

2582

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

2583

"a_key": "A String",

2584

},

2585

"lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format.

2586

"lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format.

2587

"lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format.

2588

"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:

2589

# zones/us-central1-f/machineTypes/n1-standard-1

2590

#

2591

#

2592

# 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):

2593

# zones/zone/machineTypes/custom-CPUS-MEMORY

2594

#

2595

#

2596

# For example: zones/us-central1-f/machineTypes/custom-4-5120

2597

#

2598

# For a full list of restrictions, read the Specifications for custom machine types.

2599

"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

2600

"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.

2601

#

2602

# To see the latest fingerprint, make a get() request to retrieve the resource.

2603

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

2604

{

2605

"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.

2606

"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).

2607

},

2608

],

2609

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

2610

},

2611

"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".

2612

"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.

2613

"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.

2614

{ # A network interface resource attached to an instance.

2615

"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.

2616

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

2617

"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.

2618

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

2619

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

2620

"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.

2621

"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.

2622

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

2623

#

2624

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

2625

#

2626

# 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.

2627

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

2628

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

2629

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

2630

"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.

2631

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

2632

},

2633

],

2634

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

2635

{ # An alias IP range attached to an instance's network interface.

2636

"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).

2637

"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.

2638

},

2639

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2640

"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. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2641

"internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range.

2642

"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.

2643

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

2644

"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.

2645

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

2646

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

2647

"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.

2648

"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.

2649

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

2650

#

2651

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

2652

#

2653

# 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.

2654

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

2655

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

2656

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

2657

"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.

2658

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

2659

},

2660

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2661

"ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork.

2662

#

2663

# Valid only if stackType is IPV4_IPV6.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2664

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

2665

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

2666

"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.

2667

"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.

2668

#

2669

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

2670

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

2671

# - projects/project/global/networks/network

2672

# - global/networks/default

2673

"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.

2674

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

2675

"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.

2676

"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.

2677

#

2678

# This field can be both set at instance creation and update network interface operations.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2679

"subinterfaces": [ # SubInterfaces help enable L2 communication for the instance over subnetworks that support L2. Every network interface will get a default untagged (vlan not specified) subinterface. Users can specify additional tagged subinterfaces which are sub-fields to the Network Interface.

2680

{

2681

"ipAddress": "A String", # An IPv4 internal IP address to assign to the instance for this subinterface.

2682

"subnetwork": "A String", # If specified, this subnetwork must belong to the same network as that of the network interface. If not specified the subnet of network interface will be used. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:

2683

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

2684

# - regions/region/subnetworks/subnetwork

2685

"vlan": 42, # VLAN tag. Should match the VLAN(s) supported by the subnetwork to which this subinterface is connecting.

2686

},

2687

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2688

"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:

2689

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

2690

# - regions/region/subnetworks/subnetwork

2691

},

2692

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2693

"networkPerformanceConfig": {

2694

"externalIpEgressBandwidthTier": "A String",

2695

"totalEgressBandwidthTier": "A String",

2696

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2697

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.

2698

"preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api.

2699

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.

2700

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.

2701

"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.

2702

"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.

2703

"values": [ # Corresponds to the label values of a reservation resource.

"A String",

],

},

"resourcePolicies": [ # Resource policies applied to this instance.

2708

"A String",

2709

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2710

"resourceStatus": { # Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls. # [Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field.

2711

"scheduling": {

2712

"availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.

2713

},

2714

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2715

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2716

"scheduling": { # Sets the scheduling options for an Instance. NextID: 20 # Sets the scheduling options for this instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2717

"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.

2718

#

2719

# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2720

"availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2721

"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.

2722

"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.

2723

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after instance creation where the instance won't be scheduled for maintenance.

2724

"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.

2725

#

2726

# See go/stable-fleet-ug for more details.

2727

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

2728

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

2729

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

2730

"key": "A String", # Corresponds to the label key of Node resource.

2731

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

2732

"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.

2738

"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.

2739

},

2740

"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.

2741

"A String",

2742

],

2743

"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.

2744

"A String",

2745

],

2746

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

2747

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2748

"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

2749

#

2750

# 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.

2751

{ # A service account.

2752

"email": "A String", # Email address of the service account.

2753

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

2759

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

2760

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

2761

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

2762

},

2763

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

2764

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

2765

},

2766

"shieldedVmConfig": { # A set of Shielded VM options. # Deprecating, please use shielded_instance_config.

2767

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

2768

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

2769

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

2770

},

2771

"shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured. # Deprecating, please use shielded_instance_integrity_policy.

2772

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

2773

},

2774

"sourceMachineImage": "A String", # Source machine image

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2775

"sourceMachineImageEncryptionKey": { # Source machine image encryption key when creating an instance from a machine image.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2776

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2777

"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.

2778

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2779

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

2780

#

2781

# The key must meet the following requirements before you can provide it to Compute Engine:

2782

# - The key is wrapped using a RSA public key certificate provided by Google.

2783

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

2784

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

2785

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

2786

},

2787

"startRestricted": True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.

2788

"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.

2789

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

2790

"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.

2791

"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.

2792

#

2793

# To see the latest fingerprint, make get() request to the instance.

2794

"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.

2799

"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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2800

"startTimeWindow": { # Represents a window of time using two timestamps: `earliest` and `latest`. This timestamp values are in RFC3339 text format. # [Output Only] The start time window of the maintenance disruption.

2801

"earliest": "A String",

2802

"latest": "A String",

2803

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2804

"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.

2805

"type": "A String", # Defines the type of maintenance.

2806

},

2807

"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.

2808

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2812

<code class="details" id="getEffectiveFirewalls">getEffectiveFirewalls(project, zone, instance, networkInterface)</code>

2813

<pre>Returns effective firewalls applied to an interface of the instance.

2814

2815

Args:

2816

project: string, Project ID for this request. (required)

2817

zone: string, The name of the zone for this request. (required)

2818

instance: string, Name of the instance scoping this request. (required)

2819

networkInterface: string, The name of the network interface to get the effective firewalls. (required)

2820

2821

Returns:

2822

An object of the form:

2823

2824

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2825

"firewallPolicys": [ # Effective firewalls from firewall policies.

2826

{

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2827

"displayName": "A String", # [Output Only] Deprecated, please use short name instead. The display name of the firewall policy.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2828

"name": "A String", # [Output Only] The name of the firewall policy.

2829

"rules": [ # The rules that apply to the network.

2830

{ # 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).

2831

"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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2832

"description": "A String", # An optional description for this resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2833

"direction": "A String", # The direction in which this rule applies.

2834

"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.

2835

"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.

2836

"kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2838

"destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 256.

2839

"A String",

2840

],

2841

"layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.

2842

{

2843

"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.

2844

"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.

2845

#

2846

# 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.

2852

"A String",

2853

],

2854

"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.

2855

"A String",

2856

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2857

"srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256.

2858

{

2859

"name": "A String", # Name of the secure tag, created with TagManager's TagValue API.

2860

"state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.

2861

},

2862

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2863

},

2864

"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.

2865

"ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2866

"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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2867

"A String",

2868

],

2869

"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.

2870

"A String",

2871

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2872

"targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.

2873

{

2874

"name": "A String", # Name of the secure tag, created with TagManager's TagValue API.

2875

"state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.

2876

},

2877

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2878

"targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.

"A String",

],

},

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2883

"shortName": "A String", # [Output Only] The short name of the firewall policy.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2884

"type": "A String", # [Output Only] The type of the firewall policy.

2885

},

2886

],

2887

"firewalls": [ # Effective firewalls on the instance.

2888

{ # Represents a Firewall Rule resource.

2889

#

2890

# Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules.

2891

"allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

2892

{

2893

"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.

2894

"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.

2895

#

2896

# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

"A String",

],

},

],

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

2902

"denied": [ # The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.

2903

{

2904

"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.

2905

"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.

2906

#

2907

# 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.

2913

"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.

2914

"A String",

2915

],

2916

"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.

2917

"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.

2918

"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.

2919

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

2920

"kind": "compute#firewall", # [Output Only] Type of the resource. Always compute#firewall for firewall rules.

2921

"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.

2922

"enable": True or False, # This field denotes whether to enable logging for a particular firewall rule.

2923

"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.

2924

},

2925

"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.

2926

"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:

2927

# global/networks/default

2928

# 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:

2929

# - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network

2930

# - projects/myproject/global/networks/my-network

2931

# - global/networks/default

2932

"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`.

2933

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2934

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2935

"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.

2936

"A String",

2937

],

2938

"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.

2939

"A String",

2940

],

2941

"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.

2942

"A String",

2943

],

2944

"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.

2945

"A String",

2946

],

2947

"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.

2953

{ # A pruned SecurityPolicy containing ID and any applicable firewall rules.

2954

"id": "A String", # The unique identifier for the security policy. This identifier is defined by the server.

2955

"rules": [ # The rules that apply to the network.

2956

{ # 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).

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

2957

"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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2958

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2959

"direction": "A String", # The direction in which this rule applies. This field may only be specified when versioned_expr is set to FIREWALL.

2960

"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.

2961

#

2962

# This field may only be specified when the versioned_expr is set to FIREWALL.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2963

"headerAction": { # Optional, additional actions that are performed on headers.

2964

"requestHeadersToAdds": [ # The list of request headers to add or overwrite if they?re already present.

2965

{

2966

"headerName": "A String", # The name of the header to set.

2967

"headerValue": "A String", # The value to set the named header to.

2968

},

2969

],

2970

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2971

"kind": "compute#securityPolicyRule", # [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules

2972

"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.

2973

"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.

2974

"destIpRanges": [ # CIDR IP address range.

2975

#

2976

# This field may only be specified when versioned_expr is set to FIREWALL.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2977

"A String",

2978

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2979

"destPorts": [ # Pairs of IP protocols and ports that the rule should match.

2980

#

2981

# This field may only be specified when versioned_expr is set to FIREWALL.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2982

{

2983

"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.

2984

"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.

2985

#

2986

# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2987

#

2988

# This field may only be specified when versioned_expr is set to FIREWALL.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

"A String",

],

},

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2993

"layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.

2994

#

2995

# This field may only be specified when versioned_expr is set to FIREWALL.

2996

{

2997

"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.

2998

"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.

2999

#

3000

# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

3001

#

3002

# This field may only be specified when versioned_expr is set to FIREWALL.

3003

"A String",

3004

],

3005

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

3006

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3007

"srcIpRanges": [ # CIDR IP address range. Maximum number of src_ip_ranges allowed is 10.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

3008

"A String",

3009

],

3010

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3011

"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

2020-05-20 12:08:20 -0700

[diff] [blame]

3012

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3013

# Example (Comparison):

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3014

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3015

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

3016

#

3017

# Example (Equality):

3018

#

3019

# 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'"

3024

#

3025

# Example (Data Manipulation):

3026

#

3027

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

3028

#

3029

# 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.

3030

"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.

3031

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

3032

"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.

3033

"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.

3034

},

3035

"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

2020-05-20 12:08:20 -0700

[diff] [blame]

3036

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3037

"preview": True or False, # If set to true, the specified action is not enforced.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3038

"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 priority.

3039

"rateLimitOptions": { # Must be specified if the action is "rate_based_ban" or "throttle". Cannot be specified for any other actions.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

3040

"banDurationSec": 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 banned by the rate limit after the rate falls below the threshold.

3041

"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_sec' when the number of requests that exceed the 'rate_limit_threshold' also exceed this 'ban_threshold'.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3042

"count": 42, # Number of HTTP(S) requests for calculating the threshold.

3043

"intervalSec": 42, # Interval over which the threshold is computed.

3044

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3045

"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".

3046

"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.

3047

"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.

3048

"rateLimitThreshold": { # Threshold at which to begin ratelimiting.

3049

"count": 42, # Number of HTTP(S) requests for calculating the threshold.

3050

"intervalSec": 42, # Interval over which the threshold is computed.

3051

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3052

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3053

"redirectTarget": "A String", # This must be specified for redirect actions. Cannot be specified for any other actions.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3054

"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.

3055

"ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall security policy rule.

3056

"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.

3057

#

3058

# This field may only be specified when versioned_expr is set to FIREWALL.

3059

"A String",

3060

],

3061

"targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.

3062

"A String",

3063

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3064

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

],

},

],

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3072

<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]

3073

<pre>Returns the specified guest attributes entry.

3074

3075

Args:

3076

project: string, Project ID for this request. (required)

3077

zone: string, The name of the zone for this request. (required)

3078

instance: string, Name of the instance scoping this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3079

queryPath: string, Specifies the guest attributes path to be queried.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3080

variableKey: string, Specifies the key for the guest attributes entry.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3081

3082

Returns:

3083

An object of the form:

3084

3085

{ # A guest attributes entry.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3086

"kind": "compute#guestAttributes", # [Output Only] Type of the resource. Always compute#guestAttributes for guest attributes entry.

3087

"queryPath": "A String", # The path to be queried. This can be the default namespace ('/') or a nested namespace ('/\/') or a specified key ('/\/\')

3088

"queryValue": { # Array of guest attribute namespace/key/value tuples. # [Output Only] The value of the requested queried path.

3089

"items": [

3090

{ # A guest attributes namespace/key/value entry.

3091

"key": "A String", # Key for the guest attribute entry.

3092

"namespace": "A String", # Namespace for the guest attribute entry.

3093

"value": "A String", # Value for the guest attribute entry.

},

],

},

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

3098

"variableKey": "A String", # The key to search for.

3099

"variableValue": "A String", # [Output Only] The value found for the requested key.

3100

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3104

<code class="details" id="getIamPolicy">getIamPolicy(project, zone, resource, optionsRequestedPolicyVersion=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3105

<pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists.

3106

3107

Args:

3108

project: string, Project ID for this request. (required)

3109

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3110

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3111

optionsRequestedPolicyVersion: integer, Requested IAM Policy version.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3112

3113

Returns:

3114

An object of the form:

3115

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3116

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

#

#

#

# 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.

3121

#

3122

# 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).

#

# **JSON example:**

#

# { "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 }

#

# **YAML example:**

#

# 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

3131

#

3132

# For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

3133

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

3134

{ # 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.

3135

#

3136

# 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.

3137

#

3138

# Example Policy with multiple AuditConfigs:

3139

#

3140

# { "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" ] } ] } ] }

3141

#

3142

# 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.

3143

"auditLogConfigs": [ # The configuration for logging of each type of permission.

3144

{ # Provides the configuration for logging a type of permissions. Example:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3145

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3146

# { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] }

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3147

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3148

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

3149

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

3150

"A String",

3151

],

3152

"ignoreChildExemptions": True or False,

3153

"logType": "A String", # The log type that this config enables.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3154

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[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.

3160

},

3161

],

3162

"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.

3163

{ # Associates `members` with a `role`.

3164

"bindingId": "A String",

3165

"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.

3166

#

3167

# If the condition evaluates to `true`, then this binding applies to the current request.

3168

#

3169

# 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.

3170

#

3171

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

3172

#

3173

# Example (Comparison):

3174

#

3175

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

3176

#

3177

# Example (Equality):

3178

#

3179

# 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'"

3184

#

3185

# Example (Data Manipulation):

3186

#

3187

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

3188

#

3189

# 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.

3190

"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.

3191

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

3192

"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.

3193

"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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3194

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3195

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

3196

#

3197

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

3198

#

3199

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

3200

#

3201

# * `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`.

3206

#

3207

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

3208

#

3209

# * `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.

3210

#

3211

# * `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.

3212

#

3213

# * `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`.

3218

"A String",

3219

],

3220

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

3221

},

3222

],

3223

"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.

3224

#

3225

# **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.

3226

"iamOwned": True or False,

3227

"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.

3228

{ # A rule to be applied in a Policy.

3229

"action": "A String", # Required

3230

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

3231

{ # A condition to be met.

3232

"iam": "A String", # Trusted attributes supplied by the IAM system.

3233

"op": "A String", # An operator to apply the subject with.

3234

"svc": "A String", # Trusted attributes discharged by the service.

3235

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

3236

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

3242

"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.

3243

"A String",

3244

],

3245

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

3246

{ # Specifies what kind of log the caller must write

3247

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

3248

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

3249

"permissionType": "A String", # The type of the permission that was checked.

3250

},

3251

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3252

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3253

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

3254

#

3255

# 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.

3256

#

3257

# Field names correspond to IAM request parameters and field values are their respective values.

3258

#

3259

# 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.

3260

#

3261

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

3262

"customFields": [ # Custom fields.

3263

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

3264

"name": "A String", # Name is the field name.

3265

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3266

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3267

],

3268

"field": "A String", # The field value to attribute.

3269

"metric": "A String", # The metric to update.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3270

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3271

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

3272

"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.

3277

"A String",

3278

],

3279

"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.

3285

#

3286

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

3287

#

3288

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

3289

#

3290

# * 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

3291

#

3292

# **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.

3293

#

3294

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

3295

#

3296

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

3297

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3301

<code class="details" id="getScreenshot">getScreenshot(project, zone, instance)</code>

3302

<pre>Returns the screenshot from the specified instance.

3303

3304

Args:

3305

project: string, Project ID for this request. (required)

3306

zone: string, The name of the zone for this request. (required)

3307

instance: string, Name of the instance scoping this request. (required)

3308

3309

Returns:

3310

An object of the form:

3311

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3312

{ # An instance's screenshot.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3313

"contents": "A String", # [Output Only] The Base64-encoded screenshot data.

3314

"kind": "compute#screenshot", # [Output Only] Type of the resource. Always compute#screenshot for the screenshots.

3315

}</pre>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3319

<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]

3320

<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]

3321

3322

Args:

3323

project: string, Project ID for this request. (required)

3324

zone: string, The name of the zone for this request. (required)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3325

instance: string, Name of the instance for this request. (required)

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3326

port: integer, Specifies which COM or serial port to retrieve data from.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3327

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`.

3328

3329

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.

3330

3331

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]

3332

3333

Returns:

3334

An object of the form:

3335

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3336

{ # An instance's serial console output.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3337

"contents": "A String", # [Output Only] The contents of the console output.

3338

"kind": "compute#serialPortOutput", # [Output Only] Type of the resource. Always compute#serialPortOutput for serial port output.

3339

"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.

3340

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

3341

"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.

3342

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3346

<code class="details" id="getShieldedInstanceIdentity">getShieldedInstanceIdentity(project, zone, instance)</code>

3347

<pre>Returns the Shielded Instance Identity of an instance

3348

3349

Args:

3350

project: string, Project ID for this request. (required)

3351

zone: string, The name of the zone for this request. (required)

3352

instance: string, Name or id of the instance scoping this request. (required)

3353

3354

Returns:

3355

An object of the form:

3356

3357

{ # A shielded Instance identity entry.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3358

"encryptionKey": { # A Shielded Instance Identity Entry. # An Endorsement Key (EK) made by the RSA 2048 algorithm issued to the Shielded Instance's vTPM.

3359

"ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.

3360

"ekPub": "A String", # A PEM-encoded public key.

3361

},

3362

"kind": "compute#shieldedInstanceIdentity", # [Output Only] Type of the resource. Always compute#shieldedInstanceIdentity for shielded Instance identity entry.

3363

"signingKey": { # A Shielded Instance Identity Entry. # An Attestation Key (AK) made by the RSA 2048 algorithm issued to the Shielded Instance's vTPM.

3364

"ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.

3365

"ekPub": "A String", # A PEM-encoded public key.

3366

},

3367

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

<code class="details" id="getShieldedVmIdentity">getShieldedVmIdentity(project, zone, instance)</code>

3372

<pre>Returns the Shielded VM Identity of an instance

3373

3374

Args:

3375

project: string, Project ID for this request. (required)

3376

zone: string, The name of the zone for this request. (required)

3377

instance: string, Name of the instance scoping this request. (required)

3378

3379

Returns:

3380

An object of the form:

3381

3382

{ # A shielded VM identity entry.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3383

"encryptionKey": { # A Shielded Instance Identity Entry. # An Endorsement Key (EK) issued to the Shielded VM's vTPM.

3384

"ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.

3385

"ekPub": "A String", # A PEM-encoded public key.

3386

},

3387

"kind": "compute#shieldedVmIdentity", # [Output Only] Type of the resource. Always compute#shieldedVmIdentity for shielded VM identity entry.

3388

"signingKey": { # A Shielded Instance Identity Entry. # An Attestation Key (AK) issued to the Shielded VM's vTPM.

3389

"ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.

3390

"ekPub": "A String", # A PEM-encoded public key.

3391

},

3392

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3396

<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]

3397

<pre>Creates an instance resource in the specified project using the data included in the request.

3398

3399

Args:

3400

project: string, Project ID for this request. (required)

3401

zone: string, The name of the zone for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3402

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3403

The object takes the form of:

3404

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3405

{ # Represents an Instance resource.

3406

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3407

# 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]

3408

"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.

3409

"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).

3410

"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.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

3411

"visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3412

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3413

"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.

3414

"confidentialInstanceConfig": { # A set of Confidential Instance options.

3415

"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]

3416

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3417

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

3418

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

3419

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

3420

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3421

"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]

3422

{ # An instance-attached disk resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3423

"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).

3424

"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.

3425

"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.

3426

#

3427

# 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]

3428

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3429

#

3430

# 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.

3431

#

3432

# 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.

3433

#

3434

# 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.

3435

#

3436

# 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]

3437

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3438

"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.

3439

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3440

"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]

3441

#

3442

# The key must meet the following requirements before you can provide it to Compute Engine:

3443

# - 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]

3444

# - 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]

3445

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3446

"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]

3447

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3448

"diskSizeGb": "A String", # The size of the disk in GB.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3449

"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]

3450

"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.

3451

{ # Guest OS features.

3452

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

3453

},

3454

],

3455

"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.

3456

"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]

3457

#

3458

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

3459

#

3460

# 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]

3461

"description": "A String", # An optional description. Provide this property when creating the disk.

3462

"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.

3463

"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.

3464

"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]

3465

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

3466

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3467

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3468

# 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:

3469

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType

3470

# - projects/project/zones/zone/diskTypes/diskType

3471

# - 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]

3472

"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]

3473

#

3474

# Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

3475

{ # Guest OS features.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3476

"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]

3477

},

3478

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3479

"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.

3480

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3481

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3482

"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]

3483

"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]

3484

"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]

3485

"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

3486

"A String",

3487

],

3488

"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.

3489

"A String",

3490

],

3491

"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]

3492

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3493

# 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:

3494

# projects/debian-cloud/global/images/family/debian-9

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3495

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3496

#

3497

# Alternatively, use a specific version of a public operating system image:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3498

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3499

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3500

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3501

# To create a disk with a custom image that you created, specify the image name in the following format:

3502

# global/images/my-custom-image

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3503

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3504

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3505

# 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:

3506

# global/images/family/my-image-family

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3507

#

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

3508

#

3509

# If the source image is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3510

"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]

3511

#

3512

# 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.

3513

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3514

"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.

3515

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3516

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

3517

#

3518

# The key must meet the following requirements before you can provide it to Compute Engine:

3519

# - The key is wrapped using a RSA public key certificate provided by Google.

3520

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

3521

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

3522

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

3523

},

3524

"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.

3525

#

3526

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

3527

# global/snapshots/my-backup

3528

#

3529

#

3530

# If the source snapshot is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3531

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3532

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3533

"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.

3534

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3535

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

3536

#

3537

# The key must meet the following requirements before you can provide it to Compute Engine:

3538

# - The key is wrapped using a RSA public key certificate provided by Google.

3539

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

3540

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

3541

"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]

3542

},

3543

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3544

"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.

3545

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

3546

"licenses": [ # [Output Only] Any valid publicly visible licenses.

3547

"A String",

3548

],

3549

"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.

3550

"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.

3551

"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

3552

"dbs": [ # The Key Database (db).

3553

{

3554

"content": "A String", # The raw content in the secure keys file.

3555

"fileType": "A String", # The file type of source file.

3556

},

3557

],

3558

"dbxs": [ # The forbidden key database (dbx).

3559

{

3560

"content": "A String", # The raw content in the secure keys file.

3561

"fileType": "A String", # The file type of source file.

3562

},

3563

],

3564

"keks": [ # The Key Exchange Key (KEK).

3565

{

3566

"content": "A String", # The raw content in the secure keys file.

3567

"fileType": "A String", # The file type of source file.

3568

},

3569

],

3570

"pk": { # The Platform Key (PK).

3571

"content": "A String", # The raw content in the secure keys file.

3572

"fileType": "A String", # The file type of source file.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3573

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3574

},

3575

"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]

3576

#

3577

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

3578

#

3579

# 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]

3580

"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]

3581

"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.

3582

"A String",

3583

],

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3584

},

3585

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3586

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

3587

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3588

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3589

"eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.

3590

"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.

3591

#

3592

# To see the latest fingerprint, make get() request to the instance.

3593

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

3594

{ # A specification of the type and number of accelerator cards attached to the instance.

3595

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

3596

"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.

3597

},

3598

],

3599

"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.

3600

"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]

3601

"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]

3602

#

3603

# 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.

3604

#

3605

# 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.

3606

#

3607

# 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.

3608

#

3609

# 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.

3610

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3611

"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.

3612

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3613

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

3614

#

3615

# The key must meet the following requirements before you can provide it to Compute Engine:

3616

# - The key is wrapped using a RSA public key certificate provided by Google.

3617

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

3618

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

3619

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

3620

},

3621

"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.

3622

"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.

3623

#

3624

# To see the latest fingerprint, make get() request to the instance.

3625

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

3626

"a_key": "A String",

3627

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3628

"lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format.

3629

"lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format.

3630

"lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3631

"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:

3632

# zones/us-central1-f/machineTypes/n1-standard-1

3633

#

3634

#

3635

# 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):

3636

# zones/zone/machineTypes/custom-CPUS-MEMORY

3637

#

3638

#

3639

# For example: zones/us-central1-f/machineTypes/custom-4-5120

3640

#

3641

# For a full list of restrictions, read the Specifications for custom machine types.

3642

"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

3643

"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.

3644

#

3645

# To see the latest fingerprint, make a get() request to retrieve the resource.

3646

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

3647

{

3648

"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.

3649

"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).

3650

},

3651

],

3652

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

3653

},

3654

"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".

3655

"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.

3656

"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.

3657

{ # A network interface resource attached to an instance.

3658

"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.

3659

{ # 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]

3660

"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.

3661

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3662

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

3663

"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.

3664

"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.

3665

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

3666

#

3667

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

3668

#

3669

# 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.

3670

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

3671

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

3672

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

3673

"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.

3674

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

3675

},

3676

],

3677

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

3678

{ # An alias IP range attached to an instance's network interface.

3679

"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).

3680

"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.

3681

},

3682

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

3683

"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. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3684

"internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range.

3685

"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.

3686

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

3687

"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.

3688

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

3689

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

3690

"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.

3691

"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.

3692

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

3693

#

3694

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

3695

#

3696

# 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.

3697

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

3698

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

3699

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

3700

"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.

3701

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

3702

},

3703

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3704

"ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork.

3705

#

3706

# Valid only if stackType is IPV4_IPV6.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3707

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

3708

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

3709

"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.

3710

"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.

3711

#

3712

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

3713

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

3714

# - projects/project/global/networks/network

3715

# - global/networks/default

3716

"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]

3717

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

3718

"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.

3719

"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.

3720

#

3721

# This field can be both set at instance creation and update network interface operations.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3722

"subinterfaces": [ # SubInterfaces help enable L2 communication for the instance over subnetworks that support L2. Every network interface will get a default untagged (vlan not specified) subinterface. Users can specify additional tagged subinterfaces which are sub-fields to the Network Interface.

3723

{

3724

"ipAddress": "A String", # An IPv4 internal IP address to assign to the instance for this subinterface.

3725

"subnetwork": "A String", # If specified, this subnetwork must belong to the same network as that of the network interface. If not specified the subnet of network interface will be used. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:

3726

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

3727

# - regions/region/subnetworks/subnetwork

3728

"vlan": 42, # VLAN tag. Should match the VLAN(s) supported by the subnetwork to which this subinterface is connecting.

3729

},

3730

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3731

"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:

3732

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

3733

# - regions/region/subnetworks/subnetwork

3734

},

3735

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3736

"networkPerformanceConfig": {

3737

"externalIpEgressBandwidthTier": "A String",

3738

"totalEgressBandwidthTier": "A String",

3739

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3740

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3741

"preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api.

3742

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.

3743

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.

3744

"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.

3745

"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.

3746

"values": [ # Corresponds to the label values of a reservation resource.

"A String",

],

},

"resourcePolicies": [ # Resource policies applied to this instance.

3751

"A String",

3752

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3753

"resourceStatus": { # Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls. # [Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field.

3754

"scheduling": {

3755

"availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.

3756

},

3757

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3758

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

3759

"scheduling": { # Sets the scheduling options for an Instance. NextID: 20 # Sets the scheduling options for this instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3760

"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.

3761

#

3762

# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3763

"availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3764

"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.

3765

"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]

3766

"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]

3767

"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.

3768

#

3769

# See go/stable-fleet-ug for more details.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3770

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

3771

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

3772

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

3773

"key": "A String", # Corresponds to the label key of Node resource.

3774

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

3775

"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]

3781

"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]

3782

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3783

"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.

3784

"A String",

3785

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

3786

"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.

3787

"A String",

3788

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3789

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

3790

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

3791

"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

3792

#

3793

# 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.

3794

{ # A service account.

3795

"email": "A String", # Email address of the service account.

3796

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

3802

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

3803

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

3804

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

3805

},

3806

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

3807

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

3808

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3809

"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]

3810

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

3811

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

3812

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

3813

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3814

"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]

3815

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

3816

},

3817

"sourceMachineImage": "A String", # Source machine image

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

3818

"sourceMachineImageEncryptionKey": { # Source machine image encryption key when creating an instance from a machine image.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3819

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3820

"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.

3821

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3822

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

3823

#

3824

# The key must meet the following requirements before you can provide it to Compute Engine:

3825

# - The key is wrapped using a RSA public key certificate provided by Google.

3826

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

3827

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

3828

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

3829

},

3830

"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]

3831

"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]

3832

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

3833

"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.

3834

"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.

3835

#

3836

# To see the latest fingerprint, make get() request to the instance.

3837

"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]

3842

"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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3843

"startTimeWindow": { # Represents a window of time using two timestamps: `earliest` and `latest`. This timestamp values are in RFC3339 text format. # [Output Only] The start time window of the maintenance disruption.

3844

"earliest": "A String",

3845

"latest": "A String",

3846

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3847

"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]

3848

"type": "A String", # Defines the type of maintenance.

3849

},

3850

"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]

3851

}

3852

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3853

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.

3854

3855

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.

3856

3857

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]

3858

sourceInstanceTemplate: string, Specifies instance template to create the instance.

3859

3860

This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to an instance template:

3861

- https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate

3862

- projects/project/global/instanceTemplates/instanceTemplate

3863

- global/instanceTemplates/instanceTemplate

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3864

sourceMachineImage: string, Specifies the machine image to use to create the instance.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3865

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3866

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]

3867

- https://www.googleapis.com/compute/v1/projects/project/global/global/machineImages/machineImage

3868

- projects/project/global/global/machineImages/machineImage

3869

- global/machineImages/machineImage

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3870

3871

Returns:

3872

An object of the form:

3873

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3874

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3875

#

3876

# Google Compute Engine has three Operation resources:

3877

#

3878

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

3879

#

3880

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

3881

#

3882

# Operations can be global, regional or zonal.

3883

# - For global operations, use the `globalOperations` resource.

3884

# - For regional operations, use the `regionOperations` resource.

3885

# - For zonal operations, use the `zonalOperations` resource.

3886

#

3887

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

3888

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3889

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3890

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3891

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3892

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3893

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3894

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3895

"code": "A String", # [Output Only] The error type identifier for this error.

3896

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3897

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3898

},

3899

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3900

},

3901

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3902

"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.

3903

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3904

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3905

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3906

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3907

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3908

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3909

"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.

3910

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3911

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3912

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

3913

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3914

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3915

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3916

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3917

"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.

3918

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3919

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3920

{

3921

"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.

3922

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

3923

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

3924

{

3925

"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).

3926

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3927

},

3928

],

3929

"message": "A String", # [Output Only] A human-readable description of the warning code.

3930

},

3931

],

3932

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

3933

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3937

<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]

3938

<pre>Retrieves the list of instances contained within the specified zone.

3939

3940

Args:

3941

project: string, Project ID for this request. (required)

3942

zone: string, The name of the zone for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3943

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]

3944

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3945

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]

3946

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3947

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]

3948

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3949

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) ```

3950

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`)

3951

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

3952

3953

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.

3954

3955

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

3956

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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3957

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3958

3959

Returns:

3960

An object of the form:

3961

3962

{ # Contains a list of instances.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3963

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

3964

"items": [ # A list of Instance resources.

3965

{ # Represents an Instance resource.

3966

#

3967

# 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 ==)

3968

"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.

3969

"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).

3970

"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.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

3971

"visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3972

},

3973

"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.

3974

"confidentialInstanceConfig": { # A set of Confidential Instance options.

3975

"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.

3976

},

3977

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

3978

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

3979

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

3980

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3981

"disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.

3982

{ # An instance-attached disk resource.

3983

"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).

3984

"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.

3985

"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.

3986

#

3987

# 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.

3988

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.

3989

#

3990

# 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.

3991

#

3992

# 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.

3993

#

3994

# 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.

3995

#

3996

# Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.

3997

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3998

"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.

3999

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

4000

"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

2020-05-20 12:08:20 -0700

[diff] [blame]

4001

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4002

# The key must meet the following requirements before you can provide it to Compute Engine:

4003

# - The key is wrapped using a RSA public key certificate provided by Google.

4004

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

4005

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

4006

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

4007

},

4008

"diskSizeGb": "A String", # The size of the disk in GB.

4009

"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.

4010

"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.

4011

{ # Guest OS features.

4012

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

4013

},

4014

],

4015

"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.

4016

"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.

4017

#

4018

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

4019

#

4020

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

4021

"description": "A String", # An optional description. Provide this property when creating the disk.

4022

"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.

4023

"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.

4024

"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:

4025

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4026

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4027

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4028

# 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:

4029

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType

4030

# - projects/project/zones/zone/diskTypes/diskType

4031

# - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.

4032

"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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4033

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4034

# Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

4035

{ # Guest OS features.

4036

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

4037

},

4038

],

4039

"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.

4040

"a_key": "A String",

4041

},

4042

"multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.

4043

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

4044

"provisionedIops": "A String", # Indicates how many IOPS must be provisioned for the disk.

4045

"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

4046

"A String",

4047

],

4048

"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.

4049

"A String",

4050

],

4051

"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]

4052

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4053

# 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:

4054

# projects/debian-cloud/global/images/family/debian-9

4055

#

4056

#

4057

# Alternatively, use a specific version of a public operating system image:

4058

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

4059

#

4060

#

4061

# To create a disk with a custom image that you created, specify the image name in the following format:

4062

# global/images/my-custom-image

4063

#

4064

#

4065

# 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:

4066

# global/images/family/my-image-family

4067

#

4068

#

4069

# If the source image is deleted later, this field will not be set.

4070

"sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

4071

#

4072

# 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4073

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

4074

"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.

4075

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

4076

"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]

4077

#

4078

# The key must meet the following requirements before you can provide it to Compute Engine:

4079

# - 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]

4080

# - 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]

4081

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4082

"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]

4083

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4084

"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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4085

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4086

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

4087

# global/snapshots/my-backup

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4088

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4089

#

4090

# If the source snapshot is deleted later, this field will not be set.

4091

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

4092

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

4093

"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.

4094

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

4095

"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]

4096

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4097

# The key must meet the following requirements before you can provide it to Compute Engine:

4098

# - The key is wrapped using a RSA public key certificate provided by Google.

4099

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

4100

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

4101

"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]

4102

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4103

},

4104

"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.

4105

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

4106

"licenses": [ # [Output Only] Any valid publicly visible licenses.

4107

"A String",

4108

],

4109

"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.

4110

"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.

4111

"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

4112

"dbs": [ # The Key Database (db).

4113

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4114

"content": "A String", # The raw content in the secure keys file.

4115

"fileType": "A String", # The file type of source file.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4116

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4117

],

4118

"dbxs": [ # The forbidden key database (dbx).

4119

{

4120

"content": "A String", # The raw content in the secure keys file.

4121

"fileType": "A String", # The file type of source file.

4122

},

4123

],

4124

"keks": [ # The Key Exchange Key (KEK).

4125

{

4126

"content": "A String", # The raw content in the secure keys file.

4127

"fileType": "A String", # The file type of source file.

4128

},

4129

],

4130

"pk": { # The Platform Key (PK).

4131

"content": "A String", # The raw content in the secure keys file.

4132

"fileType": "A String", # The file type of source file.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4133

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4134

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4135

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4136

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4137

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4138

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4139

# Note that for InstanceTemplate, specify the disk name, not the URL for the disk.

4140

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

4141

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4142

"A String",

4143

],

4144

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4145

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4146

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

4147

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

4148

},

4149

"eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.

4150

"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.

4151

#

4152

# To see the latest fingerprint, make get() request to the instance.

4153

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

4154

{ # A specification of the type and number of accelerator cards attached to the instance.

4155

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

4156

"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.

4157

},

4158

],

4159

"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.

4160

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

4161

"instanceEncryptionKey": { # Encrypts or decrypts data for an instance with a customer-supplied encryption key.

4162

#

4163

# 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.

4164

#

4165

# 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.

4166

#

4167

# 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.

4168

#

4169

# 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.

4170

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

4171

"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.

4172

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

4173

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

4174

#

4175

# The key must meet the following requirements before you can provide it to Compute Engine:

4176

# - The key is wrapped using a RSA public key certificate provided by Google.

4177

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

4178

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

4179

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

4180

},

4181

"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.

4182

"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.

4183

#

4184

# To see the latest fingerprint, make get() request to the instance.

4185

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

4186

"a_key": "A String",

4187

},

4188

"lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format.

4189

"lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format.

4190

"lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format.

4191

"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:

4192

# zones/us-central1-f/machineTypes/n1-standard-1

4193

#

4194

#

4195

# 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):

4196

# zones/zone/machineTypes/custom-CPUS-MEMORY

4197

#

4198

#

4199

# For example: zones/us-central1-f/machineTypes/custom-4-5120

4200

#

4201

# For a full list of restrictions, read the Specifications for custom machine types.

4202

"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

4203

"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.

4204

#

4205

# To see the latest fingerprint, make a get() request to retrieve the resource.

4206

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

4207

{

4208

"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.

4209

"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).

4210

},

4211

],

4212

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

4213

},

4214

"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".

4215

"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.

4216

"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.

4217

{ # A network interface resource attached to an instance.

4218

"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.

4219

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

4220

"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.

4221

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

4222

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

4223

"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.

4224

"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.

4225

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

4226

#

4227

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

4228

#

4229

# 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.

4230

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

4231

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

4232

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

4233

"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.

4234

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

4235

},

4236

],

4237

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

4238

{ # An alias IP range attached to an instance's network interface.

4239

"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).

4240

"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.

4241

},

4242

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

4243

"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. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4244

"internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range.

4245

"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.

4246

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

4247

"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.

4248

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

4249

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

4250

"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.

4251

"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.

4252

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

4253

#

4254

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

4255

#

4256

# 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.

4257

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

4258

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

4259

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

4260

"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.

4261

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

4262

},

4263

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4264

"ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork.

4265

#

4266

# Valid only if stackType is IPV4_IPV6.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4267

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

4268

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

4269

"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.

4270

"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.

4271

#

4272

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

4273

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

4274

# - projects/project/global/networks/network

4275

# - global/networks/default

4276

"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.

4277

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

4278

"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.

4279

"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.

4280

#

4281

# This field can be both set at instance creation and update network interface operations.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4282

"subinterfaces": [ # SubInterfaces help enable L2 communication for the instance over subnetworks that support L2. Every network interface will get a default untagged (vlan not specified) subinterface. Users can specify additional tagged subinterfaces which are sub-fields to the Network Interface.

4283

{

4284

"ipAddress": "A String", # An IPv4 internal IP address to assign to the instance for this subinterface.

4285

"subnetwork": "A String", # If specified, this subnetwork must belong to the same network as that of the network interface. If not specified the subnet of network interface will be used. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:

4286

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

4287

# - regions/region/subnetworks/subnetwork

4288

"vlan": 42, # VLAN tag. Should match the VLAN(s) supported by the subnetwork to which this subinterface is connecting.

4289

},

4290

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4291

"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:

4292

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

4293

# - regions/region/subnetworks/subnetwork

4294

},

4295

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4296

"networkPerformanceConfig": {

4297

"externalIpEgressBandwidthTier": "A String",

4298

"totalEgressBandwidthTier": "A String",

4299

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4300

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.

4301

"preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api.

4302

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.

4303

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.

4304

"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.

4305

"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.

4306

"values": [ # Corresponds to the label values of a reservation resource.

"A String",

],

},

"resourcePolicies": [ # Resource policies applied to this instance.

4311

"A String",

4312

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4313

"resourceStatus": { # Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls. # [Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field.

4314

"scheduling": {

4315

"availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.

4316

},

4317

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4318

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

4319

"scheduling": { # Sets the scheduling options for an Instance. NextID: 20 # Sets the scheduling options for this instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4320

"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.

4321

#

4322

# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4323

"availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4324

"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.

4325

"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.

4326

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after instance creation where the instance won't be scheduled for maintenance.

4327

"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.

4328

#

4329

# See go/stable-fleet-ug for more details.

4330

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

4331

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

4332

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

4333

"key": "A String", # Corresponds to the label key of Node resource.

4334

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

4335

"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.

4341

"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.

4342

},

4343

"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.

4344

"A String",

4345

],

4346

"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.

4347

"A String",

4348

],

4349

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

4350

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

4351

"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

4352

#

4353

# 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.

4354

{ # A service account.

4355

"email": "A String", # Email address of the service account.

4356

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

4362

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

4363

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

4364

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

4365

},

4366

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

4367

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

4368

},

4369

"shieldedVmConfig": { # A set of Shielded VM options. # Deprecating, please use shielded_instance_config.

4370

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

4371

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

4372

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

4373

},

4374

"shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured. # Deprecating, please use shielded_instance_integrity_policy.

4375

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

4376

},

4377

"sourceMachineImage": "A String", # Source machine image

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

4378

"sourceMachineImageEncryptionKey": { # Source machine image encryption key when creating an instance from a machine image.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4379

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

4380

"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.

4381

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

4382

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

4383

#

4384

# The key must meet the following requirements before you can provide it to Compute Engine:

4385

# - The key is wrapped using a RSA public key certificate provided by Google.

4386

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

4387

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

4388

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

4389

},

4390

"startRestricted": True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.

4391

"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.

4392

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

4393

"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.

4394

"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.

4395

#

4396

# To see the latest fingerprint, make get() request to the instance.

4397

"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.

4402

"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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4403

"startTimeWindow": { # Represents a window of time using two timestamps: `earliest` and `latest`. This timestamp values are in RFC3339 text format. # [Output Only] The start time window of the maintenance disruption.

4404

"earliest": "A String",

4405

"latest": "A String",

4406

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4407

"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.

4408

"type": "A String", # Defines the type of maintenance.

4409

},

4410

"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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4411

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4412

],

4413

"kind": "compute#instanceList", # [Output Only] Type of resource. Always compute#instanceList for lists of Instance resources.

4414

"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.

4415

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

4416

"warning": { # [Output Only] Informational warning message.

4417

"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.

4418

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4419

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4420

{

4421

"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).

4422

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4423

},

4424

],

4425

"message": "A String", # [Output Only] A human-readable description of the warning code.

4426

},

4427

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4431

<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]

4432

<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]

4433

4434

Args:

4435

project: string, Project ID for this request. (required)

4436

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4437

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]

4438

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]

4439

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4440

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]

4441

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4442

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]

4443

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4444

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]

4445

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]

4446

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

4447

4448

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.

4449

4450

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4451

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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4452

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4453

4454

Returns:

4455

An object of the form:

4456

4457

{ # Contains a list of instance referrers.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4458

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

4459

"items": [ # A list of Reference resources.

4460

{ # Represents a reference to a resource.

4461

"kind": "compute#reference", # [Output Only] Type of the resource. Always compute#reference for references.

4462

"referenceType": "A String", # A description of the reference type with no implied semantics. Possible values include:

4463

# - MEMBER_OF

4464

"referrer": "A String", # URL of the resource which refers to the target.

4465

"target": "A String", # URL of the resource to which this reference points.

4466

},

4467

],

4468

"kind": "compute#instanceListReferrers", # [Output Only] Type of resource. Always compute#instanceListReferrers for lists of Instance referrers.

4469

"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.

4470

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

4471

"warning": { # [Output Only] Informational warning message.

4472

"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.

4473

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4474

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4475

{

4476

"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).

4477

"value": "A String", # [Output Only] A warning data value corresponding to the key.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4478

},

4479

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4480

"message": "A String", # [Output Only] A human-readable description of the warning code.

4481

},

4482

}</pre>

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

</div>

<code class="details" id="listReferrers_next">listReferrers_next(previous_request, previous_response)</code>

4487

<pre>Retrieves the next page of results.

4488

4489

Args:

4490

previous_request: The request for the previous page. (required)

4491

previous_response: The response from the request for the previous page. (required)

4492

4493

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4494

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4495

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]

4500

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

4501

<pre>Retrieves the next page of results.

4502

4503

Args:

4504

previous_request: The request for the previous page. (required)

4505

previous_response: The response from the request for the previous page. (required)

4506

4507

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4508

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4509

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]

4514

<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]

4515

<pre>Removes resource policies from an instance.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4516

4517

Args:

4518

project: string, Project ID for this request. (required)

4519

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4520

instance: string, The instance name for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4521

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4522

The object takes the form of:

4523

4524

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4525

"resourcePolicies": [ # Resource policies to be removed from this instance.

4526

"A String",

4527

],

4528

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4529

4530

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.

4531

4532

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.

4533

4534

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]

4535

4536

Returns:

4537

An object of the form:

4538

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4539

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4540

#

4541

# Google Compute Engine has three Operation resources:

4542

#

4543

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4544

#

4545

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4546

#

4547

# Operations can be global, regional or zonal.

4548

# - For global operations, use the `globalOperations` resource.

4549

# - For regional operations, use the `regionOperations` resource.

4550

# - For zonal operations, use the `zonalOperations` resource.

4551

#

4552

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

4553

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4554

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4555

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4556

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4557

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4558

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4559

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4560

"code": "A String", # [Output Only] The error type identifier for this error.

4561

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4562

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4563

},

4564

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4565

},

4566

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4567

"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.

4568

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4569

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4570

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4571

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4572

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4573

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4574

"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.

4575

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4576

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4577

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

4578

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4579

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4580

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4581

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4582

"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.

4583

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4584

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4585

{

4586

"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.

4587

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4588

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4589

{

4590

"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).

4591

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4592

},

4593

],

4594

"message": "A String", # [Output Only] A human-readable description of the warning code.

4595

},

4596

],

4597

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

4598

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

<code class="details" id="reset">reset(project, zone, instance, requestId=None)</code>

4603

<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.

4604

4605

Args:

4606

project: string, Project ID for this request. (required)

4607

zone: string, The name of the zone for this request. (required)

4608

instance: string, Name of the instance scoping this request. (required)

4609

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.

4610

4611

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.

4612

4613

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

4614

4615

Returns:

4616

An object of the form:

4617

4618

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4619

#

4620

# Google Compute Engine has three Operation resources:

4621

#

4622

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4623

#

4624

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4625

#

4626

# Operations can be global, regional or zonal.

4627

# - For global operations, use the `globalOperations` resource.

4628

# - For regional operations, use the `regionOperations` resource.

4629

# - For zonal operations, use the `zonalOperations` resource.

4630

#

4631

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

4632

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4633

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4634

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4635

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4636

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4637

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4638

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4639

"code": "A String", # [Output Only] The error type identifier for this error.

4640

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4641

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4642

},

4643

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4644

},

4645

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4646

"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.

4647

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4648

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4649

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4650

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4651

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4652

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4653

"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.

4654

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4655

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4656

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

4657

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4658

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4659

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4660

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4661

"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.

4662

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4663

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4664

{

4665

"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.

4666

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4667

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4668

{

4669

"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).

4670

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4671

},

4672

],

4673

"message": "A String", # [Output Only] A human-readable description of the warning code.

4674

},

4675

],

4676

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

4677

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4681

<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]

4682

<pre>Resumes an instance that was suspended using the instances().suspend method.

4683

4684

Args:

4685

project: string, Project ID for this request. (required)

4686

zone: string, The name of the zone for this request. (required)

4687

instance: string, Name of the instance resource to resume. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4688

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4689

The object takes the form of:

4690

4691

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4692

"disks": [ # Array of disks associated with this instance that are protected with a customer-supplied encryption key.

4693

#

4694

# In order to resume the instance, the disk url and its corresponding key must be provided.

4695

#

4696

# If the disk is not protected with a customer-supplied encryption key it should not be specified.

4697

{

4698

"diskEncryptionKey": { # Decrypts data associated with the disk with a customer-supplied encryption key.

4699

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

4700

"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.

4701

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

4702

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

4703

#

4704

# The key must meet the following requirements before you can provide it to Compute Engine:

4705

# - The key is wrapped using a RSA public key certificate provided by Google.

4706

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

4707

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

4708

"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]

4709

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4710

"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

2020-05-20 12:08:20 -0700

[diff] [blame]

4711

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4712

],

4713

"instanceEncryptionKey": { # Decrypts data associated with an instance that is protected with a customer-supplied encryption key.

4714

#

4715

# 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.

4716

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

4717

"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.

4718

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

4719

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

4720

#

4721

# The key must meet the following requirements before you can provide it to Compute Engine:

4722

# - The key is wrapped using a RSA public key certificate provided by Google.

4723

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

4724

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

4725

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

4726

},

4727

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4728

4729

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.

4730

4731

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.

4732

4733

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

4734

4735

Returns:

4736

An object of the form:

4737

4738

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4739

#

4740

# Google Compute Engine has three Operation resources:

4741

#

4742

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4743

#

4744

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4745

#

4746

# Operations can be global, regional or zonal.

4747

# - For global operations, use the `globalOperations` resource.

4748

# - For regional operations, use the `regionOperations` resource.

4749

# - For zonal operations, use the `zonalOperations` resource.

4750

#

4751

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

4752

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4753

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4754

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4755

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4756

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4757

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4758

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4759

"code": "A String", # [Output Only] The error type identifier for this error.

4760

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4761

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4762

},

4763

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4764

},

4765

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4766

"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.

4767

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4768

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4769

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4770

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4771

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4772

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4773

"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.

4774

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4775

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4776

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

4777

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4778

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4779

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4780

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4781

"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.

4782

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4783

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4784

{

4785

"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.

4786

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4787

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4788

{

4789

"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).

4790

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4791

},

4792

],

4793

"message": "A String", # [Output Only] A human-readable description of the warning code.

4794

},

4795

],

4796

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

4797

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

4801

<code class="details" id="sendDiagnosticInterrupt">sendDiagnosticInterrupt(project, zone, instance)</code>

4802

<pre>TODO(b/180520210): Add IAM permission for this API. Sends diagnostic interrupt to the instance.

4803

4804

Args:

4805

project: string, Project ID for this request. (required)

4806

zone: string, The name of the zone for this request. (required)

4807

instance: string, Name of the instance scoping this request. (required)

</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4812

<code class="details" id="setDeletionProtection">setDeletionProtection(project, zone, resource, deletionProtection=None, requestId=None)</code>

4813

<pre>Sets deletion protection on the instance.

4814

4815

Args:

4816

project: string, Project ID for this request. (required)

4817

zone: string, The name of the zone for this request. (required)

4818

resource: string, Name or id of the resource for this request. (required)

4819

deletionProtection: boolean, Whether the resource should be protected against deletion.

4820

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.

4821

4822

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.

4823

4824

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

4825

4826

Returns:

4827

An object of the form:

4828

4829

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4830

#

4831

# Google Compute Engine has three Operation resources:

4832

#

4833

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4834

#

4835

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4836

#

4837

# Operations can be global, regional or zonal.

4838

# - For global operations, use the `globalOperations` resource.

4839

# - For regional operations, use the `regionOperations` resource.

4840

# - For zonal operations, use the `zonalOperations` resource.

4841

#

4842

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

4843

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4844

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4845

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4846

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4847

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4848

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4849

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4850

"code": "A String", # [Output Only] The error type identifier for this error.

4851

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4852

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4853

},

4854

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4855

},

4856

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4857

"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.

4858

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4859

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4860

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4861

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4862

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4863

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4864

"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.

4865

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4866

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4867

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

4868

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4869

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4870

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4871

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4872

"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.

4873

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4874

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4875

{

4876

"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.

4877

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4878

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4879

{

4880

"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).

4881

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4882

},

4883

],

4884

"message": "A String", # [Output Only] A human-readable description of the warning code.

4885

},

4886

],

4887

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

4888

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

4892

<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]

4893

<pre>Sets the auto-delete flag for a disk attached to an instance.

4894

4895

Args:

4896

project: string, Project ID for this request. (required)

4897

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4898

instance: string, The instance name for this request. (required)

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4899

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]

4900

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)

4901

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.

4902

4903

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.

4904

4905

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]

4906

4907

Returns:

4908

An object of the form:

4909

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4910

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4911

#

4912

# Google Compute Engine has three Operation resources:

4913

#

4914

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4915

#

4916

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4917

#

4918

# Operations can be global, regional or zonal.

4919

# - For global operations, use the `globalOperations` resource.

4920

# - For regional operations, use the `regionOperations` resource.

4921

# - For zonal operations, use the `zonalOperations` resource.

4922

#

4923

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

4924

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4925

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4926

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4927

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4928

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4929

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4930

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4931

"code": "A String", # [Output Only] The error type identifier for this error.

4932

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4933

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4934

},

4935

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4936

},

4937

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4938

"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.

4939

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4940

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4941

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4942

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4943

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4944

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4945

"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.

4946

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4947

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4948

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

4949

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4950

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4951

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4952

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4953

"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.

4954

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4955

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4956

{

4957

"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.

4958

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4959

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4960

{

4961

"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).

4962

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4963

},

4964

],

4965

"message": "A String", # [Output Only] A human-readable description of the warning code.

4966

},

4967

],

4968

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

4969

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4973

<code class="details" id="setIamPolicy">setIamPolicy(project, zone, resource, body=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4974

<pre>Sets the access control policy on the specified resource. Replaces any existing policy.

4975

4976

Args:

4977

project: string, Project ID for this request. (required)

4978

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4979

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4980

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4981

The object takes the form of:

4982

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4983

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4984

"bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings.

4985

{ # Associates `members` with a `role`.

4986

"bindingId": "A String",

4987

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4988

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4989

# If the condition evaluates to `true`, then this binding applies to the current request.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4990

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4991

# 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4992

#

4993

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4994

#

4995

# Example (Comparison):

4996

#

4997

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

4998

#

4999

# Example (Equality):

5000

#

5001

# 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'"

5006

#

5007

# Example (Data Manipulation):

5008

#

5009

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

5010

#

5011

# 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.

5012

"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.

5013

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

5014

"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.

5015

"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.

5016

},

5017

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

5018

#

5019

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

5020

#

5021

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

5022

#

5023

# * `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`.

5028

#

5029

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

5030

#

5031

# * `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.

5032

#

5033

# * `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.

5034

#

5035

# * `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`.

5040

"A String",

5041

],

5042

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5043

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5044

],

5045

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.

5046

"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

2016-10-21 13:59:49 -0700

[diff] [blame]

5047

#

5048

#

5049

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5050

# 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]

5051

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5052

# 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]

5053

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5054

# **JSON example:**

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5055

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5056

# { "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]

5057

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5058

# **YAML example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5059

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5060

# 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]

5061

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5062

# 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]

5063

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

5064

{ # 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]

5065

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5066

# 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]

5067

#

5068

# Example Policy with multiple AuditConfigs:

5069

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5070

# { "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]

5071

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5072

# 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]

5073

"auditLogConfigs": [ # The configuration for logging of each type of permission.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

5074

{ # Provides the configuration for logging a type of permissions. Example:

5075

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5076

# { "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]

5077

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5078

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

5079

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

5080

"A String",

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

5081

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5082

"ignoreChildExemptions": True or False,

5083

"logType": "A String", # The log type that this config enables.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

5084

},

5085

],

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]

5090

},

5091

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5092

"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]

5093

{ # Associates `members` with a `role`.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

5094

"bindingId": "A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5095

"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.

5096

#

5097

# If the condition evaluates to `true`, then this binding applies to the current request.

5098

#

5099

# 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.

5100

#

5101

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

5102

#

5103

# Example (Comparison):

5104

#

5105

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

5106

#

5107

# Example (Equality):

5108

#

5109

# 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'"

5114

#

5115

# Example (Data Manipulation):

5116

#

5117

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

5118

#

5119

# 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.

5120

"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.

5121

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

5122

"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.

5123

"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.

5124

},

5125

"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]

5126

#

5127

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

5128

#

5129

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

5130

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5131

# * `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]

5132

#

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

5133

#

5134

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5135

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

5136

#

5137

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

5138

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5139

# * `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.

5140

#

5141

# * `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.

5142

#

5143

# * `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.

5144

#

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

5145

#

5146

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5147

# * `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]

5148

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5149

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5150

"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]

5151

},

5152

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5153

"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.

5154

#

5155

# **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.

5156

"iamOwned": True or False,

5157

"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.

5158

{ # A rule to be applied in a Policy.

5159

"action": "A String", # Required

5160

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

5161

{ # A condition to be met.

5162

"iam": "A String", # Trusted attributes supplied by the IAM system.

5163

"op": "A String", # An operator to apply the subject with.

5164

"svc": "A String", # Trusted attributes discharged by the service.

5165

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

5166

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

5172

"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.

5173

"A String",

5174

],

5175

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

5176

{ # Specifies what kind of log the caller must write

5177

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

5178

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

5179

"permissionType": "A String", # The type of the permission that was checked.

5180

},

5181

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

5182

},

5183

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

5184

#

5185

# 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.

5186

#

5187

# Field names correspond to IAM request parameters and field values are their respective values.

5188

#

5189

# 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.

5190

#

5191

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

5192

"customFields": [ # Custom fields.

5193

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

5194

"name": "A String", # Name is the field name.

5195

"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.

5196

},

5197

],

5198

"field": "A String", # The field value to attribute.

5199

"metric": "A String", # The metric to update.

5200

},

5201

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

5202

"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.

5207

"A String",

5208

],

5209

"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.

5215

#

5216

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

5217

#

5218

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

5219

#

5220

# * 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

5221

#

5222

# **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.

5223

#

5224

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

5225

#

5226

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

},

}

Returns:

An object of the form:

5233

5234

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.

#

#

#

# 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.

5239

#

5240

# 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).

#

# **JSON example:**

#

# { "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 }

#

# **YAML example:**

#

# 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

5249

#

5250

# For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

5251

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

5252

{ # 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.

5253

#

5254

# 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.

5255

#

5256

# Example Policy with multiple AuditConfigs:

5257

#

5258

# { "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" ] } ] } ] }

5259

#

5260

# 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.

5261

"auditLogConfigs": [ # The configuration for logging of each type of permission.

5262

{ # Provides the configuration for logging a type of permissions. Example:

5263

#

5264

# { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] }

5265

#

5266

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

5267

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

5268

"A String",

5269

],

5270

"ignoreChildExemptions": True or False,

5271

"logType": "A String", # The log type that this config enables.

},

],

"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.

5278

},

5279

],

5280

"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.

5281

{ # Associates `members` with a `role`.

5282

"bindingId": "A String",

5283

"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.

5284

#

5285

# If the condition evaluates to `true`, then this binding applies to the current request.

5286

#

5287

# 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.

5288

#

5289

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

5290

#

5291

# Example (Comparison):

5292

#

5293

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

5294

#

5295

# Example (Equality):

5296

#

5297

# 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'"

5302

#

5303

# Example (Data Manipulation):

5304

#

5305

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

5306

#

5307

# 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.

5308

"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.

5309

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

5310

"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.

5311

"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.

5312

},

5313

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

5314

#

5315

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

5316

#

5317

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

5318

#

5319

# * `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`.

5324

#

5325

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

5326

#

5327

# * `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.

5328

#

5329

# * `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.

5330

#

5331

# * `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`.

5336

"A String",

5337

],

5338

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

5339

},

5340

],

5341

"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.

5342

#

5343

# **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.

5344

"iamOwned": True or False,

5345

"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.

5346

{ # A rule to be applied in a Policy.

5347

"action": "A String", # Required

5348

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

5349

{ # A condition to be met.

5350

"iam": "A String", # Trusted attributes supplied by the IAM system.

5351

"op": "A String", # An operator to apply the subject with.

5352

"svc": "A String", # Trusted attributes discharged by the service.

5353

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

5354

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

5360

"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.

5361

"A String",

5362

],

5363

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

5364

{ # Specifies what kind of log the caller must write

5365

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

5366

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

5367

"permissionType": "A String", # The type of the permission that was checked.

5368

},

5369

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

5370

},

5371

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

5372

#

5373

# 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.

5374

#

5375

# Field names correspond to IAM request parameters and field values are their respective values.

5376

#

5377

# 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.

5378

#

5379

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

5380

"customFields": [ # Custom fields.

5381

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

5382

"name": "A String", # Name is the field name.

5383

"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.

5384

},

5385

],

5386

"field": "A String", # The field value to attribute.

5387

"metric": "A String", # The metric to update.

5388

},

5389

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

5390

"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.

5395

"A String",

5396

],

5397

"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.

5403

#

5404

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

5405

#

5406

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

5407

#

5408

# * 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

5409

#

5410

# **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.

5411

#

5412

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

5413

#

5414

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

5415

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5419

<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]

5420

<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]

5421

5422

Args:

5423

project: string, Project ID for this request. (required)

5424

zone: string, The name of the zone for this request. (required)

5425

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5426

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5427

The object takes the form of:

5428

5429

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5430

"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.

"labels": {

"a_key": "A String",

},

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5435

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5436

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.

5437

5438

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.

5439

5440

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]

5441

5442

Returns:

5443

An object of the form:

5444

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5445

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5446

#

5447

# Google Compute Engine has three Operation resources:

5448

#

5449

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5450

#

5451

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5452

#

5453

# Operations can be global, regional or zonal.

5454

# - For global operations, use the `globalOperations` resource.

5455

# - For regional operations, use the `regionOperations` resource.

5456

# - For zonal operations, use the `zonalOperations` resource.

5457

#

5458

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

5459

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5460

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5461

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5462

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5463

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5464

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5465

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5466

"code": "A String", # [Output Only] The error type identifier for this error.

5467

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5468

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5469

},

5470

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5471

},

5472

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5473

"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.

5474

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5475

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5476

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5477

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5478

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5479

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5480

"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.

5481

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5482

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5483

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5484

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5485

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5486

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5487

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5488

"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.

5489

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5490

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5491

{

5492

"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.

5493

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5494

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5495

{

5496

"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).

5497

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5498

},

5499

],

5500

"message": "A String", # [Output Only] A human-readable description of the warning code.

5501

},

5502

],

5503

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

5504

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5508

<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]

5509

<pre>Changes the number and/or type of accelerator for a stopped instance to the values specified in the request.

5510

5511

Args:

5512

project: string, Project ID for this request. (required)

5513

zone: string, The name of the zone for this request. (required)

5514

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5515

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

5516

The object takes the form of:

5517

5518

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5519

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

5520

{ # A specification of the type and number of accelerator cards attached to the instance.

5521

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

5522

"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.

5523

},

5524

],

5525

}

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

5526

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5527

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.

5528

5529

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.

5530

5531

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]

5532

5533

Returns:

5534

An object of the form:

5535

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5536

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5537

#

5538

# Google Compute Engine has three Operation resources:

5539

#

5540

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5541

#

5542

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5543

#

5544

# Operations can be global, regional or zonal.

5545

# - For global operations, use the `globalOperations` resource.

5546

# - For regional operations, use the `regionOperations` resource.

5547

# - For zonal operations, use the `zonalOperations` resource.

5548

#

5549

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

5550

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5551

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5552

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5553

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5554

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5555

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5556

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5557

"code": "A String", # [Output Only] The error type identifier for this error.

5558

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5559

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5560

},

5561

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5562

},

5563

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5564

"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.

5565

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5566

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5567

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5568

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5569

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5570

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5571

"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.

5572

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5573

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5574

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5575

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5576

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5577

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5578

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5579

"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.

5580

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5581

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5582

{

5583

"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.

5584

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5585

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5586

{

5587

"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).

5588

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5589

},

5590

],

5591

"message": "A String", # [Output Only] A human-readable description of the warning code.

5592

},

5593

],

5594

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

5595

}</pre>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5599

<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]

5600

<pre>Changes the machine type for a stopped instance to the machine type specified in the request.

5601

5602

Args:

5603

project: string, Project ID for this request. (required)

5604

zone: string, The name of the zone for this request. (required)

5605

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5606

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5607

The object takes the form of:

5608

5609

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5610

"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

5611

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5612

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5613

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.

5614

5615

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.

5616

5617

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]

5618

5619

Returns:

5620

An object of the form:

5621

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5622

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5623

#

5624

# Google Compute Engine has three Operation resources:

5625

#

5626

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5627

#

5628

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5629

#

5630

# Operations can be global, regional or zonal.

5631

# - For global operations, use the `globalOperations` resource.

5632

# - For regional operations, use the `regionOperations` resource.

5633

# - For zonal operations, use the `zonalOperations` resource.

5634

#

5635

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

5636

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5637

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5638

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5639

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5640

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5641

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5642

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5643

"code": "A String", # [Output Only] The error type identifier for this error.

5644

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5645

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5646

},

5647

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5648

},

5649

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5650

"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.

5651

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5652

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5653

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5654

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5655

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5656

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5657

"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.

5658

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5659

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5660

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5661

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5662

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5663

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5664

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5665

"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.

5666

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5667

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5668

{

5669

"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.

5670

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5671

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5672

{

5673

"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).

5674

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5675

},

5676

],

5677

"message": "A String", # [Output Only] A human-readable description of the warning code.

5678

},

5679

],

5680

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

5681

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5685

<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]

5686

<pre>Sets metadata for the specified instance to the data included in the request.

5687

5688

Args:

5689

project: string, Project ID for this request. (required)

5690

zone: string, The name of the zone for this request. (required)

5691

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5692

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5693

The object takes the form of:

5694

5695

{ # A metadata key/value entry.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5696

"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]

5697

#

5698

# 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]

5699

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

5700

{

5701

"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.

5702

"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).

5703

},

5704

],

5705

"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]

5706

}

5707

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5708

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.

5709

5710

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.

5711

5712

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]

5713

5714

Returns:

5715

An object of the form:

5716

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5717

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5718

#

5719

# Google Compute Engine has three Operation resources:

5720

#

5721

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5722

#

5723

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5724

#

5725

# Operations can be global, regional or zonal.

5726

# - For global operations, use the `globalOperations` resource.

5727

# - For regional operations, use the `regionOperations` resource.

5728

# - For zonal operations, use the `zonalOperations` resource.

5729

#

5730

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

5731

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5732

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5733

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5734

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5735

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5736

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5737

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5738

"code": "A String", # [Output Only] The error type identifier for this error.

5739

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5740

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5741

},

5742

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5743

},

5744

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5745

"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.

5746

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5747

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5748

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5749

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5750

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5751

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5752

"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.

5753

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5754

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5755

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5756

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5757

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5758

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5759

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5760

"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.

5761

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5762

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5763

{

5764

"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.

5765

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5766

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5767

{

5768

"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).

5769

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5770

},

5771

],

5772

"message": "A String", # [Output Only] A human-readable description of the warning code.

5773

},

5774

],

5775

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

5776

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5780

<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]

5781

<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]

5782

5783

Args:

5784

project: string, Project ID for this request. (required)

5785

zone: string, The name of the zone for this request. (required)

5786

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5787

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

5788

The object takes the form of:

5789

5790

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5791

"minCpuPlatform": "A String", # Minimum cpu/platform this instance should be started at.

5792

}

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

5793

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5794

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.

5795

5796

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.

5797

5798

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]

5799

5800

Returns:

5801

An object of the form:

5802

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5803

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5804

#

5805

# Google Compute Engine has three Operation resources:

5806

#

5807

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5808

#

5809

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5810

#

5811

# Operations can be global, regional or zonal.

5812

# - For global operations, use the `globalOperations` resource.

5813

# - For regional operations, use the `regionOperations` resource.

5814

# - For zonal operations, use the `zonalOperations` resource.

5815

#

5816

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

5817

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5818

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5819

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5820

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5821

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5822

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5823

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5824

"code": "A String", # [Output Only] The error type identifier for this error.

5825

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5826

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5827

},

5828

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5829

},

5830

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5831

"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.

5832

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5833

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5834

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5835

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5836

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5837

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5838

"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.

5839

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5840

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5841

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5842

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5843

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5844

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5845

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5846

"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.

5847

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5848

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5849

{

5850

"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.

5851

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5852

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5853

{

5854

"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).

5855

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5856

},

5857

],

5858

"message": "A String", # [Output Only] A human-readable description of the warning code.

5859

},

5860

],

5861

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

5862

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5866

<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]

5867

<pre>Sets name of an instance.

5868

5869

Args:

5870

project: string, Project ID for this request. (required)

5871

zone: string, The name of the zone for this request. (required)

5872

instance: string, The instance name for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5873

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5874

The object takes the form of:

5875

5876

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5877

"currentName": "A String", # The current name of this resource, used to prevent conflicts. Provide the latest name when making a request to change name.

5878

"name": "A String", # The name to be applied to the instance. Needs to be RFC 1035 compliant.

5879

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5880

5881

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.

5882

5883

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.

5884

5885

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

5886

5887

Returns:

5888

An object of the form:

5889

5890

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5891

#

5892

# Google Compute Engine has three Operation resources:

5893

#

5894

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5895

#

5896

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5897

#

5898

# Operations can be global, regional or zonal.

5899

# - For global operations, use the `globalOperations` resource.

5900

# - For regional operations, use the `regionOperations` resource.

5901

# - For zonal operations, use the `zonalOperations` resource.

5902

#

5903

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

5904

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5905

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5906

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5907

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5908

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5909

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5910

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5911

"code": "A String", # [Output Only] The error type identifier for this error.

5912

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5913

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5914

},

5915

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5916

},

5917

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5918

"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.

5919

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5920

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5921

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5922

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5923

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5924

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5925

"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.

5926

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5927

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5928

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5929

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5930

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5931

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5932

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5933

"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.

5934

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5935

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5936

{

5937

"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.

5938

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5939

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5940

{

5941

"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).

5942

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5943

},

5944

],

5945

"message": "A String", # [Output Only] A human-readable description of the warning code.

5946

},

5947

],

5948

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

5949

}</pre>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5953

<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]

5954

<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]

5955

5956

Args:

5957

project: string, Project ID for this request. (required)

5958

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5959

instance: string, Instance name for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5960

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5961

The object takes the form of:

5962

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

5963

{ # Sets the scheduling options for an Instance. NextID: 20

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5964

"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.

5965

#

5966

# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5967

"availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5968

"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.

5969

"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]

5970

"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]

5971

"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.

5972

#

5973

# See go/stable-fleet-ug for more details.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5974

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

5975

"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]

5976

{ # 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]

5977

"key": "A String", # Corresponds to the label key of Node resource.

5978

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

5979

"values": [ # Corresponds to the label values of Node resource.

5980

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5981

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5982

},

5983

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5984

"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]

5985

"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]

5986

}

5987

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5988

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.

5989

5990

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.

5991

5992

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]

5993

5994

Returns:

5995

An object of the form:

5996

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5997

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5998

#

5999

# Google Compute Engine has three Operation resources:

6000

#

6001

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6002

#

6003

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6004

#

6005

# Operations can be global, regional or zonal.

6006

# - For global operations, use the `globalOperations` resource.

6007

# - For regional operations, use the `regionOperations` resource.

6008

# - For zonal operations, use the `zonalOperations` resource.

6009

#

6010

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

6011

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6012

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6013

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6014

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6015

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6016

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6017

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6018

"code": "A String", # [Output Only] The error type identifier for this error.

6019

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6020

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6021

},

6022

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6023

},

6024

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6025

"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.

6026

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6027

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6028

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6029

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

6030

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6031

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6032

"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.

6033

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6034

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6035

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

6036

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6037

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6038

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6039

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6040

"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.

6041

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6042

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6043

{

6044

"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.

6045

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6046

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6047

{

6048

"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).

6049

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6050

},

6051

],

6052

"message": "A String", # [Output Only] A human-readable description of the warning code.

6053

},

6054

],

6055

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

6056

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6060

<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]

6061

<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]

6062

6063

Args:

6064

project: string, Project ID for this request. (required)

6065

zone: string, The name of the zone for this request. (required)

6066

instance: string, Name of the instance resource to start. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6067

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6068

The object takes the form of:

6069

6070

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6071

"email": "A String", # Email address of the service account.

6072

"scopes": [ # The list of scopes to be made available for this service account.

6073

"A String",

6074

],

6075

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6076

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6077

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.

6078

6079

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.

6080

6081

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]

6082

6083

Returns:

6084

An object of the form:

6085

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6086

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6087

#

6088

# Google Compute Engine has three Operation resources:

6089

#

6090

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6091

#

6092

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6093

#

6094

# Operations can be global, regional or zonal.

6095

# - For global operations, use the `globalOperations` resource.

6096

# - For regional operations, use the `regionOperations` resource.

6097

# - For zonal operations, use the `zonalOperations` resource.

6098

#

6099

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

6100

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6101

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6102

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6103

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6104

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6105

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6106

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6107

"code": "A String", # [Output Only] The error type identifier for this error.

6108

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6109

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6110

},

6111

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6112

},

6113

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6114

"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.

6115

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6116

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6117

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6118

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

6119

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6120

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6121

"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.

6122

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6123

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6124

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

6125

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6126

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6127

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6128

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6129

"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.

6130

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6131

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6132

{

6133

"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.

6134

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6135

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6136

{

6137

"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).

6138

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6139

},

6140

],

6141

"message": "A String", # [Output Only] A human-readable description of the warning code.

6142

},

6143

],

6144

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

6145

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6149

<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]

6150

<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.

6151

6152

Args:

6153

project: string, Project ID for this request. (required)

6154

zone: string, The name of the zone for this request. (required)

6155

instance: string, Name or id of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6156

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6157

The object takes the form of:

6158

6159

{ # The policy describes the baseline against which Instance boot integrity is measured.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6160

"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]

6161

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6162

6163

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.

6164

6165

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.

6166

6167

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

6168

6169

Returns:

6170

An object of the form:

6171

6172

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6173

#

6174

# Google Compute Engine has three Operation resources:

6175

#

6176

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6177

#

6178

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6179

#

6180

# Operations can be global, regional or zonal.

6181

# - For global operations, use the `globalOperations` resource.

6182

# - For regional operations, use the `regionOperations` resource.

6183

# - For zonal operations, use the `zonalOperations` resource.

6184

#

6185

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

6186

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6187

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6188

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6189

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6190

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6191

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6192

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6193

"code": "A String", # [Output Only] The error type identifier for this error.

6194

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6195

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6196

},

6197

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6198

},

6199

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6200

"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.

6201

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6202

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6203

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6204

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

6205

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6206

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6207

"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.

6208

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6209

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6210

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

6211

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6212

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6213

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6214

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6215

"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.

6216

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6217

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6218

{

6219

"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.

6220

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6221

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6222

{

6223

"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).

6224

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6225

},

6226

],

6227

"message": "A String", # [Output Only] A human-readable description of the warning code.

6228

},

6229

],

6230

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

6231

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6235

<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]

6236

<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.

6237

6238

Args:

6239

project: string, Project ID for this request. (required)

6240

zone: string, The name of the zone for this request. (required)

6241

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6242

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6243

The object takes the form of:

6244

6245

{ # 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]

6246

"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]

6247

}

6248

6249

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.

6250

6251

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.

6252

6253

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

6254

6255

Returns:

6256

An object of the form:

6257

6258

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6259

#

6260

# Google Compute Engine has three Operation resources:

6261

#

6262

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6263

#

6264

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6265

#

6266

# Operations can be global, regional or zonal.

6267

# - For global operations, use the `globalOperations` resource.

6268

# - For regional operations, use the `regionOperations` resource.

6269

# - For zonal operations, use the `zonalOperations` resource.

6270

#

6271

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

6272

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6273

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6274

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6275

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6276

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6277

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6278

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6279

"code": "A String", # [Output Only] The error type identifier for this error.

6280

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6281

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6282

},

6283

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6284

},

6285

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6286

"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.

6287

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6288

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6289

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6290

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

6291

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6292

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6293

"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.

6294

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6295

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6296

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

6297

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6298

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6299

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6300

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6301

"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.

6302

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6303

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6304

{

6305

"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.

6306

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6307

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6308

{

6309

"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).

6310

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6311

},

6312

],

6313

"message": "A String", # [Output Only] A human-readable description of the warning code.

6314

},

6315

],

6316

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

6317

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6321

<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]

6322

<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]

6323

6324

Args:

6325

project: string, Project ID for this request. (required)

6326

zone: string, The name of the zone for this request. (required)

6327

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6328

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6329

The object takes the form of:

6330

6331

{ # A set of instance tags.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6332

"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]

6333

#

6334

# To see the latest fingerprint, make get() request to the instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6335

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

6336

"A String",

6337

],

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6338

}

6339

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6340

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.

6341

6342

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.

6343

6344

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]

6345

6346

Returns:

6347

An object of the form:

6348

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6349

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6350

#

6351

# Google Compute Engine has three Operation resources:

6352

#

6353

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6354

#

6355

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6356

#

6357

# Operations can be global, regional or zonal.

6358

# - For global operations, use the `globalOperations` resource.

6359

# - For regional operations, use the `regionOperations` resource.

6360

# - For zonal operations, use the `zonalOperations` resource.

6361

#

6362

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

6363

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6364

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6365

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6366

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6367

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6368

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6369

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6370

"code": "A String", # [Output Only] The error type identifier for this error.

6371

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6372

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6373

},

6374

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6375

},

6376

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6377

"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.

6378

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6379

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6380

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6381

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

6382

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6383

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6384

"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.

6385

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6386

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6387

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

6388

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6389

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6390

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6391

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6392

"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.

6393

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6394

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6395

{

6396

"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.

6397

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6398

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6399

{

6400

"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).

6401

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6402

},

6403

],

6404

"message": "A String", # [Output Only] A human-readable description of the warning code.

6405

},

6406

],

6407

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

6408

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

6412

<code class="details" id="simulateMaintenanceEvent">simulateMaintenanceEvent(project, zone, instance)</code>

6413

<pre>Simulates a maintenance event on the instance.

6414

6415

Args:

6416

project: string, Project ID for this request. (required)

6417

zone: string, The name of the zone for this request. (required)

6418

instance: string, Name of the instance scoping this request. (required)

6419

6420

Returns:

6421

An object of the form:

6422

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6423

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6424

#

6425

# Google Compute Engine has three Operation resources:

6426

#

6427

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6428

#

6429

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6430

#

6431

# Operations can be global, regional or zonal.

6432

# - For global operations, use the `globalOperations` resource.

6433

# - For regional operations, use the `regionOperations` resource.

6434

# - For zonal operations, use the `zonalOperations` resource.

6435

#

6436

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

6437

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6438

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6439

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6440

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6441

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6442

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6443

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6444

"code": "A String", # [Output Only] The error type identifier for this error.

6445

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6446

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6447

},

6448

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6449

},

6450

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6451

"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.

6452

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6453

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6454

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6455

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

6456

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6457

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6458

"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.

6459

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6460

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6461

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

6462

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6463

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6464

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6465

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6466

"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.

6467

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6468

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6469

{

6470

"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.

6471

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6472

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6473

{

6474

"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).

6475

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6476

},

6477

],

6478

"message": "A String", # [Output Only] A human-readable description of the warning code.

6479

},

6480

],

6481

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

6482

}</pre>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

</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]

6487

<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]

6488

6489

Args:

6490

project: string, Project ID for this request. (required)

6491

zone: string, The name of the zone for this request. (required)

6492

instance: string, Name of the instance resource to start. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6493

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.

6494

6495

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.

6496

6497

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]

6498

6499

Returns:

6500

An object of the form:

6501

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6502

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6503

#

6504

# Google Compute Engine has three Operation resources:

6505

#

6506

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6507

#

6508

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6509

#

6510

# Operations can be global, regional or zonal.

6511

# - For global operations, use the `globalOperations` resource.

6512

# - For regional operations, use the `regionOperations` resource.

6513

# - For zonal operations, use the `zonalOperations` resource.

6514

#

6515

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

6516

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6517

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6518

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6519

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6520

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6521

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6522

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6523

"code": "A String", # [Output Only] The error type identifier for this error.

6524

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6525

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6526

},

6527

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6528

},

6529

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6530

"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.

6531

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6532

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6533

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6534

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

6535

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6536

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6537

"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

6538

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6539

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6540

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

6541

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6542

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6543

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6544

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6545

"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.

6546

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6547

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6548

{

6549

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

6550

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6551

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6552

{

6553

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

6554

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6555

},

6556

],

6557

"message": "A String", # [Output Only] A human-readable description of the warning code.

6558

},

6559

],

6560

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

6561

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6565

<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]

6566

<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]

6567

6568

Args:

6569

project: string, Project ID for this request. (required)

6570

zone: string, The name of the zone for this request. (required)

6571

instance: string, Name of the instance resource to start. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6572

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6573

The object takes the form of:

6574

6575

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6576

"disks": [ # Array of disks associated with this instance that are protected with a customer-supplied encryption key.

6577

#

6578

# In order to start the instance, the disk url and its corresponding key must be provided.

6579

#

6580

# If the disk is not protected with a customer-supplied encryption key it should not be specified.

6581

{

6582

"diskEncryptionKey": { # Decrypts data associated with the disk with a customer-supplied encryption key.

6583

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

6584

"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.

6585

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

6586

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

6587

#

6588

# The key must meet the following requirements before you can provide it to Compute Engine:

6589

# - The key is wrapped using a RSA public key certificate provided by Google.

6590

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

6591

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

6592

"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]

6593

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6594

"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

2020-05-20 12:08:20 -0700

[diff] [blame]

6595

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6596

],

6597

"instanceEncryptionKey": { # Decrypts data associated with an instance that is protected with a customer-supplied encryption key.

6598

#

6599

# 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.

6600

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

6601

"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.

6602

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

6603

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

6604

#

6605

# The key must meet the following requirements before you can provide it to Compute Engine:

6606

# - The key is wrapped using a RSA public key certificate provided by Google.

6607

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

6608

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

6609

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

6610

},

6611

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6612

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6613

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.

6614

6615

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.

6616

6617

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]

6618

6619

Returns:

6620

An object of the form:

6621

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6622

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6623

#

6624

# Google Compute Engine has three Operation resources:

6625

#

6626

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6627

#

6628

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6629

#

6630

# Operations can be global, regional or zonal.

6631

# - For global operations, use the `globalOperations` resource.

6632

# - For regional operations, use the `regionOperations` resource.

6633

# - For zonal operations, use the `zonalOperations` resource.

6634

#

6635

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

6636

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6637

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6638

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6639

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6640

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6641

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6642

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6643

"code": "A String", # [Output Only] The error type identifier for this error.

6644

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6645

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6646

},

6647

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6648

},

6649

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6650

"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.

6651

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6652

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6653

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6654

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

6655

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6656

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6657

"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.

6658

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6659

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6660

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

6661

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6662

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6663

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6664

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6665

"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.

6666

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6667

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6668

{

6669

"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.

6670

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6671

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6672

{

6673

"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).

6674

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6675

},

6676

],

6677

"message": "A String", # [Output Only] A human-readable description of the warning code.

6678

},

6679

],

6680

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

6681

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

6685

<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]

6686

<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]

6687

6688

Args:

6689

project: string, Project ID for this request. (required)

6690

zone: string, The name of the zone for this request. (required)

6691

instance: string, Name of the instance resource to stop. (required)

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

6692

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]

6693

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.

6694

6695

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.

6696

6697

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]

6698

6699

Returns:

6700

An object of the form:

6701

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6702

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6703

#

6704

# Google Compute Engine has three Operation resources:

6705

#

6706

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6707

#

6708

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6709

#

6710

# Operations can be global, regional or zonal.

6711

# - For global operations, use the `globalOperations` resource.

6712

# - For regional operations, use the `regionOperations` resource.

6713

# - For zonal operations, use the `zonalOperations` resource.

6714

#

6715

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

6716

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6717

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6718

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6719

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6720

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6721

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6722

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6723

"code": "A String", # [Output Only] The error type identifier for this error.

6724

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6725

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6726

},

6727

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6728

},

6729

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6730

"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.

6731

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6732

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6733

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6734

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

6735

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6736

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6737

"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.

6738

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6739

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6740

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

6741

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6742

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6743

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6744

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6745

"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.

6746

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6747

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6748

{

6749

"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.

6750

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6751

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6752

{

6753

"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).

6754

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6755

},

6756

],

6757

"message": "A String", # [Output Only] A human-readable description of the warning code.

6758

},

6759

],

6760

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

6761

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

6765

<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]

6766

<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.

6767

6768

Args:

6769

project: string, Project ID for this request. (required)

6770

zone: string, The name of the zone for this request. (required)

6771

instance: string, Name of the instance resource to suspend. (required)

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

6772

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]

6773

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.

6774

6775

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.

6776

6777

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]

6778

6779

Returns:

6780

An object of the form:

6781

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6782

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6783

#

6784

# Google Compute Engine has three Operation resources:

6785

#

6786

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6787

#

6788

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6789

#

6790

# Operations can be global, regional or zonal.

6791

# - For global operations, use the `globalOperations` resource.

6792

# - For regional operations, use the `regionOperations` resource.

6793

# - For zonal operations, use the `zonalOperations` resource.

6794

#

6795

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

6796

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6797

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6798

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6799

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6800

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6801

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6802

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6803

"code": "A String", # [Output Only] The error type identifier for this error.

6804

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6805

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6806

},

6807

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6808

},

6809

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6810

"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.

6811

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6812

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6813

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6814

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

6815

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6816

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6817

"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.

6818

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6819

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6820

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

6821

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6822

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6823

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6824

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6825

"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.

6826

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6827

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6828

{

6829

"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.

6830

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6831

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6832

{

6833

"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).

6834

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6835

},

6836

],

6837

"message": "A String", # [Output Only] A human-readable description of the warning code.

6838

},

6839

],

6840

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

6841

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6845

<code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6846

<pre>Returns permissions that a caller has on the specified resource.

6847

6848

Args:

6849

project: string, Project ID for this request. (required)

6850

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6851

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6852

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6853

The object takes the form of:

6854

6855

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6856

"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.

6857

"A String",

6858

],

6859

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

Returns:

An object of the form:

6864

6865

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6866

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.

6867

"A String",

6868

],

6869

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6873

<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]

6874

<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.

6875

6876

Args:

6877

project: string, Project ID for this request. (required)

6878

zone: string, The name of the zone for this request. (required)

6879

instance: string, Name of the instance resource to update. (required)

6880

body: object, The request body.

6881

The object takes the form of:

6882

6883

{ # Represents an Instance resource.

6884

#

6885

# 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]

6886

"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.

6887

"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).

6888

"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.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

6889

"visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6890

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6891

"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.

6892

"confidentialInstanceConfig": { # A set of Confidential Instance options.

6893

"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]

6894

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6895

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

6896

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

6897

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

6898

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

6899

"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]

6900

{ # An instance-attached disk resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6901

"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).

6902

"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.

6903

"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.

6904

#

6905

# 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]

6906

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6907

#

6908

# 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.

6909

#

6910

# 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.

6911

#

6912

# 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.

6913

#

6914

# 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]

6915

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

6916

"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.

6917

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

6918

"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]

6919

#

6920

# The key must meet the following requirements before you can provide it to Compute Engine:

6921

# - The key is wrapped using a RSA public key certificate provided by Google.

6922

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

6923

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6924

"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]

6925

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6926

"diskSizeGb": "A String", # The size of the disk in GB.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

6927

"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]

6928

"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.

6929

{ # Guest OS features.

6930

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

6931

},

6932

],

6933

"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.

6934

"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]

6935

#

6936

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

6937

#

6938

# 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]

6939

"description": "A String", # An optional description. Provide this property when creating the disk.

6940

"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.

6941

"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.

6942

"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]

6943

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

6944

#

6945

#

6946

# 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:

6947

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType

6948

# - projects/project/zones/zone/diskTypes/diskType

6949

# - 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]

6950

"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]

6951

#

6952

# Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

6953

{ # Guest OS features.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6954

"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]

6955

},

6956

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6957

"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.

6958

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6959

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

6960

"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]

6961

"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]

6962

"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]

6963

"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

6964

"A String",

6965

],

6966

"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.

6967

"A String",

6968

],

6969

"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]

6970

#

6971

# 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:

6972

# projects/debian-cloud/global/images/family/debian-9

6973

#

6974

#

6975

# Alternatively, use a specific version of a public operating system image:

6976

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

6977

#

6978

#

6979

# To create a disk with a custom image that you created, specify the image name in the following format:

6980

# global/images/my-custom-image

6981

#

6982

#

6983

# 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:

6984

# global/images/family/my-image-family

6985

#

6986

#

6987

# If the source image is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6988

"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]

6989

#

6990

# 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.

6991

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

6992

"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.

6993

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

6994

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

6995

#

6996

# The key must meet the following requirements before you can provide it to Compute Engine:

6997

# - The key is wrapped using a RSA public key certificate provided by Google.

6998

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

6999

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

7000

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

7001

},

7002

"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.

7003

#

7004

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

7005

# global/snapshots/my-backup

7006

#

7007

#

7008

# If the source snapshot is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

7009

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7010

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

7011

"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.

7012

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

7013

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

7014

#

7015

# The key must meet the following requirements before you can provide it to Compute Engine:

7016

# - The key is wrapped using a RSA public key certificate provided by Google.

7017

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

7018

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

7019

"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]

7020

},

7021

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7022

"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.

7023

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

7024

"licenses": [ # [Output Only] Any valid publicly visible licenses.

7025

"A String",

7026

],

7027

"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.

7028

"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.

7029

"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

7030

"dbs": [ # The Key Database (db).

7031

{

7032

"content": "A String", # The raw content in the secure keys file.

7033

"fileType": "A String", # The file type of source file.

7034

},

7035

],

7036

"dbxs": [ # The forbidden key database (dbx).

7037

{

7038

"content": "A String", # The raw content in the secure keys file.

7039

"fileType": "A String", # The file type of source file.

7040

},

7041

],

7042

"keks": [ # The Key Exchange Key (KEK).

7043

{

7044

"content": "A String", # The raw content in the secure keys file.

7045

"fileType": "A String", # The file type of source file.

7046

},

7047

],

7048

"pk": { # The Platform Key (PK).

7049

"content": "A String", # The raw content in the secure keys file.

7050

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7051

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7052

},

7053

"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]

7054

#

7055

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

7056

#

7057

# 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]

7058

"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]

7059

"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.

7060

"A String",

7061

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7062

},

7063

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7064

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

7065

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7066

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7067

"eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.

7068

"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.

7069

#

7070

# To see the latest fingerprint, make get() request to the instance.

7071

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

7072

{ # A specification of the type and number of accelerator cards attached to the instance.

7073

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

7074

"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.

7075

},

7076

],

7077

"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.

7078

"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]

7079

"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]

7080

#

7081

# 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.

7082

#

7083

# 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.

7084

#

7085

# 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.

7086

#

7087

# 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.

7088

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

7089

"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.

7090

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

7091

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

7092

#

7093

# The key must meet the following requirements before you can provide it to Compute Engine:

7094

# - The key is wrapped using a RSA public key certificate provided by Google.

7095

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

7096

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

7097

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

7098

},

7099

"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.

7100

"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.

7101

#

7102

# To see the latest fingerprint, make get() request to the instance.

7103

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

7104

"a_key": "A String",

7105

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

7106

"lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format.

7107

"lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format.

7108

"lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7109

"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:

7110

# zones/us-central1-f/machineTypes/n1-standard-1

7111

#

7112

#

7113

# 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):

7114

# zones/zone/machineTypes/custom-CPUS-MEMORY

7115

#

7116

#

7117

# For example: zones/us-central1-f/machineTypes/custom-4-5120

7118

#

7119

# For a full list of restrictions, read the Specifications for custom machine types.

7120

"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

7121

"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.

7122

#

7123

# To see the latest fingerprint, make a get() request to retrieve the resource.

7124

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

7125

{

7126

"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.

7127

"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).

7128

},

7129

],

7130

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

7131

},

7132

"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".

7133

"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.

7134

"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.

7135

{ # A network interface resource attached to an instance.

7136

"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.

7137

{ # 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]

7138

"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.

7139

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7140

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

7141

"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.

7142

"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.

7143

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

7144

#

7145

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

7146

#

7147

# 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.

7148

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

7149

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

7150

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

7151

"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.

7152

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

7153

},

7154

],

7155

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

7156

{ # An alias IP range attached to an instance's network interface.

7157

"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).

7158

"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.

7159

},

7160

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

7161

"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. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

7162

"internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range.

7163

"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.

7164

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

7165

"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.

7166

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

7167

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

7168

"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.

7169

"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.

7170

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

7171

#

7172

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

7173

#

7174

# 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.

7175

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

7176

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

7177

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

7178

"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.

7179

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

7180

},

7181

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

7182

"ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork.

7183

#

7184

# Valid only if stackType is IPV4_IPV6.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7185

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

7186

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

7187

"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.

7188

"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.

7189

#

7190

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

7191

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

7192

# - projects/project/global/networks/network

7193

# - global/networks/default

7194

"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]

7195

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

7196

"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.

7197

"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.

7198

#

7199

# This field can be both set at instance creation and update network interface operations.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

7200

"subinterfaces": [ # SubInterfaces help enable L2 communication for the instance over subnetworks that support L2. Every network interface will get a default untagged (vlan not specified) subinterface. Users can specify additional tagged subinterfaces which are sub-fields to the Network Interface.

7201

{

7202

"ipAddress": "A String", # An IPv4 internal IP address to assign to the instance for this subinterface.

7203

"subnetwork": "A String", # If specified, this subnetwork must belong to the same network as that of the network interface. If not specified the subnet of network interface will be used. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:

7204

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

7205

# - regions/region/subnetworks/subnetwork

7206

"vlan": 42, # VLAN tag. Should match the VLAN(s) supported by the subnetwork to which this subinterface is connecting.

7207

},

7208

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7209

"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:

7210

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

7211

# - regions/region/subnetworks/subnetwork

7212

},

7213

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

7214

"networkPerformanceConfig": {

7215

"externalIpEgressBandwidthTier": "A String",

7216

"totalEgressBandwidthTier": "A String",

7217

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

7218

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7219

"preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api.

7220

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.

7221

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.

7222

"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.

7223

"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.

7224

"values": [ # Corresponds to the label values of a reservation resource.

"A String",

],

},

"resourcePolicies": [ # Resource policies applied to this instance.

7229

"A String",

7230

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

7231

"resourceStatus": { # Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls. # [Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field.

7232

"scheduling": {

7233

"availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.

7234

},

7235

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

7236

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

7237

"scheduling": { # Sets the scheduling options for an Instance. NextID: 20 # Sets the scheduling options for this instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7238

"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.

7239

#

7240

# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

7241

"availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7242

"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.

7243

"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]

7244

"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]

7245

"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.

7246

#

7247

# See go/stable-fleet-ug for more details.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7248

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

7249

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

7250

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

7251

"key": "A String", # Corresponds to the label key of Node resource.

7252

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

7253

"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]

7259

"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]

7260

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

7261

"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.

7262

"A String",

7263

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

7264

"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.

7265

"A String",

7266

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7267

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

7268

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

7269

"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

7270

#

7271

# 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.

7272

{ # A service account.

7273

"email": "A String", # Email address of the service account.

7274

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

7280

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

7281

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

7282

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

7283

},

7284

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

7285

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

7286

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

7287

"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]

7288

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

7289

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

7290

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

7291

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

7292

"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]

7293

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

7294

},

7295

"sourceMachineImage": "A String", # Source machine image

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

7296

"sourceMachineImageEncryptionKey": { # Source machine image encryption key when creating an instance from a machine image.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7297

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

7298

"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.

7299

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

7300

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

7301

#

7302

# The key must meet the following requirements before you can provide it to Compute Engine:

7303

# - The key is wrapped using a RSA public key certificate provided by Google.

7304

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

7305

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

7306

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

7307

},

7308

"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]

7309

"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]

7310

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

7311

"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.

7312

"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.

7313

#

7314

# To see the latest fingerprint, make get() request to the instance.

7315

"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]

7320

"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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

7321

"startTimeWindow": { # Represents a window of time using two timestamps: `earliest` and `latest`. This timestamp values are in RFC3339 text format. # [Output Only] The start time window of the maintenance disruption.

7322

"earliest": "A String",

7323

"latest": "A String",

7324

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

7325

"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]

7326

"type": "A String", # Defines the type of maintenance.

7327

},

7328

"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]

7329

}

7330

7331

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]

7337

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]

7343

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.

7344

7345

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.

7346

7347

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]

7348

7349

Returns:

7350

An object of the form:

7351

7352

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7353

#

7354

# Google Compute Engine has three Operation resources:

7355

#

7356

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

7357

#

7358

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

7359

#

7360

# Operations can be global, regional or zonal.

7361

# - For global operations, use the `globalOperations` resource.

7362

# - For regional operations, use the `regionOperations` resource.

7363

# - For zonal operations, use the `zonalOperations` resource.

7364

#

7365

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

7366

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

7367

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

7368

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

7369

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

7370

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

7371

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7372

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7373

"code": "A String", # [Output Only] The error type identifier for this error.

7374

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

7375

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7376

},

7377

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7378

},

7379

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

7380

"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.

7381

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

7382

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

7383

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

7384

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

7385

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7386

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

7387

"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.

7388

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

7389

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

7390

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

7391

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

7392

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

7393

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

7394

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

7395

"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.

7396

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

7397

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

7398

{

7399

"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.

7400

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

7401

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

7402

{

7403

"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).

7404

"value": "A String", # [Output Only] A warning data value corresponding to the key.

7405

},

7406

],

7407

"message": "A String", # [Output Only] A human-readable description of the warning code.

7408

},

7409

],

7410

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

7411

}</pre>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

</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]

7416

<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]

7417

7418

Args:

7419

project: string, Project ID for this request. (required)

7420

zone: string, The name of the zone for this request. (required)

7421

instance: string, The instance name for this request. (required)

7422

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]

7423

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

7424

The object takes the form of:

7425

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7426

{ # 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]

7427

"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.

7428

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7429

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

7430

"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.

7431

"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.

7432

"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]

7433

#

7434

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

7435

#

7436

# 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]

7437

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

7438

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

7439

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

7440

"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.

7441

"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]

7442

}

7443

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7444

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.

7445

7446

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.

7447

7448

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]

7449

7450

Returns:

7451

An object of the form:

7452

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7453

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7454

#

7455

# Google Compute Engine has three Operation resources:

7456

#

7457

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

7458

#

7459

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

7460

#

7461

# Operations can be global, regional or zonal.

7462

# - For global operations, use the `globalOperations` resource.

7463

# - For regional operations, use the `regionOperations` resource.

7464

# - For zonal operations, use the `zonalOperations` resource.

7465

#

7466

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

7467

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

7468

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

7469

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

7470

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

7471

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

7472

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7473

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7474

"code": "A String", # [Output Only] The error type identifier for this error.

7475

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

7476

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7477

},

7478

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7479

},

7480

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

7481

"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.

7482

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

7483

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

7484

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

7485

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

7486

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7487

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

7488

"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.

7489

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

7490

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

7491

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

7492

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

7493

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

7494

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

7495

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

7496

"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.

7497

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

7498

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

7499

{

7500

"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.

7501

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

7502

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

7503

{

7504

"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).

7505

"value": "A String", # [Output Only] A warning data value corresponding to the key.

7506

},

7507

],

7508

"message": "A String", # [Output Only] A human-readable description of the warning code.

7509

},

7510

],

7511

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

7512

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7516

<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]

7517

<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.

7518

7519

Args:

7520

project: string, Project ID for this request. (required)

7521

zone: string, The name of the zone for this request. (required)

7522

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7523

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7524

The object takes the form of:

7525

7526

{ # A set of Display Device options

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7527

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7528

}

7529

7530

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.

7531

7532

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.

7533

7534

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

7535

7536

Returns:

7537

An object of the form:

7538

7539

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7540

#

7541

# Google Compute Engine has three Operation resources:

7542

#

7543

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

7544

#

7545

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

7546

#

7547

# Operations can be global, regional or zonal.

7548

# - For global operations, use the `globalOperations` resource.

7549

# - For regional operations, use the `regionOperations` resource.

7550

# - For zonal operations, use the `zonalOperations` resource.

7551

#

7552

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

7553

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

7554

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

7555

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

7556

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

7557

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

7558

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7559

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7560

"code": "A String", # [Output Only] The error type identifier for this error.

7561

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

7562

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7563

},

7564

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7565

},

7566

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

7567

"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.

7568

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

7569

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

7570

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

7571

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

7572

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7573

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

7574

"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.

7575

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

7576

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

7577

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

7578

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

7579

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

7580

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

7581

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

7582

"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.

7583

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

7584

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

7585

{

7586

"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.

7587

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

7588

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

7589

{

7590

"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).

7591

"value": "A String", # [Output Only] A warning data value corresponding to the key.

7592

},

7593

],

7594

"message": "A String", # [Output Only] A human-readable description of the warning code.

7595

},

7596

],

7597

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

7598

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

7599

</div>

7600

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

7601

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7602

<code class="details" id="updateNetworkInterface">updateNetworkInterface(project, zone, instance, networkInterface, body=None, requestId=None)</code>

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

7603

<pre>Updates an instance's network interface. This method can only update an interface's alias IP range and attached network. See Modifying alias IP ranges for an existing instance for instructions on changing alias IP ranges. See Migrating a VM between networks for instructions on migrating an interface. This method follows PATCH semantics.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

7604

7605

Args:

7606

project: string, Project ID for this request. (required)

7607

zone: string, The name of the zone for this request. (required)

7608

instance: string, The instance name for this request. (required)

7609

networkInterface: string, The name of the network interface to update. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7610

body: object, The request body.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

7611

The object takes the form of:

7612

7613

{ # A network interface resource attached to an instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7614

"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.

7615

{ # 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]

7616

"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.

7617

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7618

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

7619

"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.

7620

"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.

7621

"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]

7622

#

7623

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

7624

#

7625

# 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]

7626

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

7627

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

7628

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

7629

"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.

7630

"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]

7631

},

7632

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7633

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

7634

{ # An alias IP range attached to an instance's network interface.

7635

"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).

7636

"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.

7637

},

7638

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

7639

"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. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

7640

"internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range.

7641

"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.

7642

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

7643

"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.

7644

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

7645

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

7646

"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.

7647

"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.

7648

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

7649

#

7650

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

7651

#

7652

# 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.

7653

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

7654

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

7655

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

7656

"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.

7657

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

7658

},

7659

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

7660

"ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork.

7661

#

7662

# Valid only if stackType is IPV4_IPV6.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7663

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

7664

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

7665

"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.

7666

"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]

7667

#

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

7668

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

7669

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

7670

# - projects/project/global/networks/network

7671

# - global/networks/default

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7672

"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]

7673

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

7674

"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.

7675

"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.

7676

#

7677

# This field can be both set at instance creation and update network interface operations.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

7678

"subinterfaces": [ # SubInterfaces help enable L2 communication for the instance over subnetworks that support L2. Every network interface will get a default untagged (vlan not specified) subinterface. Users can specify additional tagged subinterfaces which are sub-fields to the Network Interface.

7679

{

7680

"ipAddress": "A String", # An IPv4 internal IP address to assign to the instance for this subinterface.

7681

"subnetwork": "A String", # If specified, this subnetwork must belong to the same network as that of the network interface. If not specified the subnet of network interface will be used. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:

7682

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

7683

# - regions/region/subnetworks/subnetwork

7684

"vlan": 42, # VLAN tag. Should match the VLAN(s) supported by the subnetwork to which this subinterface is connecting.

7685

},

7686

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7687

"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:

7688

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

7689

# - regions/region/subnetworks/subnetwork

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

7690

}

7691

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7692

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.

7693

7694

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.

7695

7696

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]

7697

7698

Returns:

7699

An object of the form:

7700

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7701

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7702

#

7703

# Google Compute Engine has three Operation resources:

7704

#

7705

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

7706

#

7707

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

7708

#

7709

# Operations can be global, regional or zonal.

7710

# - For global operations, use the `globalOperations` resource.

7711

# - For regional operations, use the `regionOperations` resource.

7712

# - For zonal operations, use the `zonalOperations` resource.

7713

#

7714

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

7715

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

7716

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

7717

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

7718

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

7719

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

7720

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7721

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7722

"code": "A String", # [Output Only] The error type identifier for this error.

7723

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

7724

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7725

},

7726

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7727

},

7728

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

7729

"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.

7730

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

7731

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

7732

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

7733

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

7734

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7735

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

7736

"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.

7737

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

7738

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

7739

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

7740

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

7741

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

7742

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

7743

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

7744

"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.

7745

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

7746

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

7747

{

7748

"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.

7749

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

7750

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

7751

{

7752

"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).

7753

"value": "A String", # [Output Only] A warning data value corresponding to the key.

7754

},

7755

],

7756

"message": "A String", # [Output Only] A human-readable description of the warning code.

7757

},

7758

],

7759

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

7760

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7764

<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]

7765

<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.

7766

7767

Args:

7768

project: string, Project ID for this request. (required)

7769

zone: string, The name of the zone for this request. (required)

7770

instance: string, Name or id of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7771

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7772

The object takes the form of:

7773

7774

{ # A set of Shielded Instance options.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7775

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

7776

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

7777

"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]

7778

}

7779

7780

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.

7781

7782

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.

7783

7784

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

7785

7786

Returns:

7787

An object of the form:

7788

7789

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7790

#

7791

# Google Compute Engine has three Operation resources:

7792

#

7793

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

7794

#

7795

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

7796

#

7797

# Operations can be global, regional or zonal.

7798

# - For global operations, use the `globalOperations` resource.

7799

# - For regional operations, use the `regionOperations` resource.

7800

# - For zonal operations, use the `zonalOperations` resource.

7801

#

7802

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

7803

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

7804

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

7805

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

7806

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

7807

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

7808

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7809

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7810

"code": "A String", # [Output Only] The error type identifier for this error.

7811

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

7812

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7813

},

7814

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7815

},

7816

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

7817

"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.

7818

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

7819

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

7820

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

7821

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

7822

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7823

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

7824

"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.

7825

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

7826

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

7827

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

7828

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

7829

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

7830

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

7831

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

7832

"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.

7833

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

7834

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

7835

{

7836

"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.

7837

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

7838

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

7839

{

7840

"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).

7841

"value": "A String", # [Output Only] A warning data value corresponding to the key.

7842

},

7843

],

7844

"message": "A String", # [Output Only] A human-readable description of the warning code.

7845

},

7846

],

7847

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

7848

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7852

<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]

7853

<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.

7854

7855

Args:

7856

project: string, Project ID for this request. (required)

7857

zone: string, The name of the zone for this request. (required)

7858

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7859

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7860

The object takes the form of:

7861

7862

{ # A set of Shielded VM options.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7863

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

7864

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

7865

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7866

}

7867

7868

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.

7869

7870

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.

7871

7872

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

7873

7874

Returns:

7875

An object of the form:

7876

7877

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7878

#

7879

# Google Compute Engine has three Operation resources:

7880

#

7881

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

7882

#

7883

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

7884

#

7885

# Operations can be global, regional or zonal.

7886

# - For global operations, use the `globalOperations` resource.

7887

# - For regional operations, use the `regionOperations` resource.

7888

# - For zonal operations, use the `zonalOperations` resource.

7889

#

7890

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

7891

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

7892

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

7893

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

7894

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

7895

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

7896

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7897

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7898

"code": "A String", # [Output Only] The error type identifier for this error.

7899

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

7900

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7901

},

7902

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7903

},

7904

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

7905

"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.

7906

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

7907

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

7908

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

7909

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

7910

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot