Compute Cloud API, gRPC: DiskService.Create
Creates a disk in the specified folder.
You can create an empty disk or restore it from a snapshot or an image.
Method starts an asynchronous operation that can be cancelled while it is in progress.
gRPC request
rpc Create (CreateDiskRequest) returns (operation.Operation)
CreateDiskRequest
{
"folder_id": "string",
"name": "string",
"description": "string",
"labels": "map<string, string>",
"type_id": "string",
"zone_id": "string",
"size": "int64",
// Includes only one of the fields `image_id`, `snapshot_id`
"image_id": "string",
"snapshot_id": "string",
// end of the list of possible fields
"block_size": "int64",
"disk_placement_policy": {
"placement_group_id": "string",
"placement_group_partition": "int64"
},
"snapshot_schedule_ids": [
"string"
],
"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_id": "string"
}
|
Field |
Description |
|
folder_id |
string Required field. ID of the folder to create a disk in. |
|
name |
string Name of the disk. |
|
description |
string Description of the disk. |
|
labels |
object (map<string, string>) Resource labels as |
|
type_id |
string ID of the disk type. |
|
zone_id |
string Required field. ID of the availability zone where the disk resides. |
|
size |
int64 Required field. Size of the disk, specified in bytes. |
|
image_id |
string ID of the image to create the disk from. Includes only one of the fields |
|
snapshot_id |
string ID of the snapshot to restore the disk from. Includes only one of the fields |
|
block_size |
int64 Block size used for disk, specified in bytes. The default is 4096. |
|
disk_placement_policy |
Placement policy configuration. |
|
snapshot_schedule_ids[] |
string List of IDs of the snapshot schedules to attach the disk to. |
|
hardware_generation |
Specify the overrides to hardware_generation of a source disk, image or snapshot, |
|
kms_key_id |
string ID of KMS key for disk encryption. |
DiskPlacementPolicy
|
Field |
Description |
|
placement_group_id |
string Placement group ID. |
|
placement_group_partition |
int64 |
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": {
"disk_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>",
"type_id": "string",
"zone_id": "string",
"size": "int64",
"block_size": "int64",
"product_ids": [
"string"
],
"status": "Status",
// Includes only one of the fields `source_image_id`, `source_snapshot_id`
"source_image_id": "string",
"source_snapshot_id": "string",
// end of the list of possible fields
"instance_ids": [
"string"
],
"disk_placement_policy": {
"placement_group_id": "string",
"placement_group_partition": "int64"
},
"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. |
CreateDiskMetadata
|
Field |
Description |
|
disk_id |
string ID of the disk that is being created. |
Disk
A Disk resource. For more information, see Disks.
|
Field |
Description |
|
id |
string ID of the disk. |
|
folder_id |
string ID of the folder that the disk belongs to. |
|
created_at |
|
|
name |
string Name of the disk. 1-63 characters long. |
|
description |
string Description of the disk. 0-256 characters long. |
|
labels |
object (map<string, string>) Resource labels as |
|
type_id |
string ID of the disk type. |
|
zone_id |
string ID of the availability zone where the disk resides. |
|
size |
int64 Size of the disk, specified in bytes. |
|
block_size |
int64 Block size of the disk, specified in bytes. |
|
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 disk.
|
|
source_image_id |
string ID of the image that was used for disk creation. Includes only one of the fields |
|
source_snapshot_id |
string ID of the snapshot that was used for disk creation. Includes only one of the fields |
|
instance_ids[] |
string Array of instances to which the disk is attached. |
|
disk_placement_policy |
Placement policy configuration. |
|
hardware_generation |
If specified, forces the same HardwareGeneration features to be applied to the instance |
|
kms_key |
Key encryption key info. |
DiskPlacementPolicy
|
Field |
Description |
|
placement_group_id |
string Placement group ID. |
|
placement_group_partition |
int64 |
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 |