Insert
|
|||||
|
|
Creates a persistent disk in the specified project using the data in the request. You can create a disk with a sourceImage, a sourceSnapshot, or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your data across Google Cloud Platform services
- View and manage your Google Compute Engine resources
Input
This building block consumes 45 input parameters
Name | Format | Description |
---|---|---|
project Required |
STRING |
Project ID for this request |
zone Required |
STRING |
The name of the zone for this request |
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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000) |
sourceImage |
STRING |
Optional. Source image to restore onto a disk |
creationTimestamp |
STRING |
[Output Only] Creation timestamp in RFC3339 text format |
description |
STRING |
An optional description of this resource. Provide this property when you create the resource |
diskEncryptionKey |
OBJECT |
Represents a customer-supplied encryption key |
diskEncryptionKey.kmsKeyName |
STRING |
The name of the encryption key that is stored in Google Cloud KMS |
diskEncryptionKey.rawKey |
STRING |
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource |
diskEncryptionKey.sha256 |
STRING |
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource |
guestOsFeatures[] |
OBJECT |
Guest OS features |
guestOsFeatures[].type |
ENUMERATION |
The ID of a supported feature. Read Enabling guest operating system features to see a list of available options |
id |
INTEGER |
[Output Only] The unique identifier for the resource. This identifier is defined by the server |
kind |
STRING |
[Output Only] Type of the resource. Always compute#disk for disks |
labelFingerprint |
BINARY |
A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set 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 error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a disk |
labels |
OBJECT |
Labels to apply to this disk. These can be later modified by the setLabels method |
labels.customKey.value Required |
STRING |
Labels to apply to this disk. These can be later modified by the setLabels method |
lastAttachTimestamp |
STRING |
[Output Only] Last attach timestamp in RFC3339 text format |
lastDetachTimestamp |
STRING |
[Output Only] Last detach timestamp in RFC3339 text format |
licenseCodes[] |
INTEGER |
|
licenses[] |
STRING |
|
name |
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 |
options |
STRING |
Internal use only |
physicalBlockSizeBytes |
INTEGER |
Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. Currently supported sizes are 4096 and 16384, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project |
region |
STRING |
[Output Only] URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body |
replicaZones[] |
STRING |
|
resourcePolicies[] |
STRING |
|
selfLink |
STRING |
[Output Only] Server-defined fully-qualified URL for this resource |
sizeGb |
INTEGER |
Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk. If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot. Acceptable values are 1 to 65536, inclusive |
sourceImage |
STRING |
The source image used to create this disk. If the source image is deleted, this field will not be set. 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: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image 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: global/images/family/my-image-family |
sourceImageEncryptionKey |
OBJECT |
Represents a customer-supplied encryption key |
sourceImageEncryptionKey.kmsKeyName |
STRING |
The name of the encryption key that is stored in Google Cloud KMS |
sourceImageEncryptionKey.rawKey |
STRING |
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource |
sourceImageEncryptionKey.sha256 |
STRING |
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource |
sourceImageId |
STRING |
[Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used |
sourceSnapshot |
STRING |
The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
|
sourceSnapshotEncryptionKey |
OBJECT |
Represents a customer-supplied encryption key |
sourceSnapshotEncryptionKey.kmsKeyName |
STRING |
The name of the encryption key that is stored in Google Cloud KMS |
sourceSnapshotEncryptionKey.rawKey |
STRING |
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource |
sourceSnapshotEncryptionKey.sha256 |
STRING |
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource |
sourceSnapshotId |
STRING |
[Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used |
status |
ENUMERATION |
[Output Only] The status of disk creation |
type |
STRING |
URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd |
users[] |
STRING |
|
zone |
STRING |
[Output Only] URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body |
= Parameter name
= Format
project STRING Required Project ID for this request |
zone STRING Required The name of the zone for this request |
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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000) |
sourceImage STRING Optional. Source image to restore onto a disk |
creationTimestamp STRING [Output Only] Creation timestamp in RFC3339 text format |
description STRING An optional description of this resource. Provide this property when you create the resource |
diskEncryptionKey OBJECT Represents a customer-supplied encryption key |
diskEncryptionKey.kmsKeyName STRING The name of the encryption key that is stored in Google Cloud KMS |
diskEncryptionKey.rawKey STRING Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource |
diskEncryptionKey.sha256 STRING [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource |
guestOsFeatures[] OBJECT Guest OS features |
guestOsFeatures[].type ENUMERATION The ID of a supported feature. Read Enabling guest operating system features to see a list of available options |
id INTEGER [Output Only] The unique identifier for the resource. This identifier is defined by the server |
kind STRING [Output Only] Type of the resource. Always compute#disk for disks |
labelFingerprint BINARY A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set 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 error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a disk |
labels OBJECT Labels to apply to this disk. These can be later modified by the setLabels method |
labels.customKey.value STRING Required Labels to apply to this disk. These can be later modified by the setLabels method |
lastAttachTimestamp STRING [Output Only] Last attach timestamp in RFC3339 text format |
lastDetachTimestamp STRING [Output Only] Last detach timestamp in RFC3339 text format |
licenseCodes[] INTEGER |
licenses[] STRING |
name 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 |
options STRING Internal use only |
physicalBlockSizeBytes INTEGER Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. Currently supported sizes are 4096 and 16384, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project |
region STRING [Output Only] URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body |
replicaZones[] STRING |
resourcePolicies[] STRING |
selfLink STRING [Output Only] Server-defined fully-qualified URL for this resource |
sizeGb INTEGER Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk. If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot. Acceptable values are 1 to 65536, inclusive |
sourceImage STRING The source image used to create this disk. If the source image is deleted, this field will not be set. 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: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image 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: global/images/family/my-image-family |
sourceImageEncryptionKey OBJECT Represents a customer-supplied encryption key |
sourceImageEncryptionKey.kmsKeyName STRING The name of the encryption key that is stored in Google Cloud KMS |
sourceImageEncryptionKey.rawKey STRING Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource |
sourceImageEncryptionKey.sha256 STRING [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource |
sourceImageId STRING [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used |
sourceSnapshot STRING The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
|
sourceSnapshotEncryptionKey OBJECT Represents a customer-supplied encryption key |
sourceSnapshotEncryptionKey.kmsKeyName STRING The name of the encryption key that is stored in Google Cloud KMS |
sourceSnapshotEncryptionKey.rawKey STRING Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource |
sourceSnapshotEncryptionKey.sha256 STRING [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource |
sourceSnapshotId STRING [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used |
status ENUMERATION [Output Only] The status of disk creation |
type STRING URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd |
users[] STRING |
zone STRING [Output Only] URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body |
Output
This building block provides 32 output parameters
Name | Format | Description |
---|---|---|
clientOperationId |
STRING |
[Output Only] The value of |
creationTimestamp |
STRING |
[Deprecated] This field is deprecated |
description |
STRING |
[Output Only] A textual description of the operation, which is set when the operation is created |
endTime |
STRING |
[Output Only] The time that this operation was completed. This value is in RFC3339 text format |
error |
OBJECT |
[Output Only] If errors are generated during processing of the operation, this field will be populated |
error.errors[] |
OBJECT |
|
error.errors[].code |
STRING |
[Output Only] The error type identifier for this error |
error.errors[].location |
STRING |
[Output Only] Indicates the field in the request that caused the error. This property is optional |
error.errors[].message |
STRING |
[Output Only] An optional, human-readable error message |
httpErrorMessage |
STRING |
[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND |
httpErrorStatusCode |
INTEGER |
[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 |
id |
INTEGER |
[Output Only] The unique identifier for the resource. This identifier is defined by the server |
insertTime |
STRING |
[Output Only] The time that this operation was requested. This value is in RFC3339 text format |
kind |
STRING |
[Output Only] Type of the resource. Always compute#operation for Operation resources |
name |
STRING |
[Output Only] Name of the resource |
operationType |
STRING |
[Output Only] The type of operation, such as insert, update, or delete, and so on |
progress |
INTEGER |
[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 |
region |
STRING |
[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations |
selfLink |
STRING |
[Output Only] Server-defined URL for the resource |
startTime |
STRING |
[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format |
status |
ENUMERATION |
[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE |
statusMessage |
STRING |
[Output Only] An optional textual description of the current status of the operation |
targetId |
INTEGER |
[Output Only] The unique target ID, which identifies a specific incarnation of the target resource |
targetLink |
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 |
user |
STRING |
[Output Only] User who requested the operation, for example: [email protected] |
warnings[] |
OBJECT |
|
warnings[].code |
ENUMERATION |
[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response |
warnings[].data[] |
OBJECT |
|
warnings[].data[].key |
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) |
warnings[].data[].value |
STRING |
[Output Only] A warning data value corresponding to the key |
warnings[].message |
STRING |
[Output Only] A human-readable description of the warning code |
zone |
STRING |
[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations |
= Parameter name
= Format
clientOperationId STRING [Output Only] The value of |
creationTimestamp STRING [Deprecated] This field is deprecated |
description STRING [Output Only] A textual description of the operation, which is set when the operation is created |
endTime STRING [Output Only] The time that this operation was completed. This value is in RFC3339 text format |
error OBJECT [Output Only] If errors are generated during processing of the operation, this field will be populated |
error.errors[] OBJECT |
error.errors[].code STRING [Output Only] The error type identifier for this error |
error.errors[].location STRING [Output Only] Indicates the field in the request that caused the error. This property is optional |
error.errors[].message STRING [Output Only] An optional, human-readable error message |
httpErrorMessage STRING [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND |
httpErrorStatusCode INTEGER [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 |
id INTEGER [Output Only] The unique identifier for the resource. This identifier is defined by the server |
insertTime STRING [Output Only] The time that this operation was requested. This value is in RFC3339 text format |
kind STRING [Output Only] Type of the resource. Always compute#operation for Operation resources |
name STRING [Output Only] Name of the resource |
operationType STRING [Output Only] The type of operation, such as insert, update, or delete, and so on |
progress INTEGER [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 |
region STRING [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations |
selfLink STRING [Output Only] Server-defined URL for the resource |
startTime STRING [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format |
status ENUMERATION [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE |
statusMessage STRING [Output Only] An optional textual description of the current status of the operation |
targetId INTEGER [Output Only] The unique target ID, which identifies a specific incarnation of the target resource |
targetLink 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 |
user STRING [Output Only] User who requested the operation, for example: [email protected] |
warnings[] OBJECT |
warnings[].code ENUMERATION [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response |
warnings[].data[] OBJECT |
warnings[].data[].key 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) |
warnings[].data[].value STRING [Output Only] A warning data value corresponding to the key |
warnings[].message STRING [Output Only] A human-readable description of the warning code |
zone STRING [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations |