Method: disks.get

Method: disks.get

HTTP request
Path parameters
Request body
Response body
- JSON representation
Authorization Scopes
IAM Permissions

Returns a specified persistent disk. Gets a list of available persistent disks by making a list() request.

HTTP request

GET https://compute.googleapis.com/compute/beta/projects/{project}/zones/{zone}/disks/{resourceId}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

Parameters
`project`	`string` Project ID for this request.
`zone`	`string` The name of the zone for this request.
`resourceId`	`string` Name of the persistent disk to return.

project

string

Project ID for this request.

zone

string

The name of the zone for this request.

resourceId

string

Name of the persistent disk to return.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

JSON representation
{ "id": string, "creationTimestamp": string, "name": string, "description": string, "sizeGb": string, "zone": string, "status": enum, "sourceSnapshot": string, "sourceSnapshotId": string, "options": string, "selfLink": string, "sourceImage": string, "sourceImageId": string, "storageType": enum, "type": string, "licenses": [ string ], "guestOsFeatures": [ { "type": enum } ], "lastAttachTimestamp": string, "lastDetachTimestamp": string, "users": [ string ], "diskEncryptionKey": { "rawKey": string, "rsaEncryptedKey": string, "kmsKeyName": string, "sha256": string, "kmsKeyServiceAccount": string }, "sourceImageEncryptionKey": { "rawKey": string, "rsaEncryptedKey": string, "kmsKeyName": string, "sha256": string, "kmsKeyServiceAccount": string }, "sourceSnapshotEncryptionKey": { "rawKey": string, "rsaEncryptedKey": string, "kmsKeyName": string, "sha256": string, "kmsKeyServiceAccount": string }, "labels": { string: string, ... }, "labelFingerprint": string, "region": string, "replicaZones": [ string ], "licenseCodes": [ string ], "physicalBlockSizeBytes": string, "resourcePolicies": [ string ], "eraseWindowsVssSignature": boolean, "kind": string }

JSON representation

{
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "sizeGb": string,
  "zone": string,
  "status": enum,
  "sourceSnapshot": string,
  "sourceSnapshotId": string,
  "options": string,
  "selfLink": string,
  "sourceImage": string,
  "sourceImageId": string,
  "storageType": enum,
  "type": string,
  "licenses": [
    string
  ],
  "guestOsFeatures": [
    {
      "type": enum
    }
  ],
  "lastAttachTimestamp": string,
  "lastDetachTimestamp": string,
  "users": [
    string
  ],
  "diskEncryptionKey": {
    "rawKey": string,
    "rsaEncryptedKey": string,
    "kmsKeyName": string,
    "sha256": string,
    "kmsKeyServiceAccount": string
  },
  "sourceImageEncryptionKey": {
    "rawKey": string,
    "rsaEncryptedKey": string,
    "kmsKeyName": string,
    "sha256": string,
    "kmsKeyServiceAccount": string
  },
  "sourceSnapshotEncryptionKey": {
    "rawKey": string,
    "rsaEncryptedKey": string,
    "kmsKeyName": string,
    "sha256": string,
    "kmsKeyServiceAccount": string
  },
  "labels": {
    string: string,
    ...
  },
  "labelFingerprint": string,
  "region": string,
  "replicaZones": [
    string
  ],
  "licenseCodes": [
    string
  ],
  "physicalBlockSizeBytes": string,
  "resourcePolicies": [
    string
  ],
  "eraseWindowsVssSignature": boolean,
  "kind": string
}

