Method: regionDisks.createSnapshot

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

Creates a snapshot of this regional disk.

HTTP request

POST https://compute.googleapis.com/compute/beta/projects/{project}/regions/{region}/disks/{resourceId}/createSnapshot

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.
`resourceId`	`string` Name of the regional persistent disk to snapshot.

project

string

Project ID for this request.

region

string

Name of the region for this request.

resourceId

string

Name of the regional persistent disk to snapshot.

Query parameters

Parameters

Parameters
`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`).

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).

Request body

The request body contains data with the following structure:

JSON representation
{ "id": string, "creationTimestamp": string, "name": string, "description": string, "status": enum, "sourceDisk": string, "sourceDiskId": string, "diskSizeGb": string, "storageBytes": string, "storageBytesStatus": enum, "licenses": [ string ], "snapshotEncryptionKey": { "rawKey": string, "rsaEncryptedKey": string, "kmsKeyName": string, "sha256": string, "kmsKeyServiceAccount": string }, "sourceDiskEncryptionKey": { "rawKey": string, "rsaEncryptedKey": string, "kmsKeyName": string, "sha256": string, "kmsKeyServiceAccount": string }, "selfLink": string, "labels": { string: string, ... }, "labelFingerprint": string, "licenseCodes": [ string ], "storageLocations": [ string ], "autoCreated": boolean, "kind": string }

JSON representation

