Compute Cloud API, gRPC: ImageService.Create
Creates an image in the specified folder.
You can create an image from a disk, snapshot, other image or URI.
Method starts an asynchronous operation that can be cancelled while it is in progress.
gRPC request
rpc Create (CreateImageRequest) returns (operation.Operation)
CreateImageRequest
{
"folder_id": "string",
"name": "string",
"description": "string",
"labels": "map<string, string>",
"family": "string",
"min_disk_size": "int64",
"product_ids": [
"string"
],
// Includes only one of the fields `image_id`, `disk_id`, `snapshot_id`, `uri`
"image_id": "string",
"disk_id": "string",
"snapshot_id": "string",
"uri": "string",
// end of the list of possible fields
"os": {
"type": "Type"
},
"pooled": "bool",
"hardware_generation": {
// Includes only one of the fields `legacy_features`, `generation2_features`
"legacy_features": {
"pci_topology": "PCITopology"
},
"generation2_features": "Generation2HardwareFeatures"
// end of the list of possible fields
}
}
|
Field |
Description |
|
folder_id |
string Required field. ID of the folder to create an image in. |
|
name |
string Name of the image. |
|
description |
string Description of the image. |
|
labels |
object (map<string, string>) Resource labels as |
|
family |
string The name of the image family to which this image belongs. For more information, see Image family. To get an information about the most recent image from a family, use a ImageService.GetLatestByFamily request. |
|
min_disk_size |
int64 Minimum size of the disk that will be created from this image. |
|
product_ids[] |
string License IDs that indicate which licenses are attached to this resource. The correct license ID is generated by the platform. IDs are inherited by new resources created from this resource. If you know the license IDs, specify them when you create the image. |
|
image_id |
string ID of the source image to create the new image from. Includes only one of the fields |
|
disk_id |
string ID of the disk to create the image from. Includes only one of the fields |
|
snapshot_id |
string ID of the snapshot to create the image from. Includes only one of the fields |
|
uri |
string URI of the source image to create the new image from. Includes only one of the fields |
|
os |
Operating system that is contained in the image. If not specified and you used the |
|
pooled |
bool When true, an image pool will be created for fast creation disks from the image. |
|
hardware_generation |
Specify the overrides to hardware_generation of a source disk, image or snapshot, |
Os
|
Field |
Description |
|
type |
enum Type Operating system type. The default is This field is used to correctly emulate a vCPU and calculate the cost of using an instance.
|
HardwareGeneration
A set of features, specific to a particular Compute hardware generation.
They are not necessary supported by every host OS or distro, thus they are fixed to an image
and are applied to all instances created with it as their boot disk image.
These features significantly determine how the instance is created, thus cannot be changed after the fact.
|
Field |
Description |
|
legacy_features |
Includes only one of the fields |
|
generation2_features |
Includes only one of the fields |
LegacyHardwareFeatures
A first hardware generation, by default compatible with all legacy images.
Allows switching to PCI_TOPOLOGY_V2 and back.
|
Field |
Description |
|
pci_topology |
enum PCITopology
|
Generation2HardwareFeatures
A second hardware generation, which by default assumes PCI_TOPOLOGY_V2
and UEFI boot (with UEFI related features).
|
Field |
Description |
|
Empty |
|
operation.Operation
{
"id": "string",
"description": "string",
"created_at": "google.protobuf.Timestamp",
"created_by": "string",
"modified_at": "google.protobuf.Timestamp",
"done": "bool",
"metadata": {
"image_id": "string"
},
// Includes only one of the fields `error`, `response`
"error": "google.rpc.Status",
"response": {
"id": "string",
"folder_id": "string",
"created_at": "google.protobuf.Timestamp",
"name": "string",
"description": "string",
"labels": "map<string, string>",
"family": "string",
"storage_size": "int64",
"min_disk_size": "int64",
"product_ids": [
"string"
],
"status": "Status",
"os": {
"type": "Type"
},
"pooled": "bool",
"hardware_generation": {
// Includes only one of the fields `legacy_features`, `generation2_features`
"legacy_features": {
"pci_topology": "PCITopology"
},
"generation2_features": "Generation2HardwareFeatures"
// end of the list of possible fields
},
"kms_key": {
"key_id": "string",
"version_id": "string"
}
}
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
|
Field |
Description |
|
id |
string ID of the operation. |
|
description |
string Description of the operation. 0-256 characters long. |
|
created_at |
Creation timestamp. |
|
created_by |
string ID of the user or service account who initiated the operation. |
|
modified_at |
The time when the Operation resource was last modified. |
|
done |
bool If the value is |
|
metadata |
Service-specific metadata associated with the operation. |
|
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
|
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
CreateImageMetadata
|
Field |
Description |
|
image_id |
string ID of the image that is being created. |
Image
An Image resource.
|
Field |
Description |
|
id |
string ID of the image. |
|
folder_id |
string ID of the folder that the image belongs to. |
|
created_at |
|
|
name |
string Name of the image. 1-63 characters long. |
|
description |
string Description of the image. 0-256 characters long. |
|
labels |
object (map<string, string>) Resource labels as |
|
family |
string The name of the image family to which this image belongs. You can get the most recent image from a family by using |
|
storage_size |
int64 The size of the image, specified in bytes. |
|
min_disk_size |
int64 Minimum size of the disk which will be created from this image. |
|
product_ids[] |
string License IDs that indicate which licenses are attached to this resource. The correct license ID is generated by the platform. IDs are inherited by new resources created from this resource. If you know the license IDs, specify them when you create the image. |
|
status |
enum Status Current status of the image.
|
|
os |
Operating system that is contained in the image. |
|
pooled |
bool When true, indicates there is an image pool for fast creation disks from the image. |
|
hardware_generation |
If specified, forces the same HardwareGeneration features to be applied to the instance |
|
kms_key |
Key encryption key info. |
Os
|
Field |
Description |
|
type |
enum Type Operating system type. The default is This field is used to correctly emulate a vCPU and calculate the cost of using an instance.
|
HardwareGeneration
A set of features, specific to a particular Compute hardware generation.
They are not necessary supported by every host OS or distro, thus they are fixed to an image
and are applied to all instances created with it as their boot disk image.
These features significantly determine how the instance is created, thus cannot be changed after the fact.
|
Field |
Description |
|
legacy_features |
Includes only one of the fields |
|
generation2_features |
Includes only one of the fields |
LegacyHardwareFeatures
A first hardware generation, by default compatible with all legacy images.
Allows switching to PCI_TOPOLOGY_V2 and back.
|
Field |
Description |
|
pci_topology |
enum PCITopology
|
Generation2HardwareFeatures
A second hardware generation, which by default assumes PCI_TOPOLOGY_V2
and UEFI boot (with UEFI related features).
|
Field |
Description |
|
Empty |
|
KMSKey
|
Field |
Description |
|
key_id |
string ID of KMS symmetric key |
|
version_id |
string Version of KMS symmetric key |