Method: regionDisks.list

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

Retrieves the list of persistent disks contained within the specified region.

HTTP request

GET https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/disks

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

Parameters
`project`	`string` Project ID for this request.
`region`	`string` Name of the region for this request.

project

string

Project ID for this request.

region

string

Name of the region for this request.

Query parameters

Parameters
`maxResults`	`number (uint32 format)` The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
`pageToken`	`string` Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
`filter`	`string` A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, `(scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake")`. By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example, `(cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true)`.
`orderBy`	`string` Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.

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, "items": [ { "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, "type": string, "licenses": [ string ], "guestOsFeatures": [ { "type": enum } ], "lastAttachTimestamp": string, "lastDetachTimestamp": string, "users": [ string ], "diskEncryptionKey": { "sha256": string, "rawKey": string, "kmsKeyName": string }, "sourceImageEncryptionKey": { "sha256": string, "rawKey": string, "kmsKeyName": string }, "sourceSnapshotEncryptionKey": { "sha256": string, "rawKey": string, "kmsKeyName": string }, "labels": { object }, "labelFingerprint": string, "region": string, "replicaZones": [ string ], "licenseCodes": [ string ], "physicalBlockSizeBytes": string, "resourcePolicies": [ string ], "kind": string } ], "nextPageToken": string, "selfLink": string, "warning": { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] }, "kind": string }

JSON representation

{
  "id": string,
  "items": [
    {
      "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,
      "type": string,
      "licenses": [
        string
      ],
      "guestOsFeatures": [
        {
          "type": enum
        }
      ],
      "lastAttachTimestamp": string,
      "lastDetachTimestamp": string,
      "users": [
        string
      ],
      "diskEncryptionKey": {
        "sha256": string,


        "rawKey": string,
        "kmsKeyName": string

      },
      "sourceImageEncryptionKey": {
        "sha256": string,


        "rawKey": string,
        "kmsKeyName": string

      },
      "sourceSnapshotEncryptionKey": {
        "sha256": string,


        "rawKey": string,
        "kmsKeyName": string

      },
      "labels": {
        object
      },
      "labelFingerprint": string,
      "region": string,
      "replicaZones": [
        string
      ],
      "licenseCodes": [
        string
      ],
      "physicalBlockSizeBytes": string,
      "resourcePolicies": [
        string
      ],
      "kind": string
    }
  ],
  "nextPageToken": string,
  "selfLink": string,
  "warning": {
    "code": enum,
    "message": string,
    "data": [
      {
        "key": string,
        "value": string
      }
    ]
  },
  "kind": string
}

Fields
`id`	`string` [Output Only] Unique identifier for the resource; defined by the server.
`items[]`	`object` A list of Disk resources.
`items[].id`	`string (fixed64 format)` [Output Only] The unique identifier for the resource. This identifier is defined by the server.
`items[].creationTimestamp`	`string` [Output Only] Creation timestamp in RFC3339 text format.
`items[].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.
`items[].description`	`string` An optional description of this resource. Provide this property when you create the resource.
`items[].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.
`items[].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.
`items[].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.
`items[].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`
`items[].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.
`items[].options`	`string` Internal use only.
`items[].selfLink`	`string` [Output Only] Server-defined fully-qualified URL for this resource.
`items[].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`
`items[].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.
`items[].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`
`items[].licenses[]`	`string` A list of publicly visible licenses. Reserved for Google's use.
`items[].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.
`items[].guestOsFeatures[].type`	`enum` The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.
`items[].lastAttachTimestamp`	`string` [Output Only] Last attach timestamp in RFC3339 text format.
`items[].lastDetachTimestamp`	`string` [Output Only] Last detach timestamp in RFC3339 text format.
`items[].users[]`	`string` [Output Only] Links to the users of the disk (attached instances) in form: `projects/project/zones/zone/instances/instance`
`items[].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.
`items[].diskEncryptionKey.rawKey`	`string` Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
`items[].diskEncryptionKey.kmsKeyName`	`string` The name of the encryption key that is stored in Google Cloud KMS.
`items[].diskEncryptionKey.sha256`	`string` [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
`items[].sourceImageEncryptionKey`	`object` The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
`items[].sourceImageEncryptionKey.rawKey`	`string` Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
`items[].sourceImageEncryptionKey.kmsKeyName`	`string` The name of the encryption key that is stored in Google Cloud KMS.
`items[].sourceImageEncryptionKey.sha256`	`string` [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
`items[].sourceSnapshotEncryptionKey`	`object` The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
`items[].sourceSnapshotEncryptionKey.rawKey`	`string` Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
`items[].sourceSnapshotEncryptionKey.kmsKeyName`	`string` The name of the encryption key that is stored in Google Cloud KMS.
`items[].sourceSnapshotEncryptionKey.sha256`	`string` [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
`items[].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" }`.
`items[].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.
`items[].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.
`items[].replicaZones[]`	`string` URLs of the zones where the disk should be replicated to. Only applicable for regional resources.
`items[].licenseCodes[]`	`string (int64 format)` Integer license codes indicating which licenses are attached to this disk.
`items[].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.
`items[].resourcePolicies[]`	`string` Resource policies applied to this disk for automatic snapshot creations.
`items[].kind`	`string` [Output Only] Type of the resource. Always `compute#disk` for disks.
`nextPageToken`	`string` [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than `maxResults`, use the `nextPageToken` as a value for the query parameter `pageToken` in the next list request. Subsequent list requests will have their own `nextPageToken` to continue paging through the results.
`selfLink`	`string` [Output Only] Server-defined URL for this resource.
`warning`	`object` [Output Only] Informational warning message.
`warning.code`	`enum` [Output Only] A warning code, if applicable. For example, Compute Engine returns `NO_RESULTS_ON_PAGE` if there are no results in the response.
`warning.message`	`string` [Output Only] A human-readable description of the warning code.
`warning.data[]`	`object` [Output Only] Metadata about this warning in `key: value` format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
`warning.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).
`warning.data[].value`	`string` [Output Only] A warning data value corresponding to the key.
`kind`	`string` [Output Only] Type of resource. Always `compute#diskList` for lists of 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.list

¿Te sirvió esta página? Envíanos tu opinión:

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.

Última actualización: Septiembre 12, 2019