1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.imageFamilyViews.html">imageFamilyViews</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(project, zone, family, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the latest image that is part of an image family, is not</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(project, zone, family, x__xgafv=None)</code>
<pre>Returns the latest image that is part of an image family, is not
deprecated and is rolled out in the specified zone.
Args:
project: string, Project ID for this request. (required)
zone: string, The name of the zone for this request. (required)
family: string, Name of the image family to search for. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"image": { # Represents an Image resource. # The latest image that is part of the specified image family in the
# requested location, and that is not deprecated.
#
# You can use images to create boot disks for your VM instances.
# For more information, read Images.
"architecture": "A String", # The architecture of the image. Valid values are
# ARM64 or X86_64.
"archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud
# Storage (in bytes).
"creationTimestamp": "A String", # [Output Only] Creation timestamp inRFC3339
# text format.
"deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image.
"deleted": "A String", # An optional RFC3339 timestamp on or after which the state of this
# resource is intended to change to DELETED. This is only
# informational and the status will not change unless the client explicitly
# changes it.
"deprecated": "A String", # An optional RFC3339 timestamp on or after which the state of this
# resource is intended to change to DEPRECATED. This is only
# informational and the status will not change unless the client explicitly
# changes it.
"obsolete": "A String", # An optional RFC3339 timestamp on or after which the state of this
# resource is intended to change to OBSOLETE. This is only
# informational and the status will not change unless the client explicitly
# changes it.
"replacement": "A String", # The URL of the suggested replacement for a deprecated resource.
# The suggested replacement resource must be the same kind of resource as the
# deprecated resource.
"state": "A String", # The deprecation state of this resource. This can be ACTIVE,DEPRECATED, OBSOLETE, or DELETED.
# Operations which communicate the end of life date for an image, can useACTIVE. Operations which create a new resource using aDEPRECATED resource will return successfully, but with a
# warning indicating the deprecated resource and recommending its
# replacement. Operations which use OBSOLETE orDELETED resources will be rejected and result in an error.
},
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
"diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).
"enableConfidentialCompute": True or False, # Whether this image is created from a confidential compute mode disk.
# [Output Only]: This field is not set by user, but from source disk.
"family": "A String", # The name of the image family to which this image belongs. The image
# family name can be from a publicly managed image family provided by
# Compute Engine, or from a custom image family you create. For example,centos-stream-9 is a publicly available image family.
# For more information, see Image
# family best practices.
#
# When creating disks, you can specify an image family instead of a specific
# image name. The image family always returns its latest image that is not
# deprecated. The name of the image family must comply with RFC1035.
"guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
# only for bootable images. To see a list of available options, see theguestOSfeatures[].type parameter.
{ # Guest OS features.
"type": "A String", # The ID of a supported feature. To add multiple values, use commas to
# separate values. Set to one or more of the following values:
#
# - VIRTIO_SCSI_MULTIQUEUE
# - WINDOWS
# - MULTI_IP_SUBNET
# - UEFI_COMPATIBLE
# - GVNIC
# - SEV_CAPABLE
# - SUSPEND_RESUME_COMPATIBLE
# - SEV_LIVE_MIGRATABLE_V2
# - SEV_SNP_CAPABLE
# - TDX_CAPABLE
# - IDPF
# - SNP_SVSM_CAPABLE
#
#
# For more information, see
# Enabling guest operating system features.
},
],
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
"imageEncryptionKey": { # Encrypts the image using acustomer-supplied
# encryption key.
#
# After you encrypt an image with a customer-supplied key, you must provide
# the same key if you use the image later (e.g. to create a disk from
# the image).
#
# Customer-supplied encryption keys do not protect access to metadata
# of the disk.
#
# If you do not provide an encryption key when creating the image, then the
# disk will be encrypted using an automatically generated key and you do not
# need to provide a key to use the image later.
"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
# For example:
#
# "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
# key_region/cryptoKeys/key
#
# The fully-qualifed key name may be returned for resource GET requests. For
# example:
#
# "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
# key_region/cryptoKeys/key
# /cryptoKeyVersions/1
"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.
# For example:
#
# "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
"rawKey": "A String", # Specifies a 256-bit customer-supplied
# encryption key, encoded in RFC
# 4648 base64 to either encrypt or decrypt this resource. You can
# provide either the rawKey or thersaEncryptedKey.
# For example:
#
# "rawKey":
# "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
# customer-supplied encryption key to either encrypt or decrypt this
# resource. You can provide either the rawKey or thersaEncryptedKey.
# For example:
#
# "rsaEncryptedKey":
# "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
# z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
# D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
#
# The key must meet the following requirements before you can provide it to
# Compute Engine:
#
# 1. The key is wrapped using a RSA public key certificate provided by
# Google.
# 2. After being wrapped, the key must be encoded in RFC 4648 base64
# encoding.
#
# Gets the RSA public key certificate provided by Google at:
#
#
# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
"sha256": "A String", # [Output only] TheRFC
# 4648 base64 encoded SHA-256 hash of the customer-supplied
# encryption key that protects this resource.
},
"kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for
# images.
"labelFingerprint": "A String", # A fingerprint for the labels being applied to this image, which is
# essentially a hash of the labels 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,
# otherwise the request will fail with error412 conditionNotMet.
#
# To see the latest fingerprint, make a get() request to
# retrieve an image.
"labels": { # Labels to apply to this image. These can be later modified by
# the setLabels method.
"a_key": "A String",
},
"licenseCodes": [ # Integer license codes indicating which licenses are attached to this image.
"A String",
],
"licenses": [ # Any applicable license URI.
"A String",
],
"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 withRFC1035.
# 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.
"params": { # Additional image params. # Input only. [Input Only] Additional params passed with the request, but not persisted
# as part of resource payload.
"resourceManagerTags": { # Resource manager tags to be bound to the image. Tag keys and values have
# the same definition as resource
# manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and
# values are in the format `tagValues/456`. The field is ignored (both PUT &
# PATCH) when empty.
"a_key": "A String",
},
},
"rawDisk": { # The parameters of the raw disk image.
"containerType": "A String", # The format used to encode and transmit the block device, which should beTAR. This is just a container and transmission format and not
# a runtime format. Provided by the client when the disk image is created.
"sha1Checksum": "A String", # [Deprecated] This field is deprecated.
# An optional SHA1 checksum of the disk image before unpackaging provided
# by the client when the disk image is created.
"source": "A String", # The full Google Cloud Storage URL where the raw disk image archive is
# stored.
# The following are valid formats for the URL:
#
# - https://storage.googleapis.com/bucket_name/image_archive_name
# - https://storage.googleapis.com/bucket_name/folder_name/image_archive_name
#
#
#
# In order to create an image, you must provide the full or partial URL of
# one of the following:
#
# - The rawDisk.source URL
# - The sourceDisk URL
# - The sourceImage URL
# - The sourceSnapshot URL
},
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # [Output Only] Reserved for future use.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"shieldedInstanceInitialState": { # Initial State for shielded instance, # Set the secure boot keys of shielded instance.
# these are public keys which are safe to store in public
"dbs": [ # The Key Database (db).
{
"content": "A String", # The raw content in the secure keys file.
"fileType": "A String", # The file type of source file.
},
],
"dbxs": [ # The forbidden key database (dbx).
{
"content": "A String", # The raw content in the secure keys file.
"fileType": "A String", # The file type of source file.
},
],
"keks": [ # The Key Exchange Key (KEK).
{
"content": "A String", # The raw content in the secure keys file.
"fileType": "A String", # The file type of source file.
},
],
"pk": { # The Platform Key (PK).
"content": "A String", # The raw content in the secure keys file.
"fileType": "A String", # The file type of source file.
},
},
"sourceDisk": "A String", # URL of the source disk used to create this image.
# For example, the following are valid values:
#
# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
# - projects/project/zones/zone/disks/disk
# - zones/zone/disks/disk
#
#
#
# In order to create an image, you must provide the full or partial URL of
# one of the following:
#
# - The rawDisk.source URL
# - The sourceDisk URL
# - The sourceImage URL
# - The sourceSnapshot URL
"sourceDiskEncryptionKey": { # Thecustomer-supplied
# encryption key of the source disk. Required if the source disk is
# protected by a customer-supplied encryption key.
"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
# For example:
#
# "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
# key_region/cryptoKeys/key
#
# The fully-qualifed key name may be returned for resource GET requests. For
# example:
#
# "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
# key_region/cryptoKeys/key
# /cryptoKeyVersions/1
"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.
# For example:
#
# "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
"rawKey": "A String", # Specifies a 256-bit customer-supplied
# encryption key, encoded in RFC
# 4648 base64 to either encrypt or decrypt this resource. You can
# provide either the rawKey or thersaEncryptedKey.
# For example:
#
# "rawKey":
# "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
# customer-supplied encryption key to either encrypt or decrypt this
# resource. You can provide either the rawKey or thersaEncryptedKey.
# For example:
#
# "rsaEncryptedKey":
# "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
# z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
# D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
#
# The key must meet the following requirements before you can provide it to
# Compute Engine:
#
# 1. The key is wrapped using a RSA public key certificate provided by
# Google.
# 2. After being wrapped, the key must be encoded in RFC 4648 base64
# encoding.
#
# Gets the RSA public key certificate provided by Google at:
#
#
# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
"sha256": "A String", # [Output only] TheRFC
# 4648 base64 encoded SHA-256 hash of the customer-supplied
# encryption key that protects this resource.
},
"sourceDiskId": "A String", # [Output Only]
# The ID value of the disk used to create this image. This value may be used
# to determine whether the image was taken from the current or a previous
# instance of a given disk name.
"sourceImage": "A String", # URL of the source image used to create this image.
# The following are valid formats for the URL:
#
# - https://www.googleapis.com/compute/v1/projects/project_id/global/
# images/image_name
# - projects/project_id/global/images/image_name
#
#
#
# In order to create an image, you must provide the full or partial URL of
# one of the following:
#
# - The rawDisk.source URL
# - The sourceDisk URL
# - The sourceImage URL
# - The sourceSnapshot URL
"sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the
# source image is protected by a customer-supplied encryption key.
"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
# For example:
#
# "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
# key_region/cryptoKeys/key
#
# The fully-qualifed key name may be returned for resource GET requests. For
# example:
#
# "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
# key_region/cryptoKeys/key
# /cryptoKeyVersions/1
"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.
# For example:
#
# "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
"rawKey": "A String", # Specifies a 256-bit customer-supplied
# encryption key, encoded in RFC
# 4648 base64 to either encrypt or decrypt this resource. You can
# provide either the rawKey or thersaEncryptedKey.
# For example:
#
# "rawKey":
# "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
# customer-supplied encryption key to either encrypt or decrypt this
# resource. You can provide either the rawKey or thersaEncryptedKey.
# For example:
#
# "rsaEncryptedKey":
# "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
# z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
# D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
#
# The key must meet the following requirements before you can provide it to
# Compute Engine:
#
# 1. The key is wrapped using a RSA public key certificate provided by
# Google.
# 2. After being wrapped, the key must be encoded in RFC 4648 base64
# encoding.
#
# Gets the RSA public key certificate provided by Google at:
#
#
# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
"sha256": "A String", # [Output only] TheRFC
# 4648 base64 encoded SHA-256 hash of the customer-supplied
# encryption key that protects this resource.
},
"sourceImageId": "A String", # [Output Only]
# The ID value of the image used to create this image. This value may be used
# to determine whether the image was taken from the current or a previous
# instance of a given image name.
"sourceSnapshot": "A String", # URL of the source snapshot used to create this image.
# The following are valid formats for the URL:
#
# - https://www.googleapis.com/compute/v1/projects/project_id/global/
# snapshots/snapshot_name
# - projects/project_id/global/snapshots/snapshot_name
#
#
#
# In order to create an image, you must provide the full or partial URL of
# one of the following:
#
# - The rawDisk.source URL
# - The sourceDisk URL
# - The sourceImage URL
# - The sourceSnapshot URL
"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot. Required if
# the source snapshot is protected by a customer-supplied encryption key.
"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
# For example:
#
# "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
# key_region/cryptoKeys/key
#
# The fully-qualifed key name may be returned for resource GET requests. For
# example:
#
# "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
# key_region/cryptoKeys/key
# /cryptoKeyVersions/1
"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.
# For example:
#
# "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
"rawKey": "A String", # Specifies a 256-bit customer-supplied
# encryption key, encoded in RFC
# 4648 base64 to either encrypt or decrypt this resource. You can
# provide either the rawKey or thersaEncryptedKey.
# For example:
#
# "rawKey":
# "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
# customer-supplied encryption key to either encrypt or decrypt this
# resource. You can provide either the rawKey or thersaEncryptedKey.
# For example:
#
# "rsaEncryptedKey":
# "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
# z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
# D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
#
# The key must meet the following requirements before you can provide it to
# Compute Engine:
#
# 1. The key is wrapped using a RSA public key certificate provided by
# Google.
# 2. After being wrapped, the key must be encoded in RFC 4648 base64
# encoding.
#
# Gets the RSA public key certificate provided by Google at:
#
#
# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
"sha256": "A String", # [Output only] TheRFC
# 4648 base64 encoded SHA-256 hash of the customer-supplied
# encryption key that protects this resource.
},
"sourceSnapshotId": "A String", # [Output Only]
# The ID value of the snapshot used to create this image. This value may be
# used to determine whether the snapshot was taken from the current or a
# previous instance of a given snapshot name.
"sourceType": "RAW", # The type of the image used to create this disk. The
# default and only valid value is RAW.
"status": "A String", # [Output Only] The status of the image. An image can be used to create other
# resources, such as instances, only after the image has been successfully
# created and the status is set to READY. Possible
# values are FAILED, PENDING, orREADY.
"storageLocations": [ # Cloud Storage bucket storage location of the image (regional or
# multi-regional).
"A String",
],
},
}</pre>
</div>
</body></html>
|