Fields
`id`	`string (fixed64 format)` [Output Only] The unique identifier for the resource. This identifier is defined by the server.
`creationTimestamp`	`string` [Output Only] Creation timestamp in RFC3339 text format.
`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 `[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.
`description`	`string` An optional description of this resource. Provide this property when you create the resource.
`sizeGb`	`string (int64 format)` 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.
`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.
`status`	`enum` [Output Only] The status of disk creation. CREATING: Disk is provisioning. RESTORING: Source data is being copied into the disk. FAILED: Disk creation failed. READY: Disk is ready for use. DELETING: Disk is deleting.
`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: `https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot` `projects/project/global/snapshots/snapshot` `global/snapshots/snapshot`
`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.
`options`	`string` Internal use only.
`selfLink`	`string` [Output Only] Server-defined fully-qualified URL for this resource.
`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`
`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.
`storageType`	`enum` [Deprecated] Storage type of the persistent disk.
`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`
`licenses[]`	`string` A list of publicly visible licenses. Reserved for Google's use.
`guestOsFeatures[]`	`object` 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.
`guestOsFeatures[].type`	`enum` The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.
`lastAttachTimestamp`	`string` [Output Only] Last attach timestamp in RFC3339 text format.
`lastDetachTimestamp`	`string` [Output Only] Last detach timestamp in RFC3339 text format.
`users[]`	`string` [Output Only] Links to the users of the disk (attached instances) in form: `projects/project/zones/zone/instances/instance`
`diskEncryptionKey`	`object` Encrypts the disk using a customer-supplied encryption key. After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot, to create a disk image, to create a machine image, or to attach the disk to a virtual machine). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the disk, 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.
`diskEncryptionKey.rawKey`	`string` Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
`diskEncryptionKey.rsaEncryptedKey`	`string` Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. The key must meet the following requirements before you can provide it to Compute Engine: The key is wrapped using a RSA public key certificate provided by Google. 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
`diskEncryptionKey.kmsKeyName`	`string` The name of the encryption key that is stored in Google Cloud KMS.
`diskEncryptionKey.sha256`	`string` [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
`diskEncryptionKey.kmsKeyServiceAccount`	`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.
`sourceImageEncryptionKey`	`object` The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
`sourceImageEncryptionKey.rawKey`	`string` Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
`sourceImageEncryptionKey.rsaEncryptedKey`	`string` Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. The key must meet the following requirements before you can provide it to Compute Engine: The key is wrapped using a RSA public key certificate provided by Google. 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
`sourceImageEncryptionKey.kmsKeyName`	`string` The name of the encryption key that is stored in Google Cloud KMS.
`sourceImageEncryptionKey.sha256`	`string` [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
`sourceImageEncryptionKey.kmsKeyServiceAccount`	`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.
`sourceSnapshotEncryptionKey`	`object` The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
`sourceSnapshotEncryptionKey.rawKey`	`string` Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
`sourceSnapshotEncryptionKey.rsaEncryptedKey`	`string` Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. The key must meet the following requirements before you can provide it to Compute Engine: The key is wrapped using a RSA public key certificate provided by Google. 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
`sourceSnapshotEncryptionKey.kmsKeyName`	`string` The name of the encryption key that is stored in Google Cloud KMS.
`sourceSnapshotEncryptionKey.sha256`	`string` [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
`sourceSnapshotEncryptionKey.kmsKeyServiceAccount`	`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.
`labels`	`map (key: string, value: string)` Labels to apply to this disk. These can be later modified by the `setLabels` method. An object containing a list of `"key": value` pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`.
`labelFingerprint`	`string (bytes format)` 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. A base64-encoded string.
`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` URLs of the zones where the disk should be replicated to. Only applicable for regional resources.
`licenseCodes[]`	`string (int64 format)` Integer license codes indicating which licenses are attached to this disk.
`physicalBlockSizeBytes`	`string (int64 format)` 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.
`resourcePolicies[]`	`string` Resource policies applied to this disk for automatic snapshot creations.
`eraseWindowsVssSignature`	`boolean` Specifies whether the disk restored from a source snapshot should erase Windows specific VSS signature.
`kind`	`string` [Output Only] Type of the resource. Always `compute#disk` for disks.

Authorization Scopes

Requires one of the following OAuth scopes:

https://www.googleapis.com/auth/compute
https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

In addition to any permissions specified on the fields above, authorization requires one or more of the following Google IAM permissions:

compute.disks.get

To find predefined roles that contain those permissions, see Compute Engine IAM Roles.

Σας βοήθησε αυτή η σελίδα; Πείτε μας τη γνώμη σας:

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see our Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Τελευταία ενημέρωση Δεκέμβριος 18, 2019.

HTTP request

Path parameters

Request body

Response body

Authorization Scopes

IAM Permissions

Αποστολή σχολίων σχετικά με…