{
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "status": enum,
  "sourceDisk": string,
  "sourceDiskId": string,
  "diskSizeGb": string,
  "storageBytes": string,
  "storageBytesStatus": enum,
  "licenses": [
    string
  ],
  "snapshotEncryptionKey": {
    "rawKey": string,
    "rsaEncryptedKey": string,
    "kmsKeyName": string,
    "sha256": string,
    "kmsKeyServiceAccount": string
  },
  "sourceDiskEncryptionKey": {
    "rawKey": string,
    "rsaEncryptedKey": string,
    "kmsKeyName": string,
    "sha256": string,
    "kmsKeyServiceAccount": string
  },
  "selfLink": string,
  "labels": {
    string: string,
    ...
  },
  "labelFingerprint": string,
  "licenseCodes": [
    string
  ],
  "storageLocations": [
    string
  ],
  "autoCreated": 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.
`status`	`enum` [Output Only] The status of the snapshot. This can be `CREATING`, `DELETING`, `FAILED`, `READY`, or `UPLOADING`.
`sourceDisk`	`string` [Output Only] The source disk used to create this snapshot.
`sourceDiskId`	`string` [Output Only] The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.
`diskSizeGb`	`string (int64 format)` [Output Only] Size of the snapshot, specified in GB.
`storageBytes`	`string (int64 format)` [Output Only] A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.
`storageBytesStatus`	`enum` [Output Only] An indicator whether `storageBytes` is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be `UPDATING`, meaning the size of the snapshot is being updated, or `UP_TO_DATE`, meaning the size of the snapshot is up-to-date.
`licenses[]`	`string` [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).
`snapshotEncryptionKey`	`object` Encrypts the snapshot using a customer-supplied encryption key. After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the snapshot later. For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request. Customer-supplied encryption keys do not protect access to metadata of the snapshot. If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later.
`snapshotEncryptionKey.rawKey`	`string` Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
`snapshotEncryptionKey.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
`snapshotEncryptionKey.kmsKeyName`	`string` The name of the encryption key that is stored in Google Cloud KMS.
`snapshotEncryptionKey.sha256`	`string` [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
`snapshotEncryptionKey.kmsKeyServiceAccount`	`string` The service account being used for the encryption request for the given KMS key. If absent, default GCE compute robot account will be used
`sourceDiskEncryptionKey`	`object` The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
`sourceDiskEncryptionKey.rawKey`	`string` Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
`sourceDiskEncryptionKey.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
`sourceDiskEncryptionKey.kmsKeyName`	`string` The name of the encryption key that is stored in Google Cloud KMS.
`sourceDiskEncryptionKey.sha256`	`string` [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
`sourceDiskEncryptionKey.kmsKeyServiceAccount`	`string` The service account being used for the encryption request for the given KMS key. If absent, default GCE compute robot account will be used
`selfLink`	`string` [Output Only] Server-defined URL for the resource.
`labels`	`map (key: string, value: string)` Labels to apply to this snapshot. These can be later modified by the `setLabels` method. Label values may be empty. An object containing a list of `"key": value` pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. Authorization requires the following Google IAM permission on the specified resource `labels`: `compute.snapshots.setLabels`
`labelFingerprint`	`string (bytes format)` A fingerprint for the labels being applied to this snapshot, 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 snapshot. A base64-encoded string.
`licenseCodes[]`	`string (int64 format)` [Output Only] Integer license codes indicating which licenses are attached to this snapshot.
`storageLocations[]`	`string` Cloud Storage bucket storage location of the snapshot (regional or multi-regional).
`autoCreated`	`boolean` [Output Only] Set to true if snapshots are automatically by applying resource policy on the target disk.
`kind`	`string` [Output Only] Type of the resource. Always `compute#snapshot` for Snapshot resources.

Response body

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

JSON representation
{ "id": string, "creationTimestamp": string, "name": string, "zone": string, "clientOperationId": string, "operationType": string, "targetLink": string, "targetId": string, "status": enum, "statusMessage": string, "user": string, "progress": number, "insertTime": string, "startTime": string, "endTime": string, "error": { "errors": [ { "code": string, "location": string, "message": string } ] }, "warnings": [ { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] } ], "httpErrorStatusCode": number, "httpErrorMessage": string, "selfLink": string, "region": string, "description": string, "kind": string }

JSON representation

{
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "zone": string,
  "clientOperationId": string,
  "operationType": string,
  "targetLink": string,
  "targetId": string,
  "status": enum,
  "statusMessage": string,
  "user": string,
  "progress": number,
  "insertTime": string,
  "startTime": string,
  "endTime": string,
  "error": {
    "errors": [
      {
        "code": string,
        "location": string,
        "message": string
      }
    ]
  },
  "warnings": [
    {
      "code": enum,
      "message": string,
      "data": [
        {
          "key": string,
          "value": string
        }
      ]
    }
  ],
  "httpErrorStatusCode": number,
  "httpErrorMessage": string,
  "selfLink": string,
  "region": string,
  "description": string,
  "kind": string
}

Fields
`id`	`string (fixed64 format)` [Output Only] The unique identifier for the operation. This identifier is defined by the server.
`creationTimestamp`	`string` [Deprecated] This field is deprecated.
`name`	`string` [Output Only] Name of the operation.
`zone`	`string` [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
`clientOperationId`	`string` [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
`operationType`	`string` [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
`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.
`targetId`	`string (fixed64 format)` [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
`status`	`enum` [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.
`user`	`string` [Output Only] User who requested the operation, for example: `user@example.com`.
`progress`	`number` [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.
`insertTime`	`string` [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
`startTime`	`string` [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
`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` [Output Only] The array of errors encountered while processing this operation.
`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.
`warnings[]`	`object` [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
`warnings[].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.
`warnings[].message`	`string` [Output Only] A human-readable description of the warning code.
`warnings[].data[]`	`object` [Output Only] Metadata about this warning in `key: value` format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
`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.
`httpErrorStatusCode`	`number` [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.
`httpErrorMessage`	`string` [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
`selfLink`	`string` [Output Only] Server-defined URL for the resource.
`region`	`string` [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
`description`	`string` [Output Only] A textual description of the operation, which is set when the operation is created.
`kind`	`string` [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

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.createSnapshot
compute.snapshots.create

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

Cette page vous a-t-elle été utile ? Évaluez-la :

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.

Dernière mise à jour : décembre 5, 2019

Method: regionDisks.createSnapshot

HTTP request

Path parameters

Query parameters

Request body

Response body

Authorization Scopes

IAM Permissions

Envoyer des commentaires concernant…