此示例会创建一个使用 Cloud KMS 中客户提供的加密密钥加密的新磁盘。
代码示例
Go
试用此示例之前，请按照《Compute Engine 快速入门：使用客户端库》中的 Go 设置说明进行操作。如需了解详情，请参阅 Compute Engine Go API 参考文档。
如需向 Compute Engine 进行身份验证，请设置应用默认凭据。 如需了解详情，请参阅为本地开发环境设置身份验证。
import (
"context"
"fmt"
"io"
compute "cloud.google.com/go/compute/apiv1"
computepb "google.golang.org/genproto/googleapis/cloud/compute/v1"
"google.golang.org/protobuf/proto"
)
// createKmsEncryptedDisk creates a new disk in a project in given zone.
// If you do not provide diskLink or imageLink, an empty disk will be created.
func createKmsEncryptedDisk(
w io.Writer,
projectID, zone, diskName, diskType string,
diskSizeGb int64,
kmsKeyLink, imageLink, diskLink, snapshotLink string,
) error {
// projectID := "your_project_id"
// zone := "us-west3-b" // should match diskType below
// diskName := "your_disk_name"
// diskType := "zones/us-west3/diskTypes/pd-ssd"
// diskSizeGb := 120
// kmsKeyLink := "projects/your_kms_project_id/locations/us-central1/keyRings/your_key_ring/cryptoKeys/your_key"
// // Only use one of these at a time
// diskLink := "projects/your_project_id/global/disks/disk_name"
// imageLink := "projects/your_project_id/global/images/image_name"
// snapshotLink := "projects/your_project_id/global/snapshots/snapshot_name"
ctx := context.Background()
disksClient, err := compute.NewDisksRESTClient(ctx)
if err != nil {
return fmt.Errorf("NewDisksRESTClient: %w", err)
}
defer disksClient.Close()
req := &computepb.InsertDiskRequest{
Project: projectID,
Zone: zone,
DiskResource: &computepb.Disk{
Name: proto.String(diskName),
Zone: proto.String(zone),
Type: proto.String(diskType),
SizeGb: proto.Int64(diskSizeGb),
DiskEncryptionKey: &computepb.CustomerEncryptionKey{
KmsKeyName: &kmsKeyLink,
},
},
}
// if a source disk, image or snapshot has been specified, apply it.
// These arguments are mutually exclusive.
if diskLink != "" {
req.DiskResource.SourceDisk = proto.String(diskLink)
} else if imageLink != "" {
req.DiskResource.SourceImage = proto.String(imageLink)
} else if snapshotLink != "" {
req.DiskResource.SourceSnapshot = proto.String(snapshotLink)
}
op, err := disksClient.Insert(ctx, req)
if err != nil {
return fmt.Errorf("unable to create disk: %w", err)
}
if err = op.Wait(ctx); err != nil {
return fmt.Errorf("unable to wait for the operation: %w", err)
}
fmt.Fprintf(w, "Disk created\n")
return nil
}
Java
试用此示例之前，请按照《Compute Engine 快速入门：使用客户端库》中的 Java 设置说明进行操作。如需了解详情，请参阅 Compute Engine Java API 参考文档。
如需向 Compute Engine 进行身份验证，请设置应用默认凭据。 如需了解详情，请参阅为本地开发环境设置身份验证。
import com.google.cloud.compute.v1.CustomerEncryptionKey;
import com.google.cloud.compute.v1.Disk;
import com.google.cloud.compute.v1.DisksClient;
import com.google.cloud.compute.v1.InsertDiskRequest;
import com.google.cloud.compute.v1.Operation;
import java.io.IOException;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
public class CreateKmsEncryptedDisk {
public static void main(String[] args)
throws IOException, ExecutionException, InterruptedException, TimeoutException {
// TODO(developer): Replace these variables before running the sample.
// Project ID or project number of the Cloud project you want to use.
String project = "YOUR_PROJECT_ID";
// Name of the zone in which you want to create the disk.
String zone = "europe-central2-b";
// Name of the disk you want to create.
String diskName = "YOUR_DISK_NAME";
// The type of disk you want to create. This value uses the following format:
// "zones/{zone}/diskTypes/(pd-standard|pd-ssd|pd-balanced|pd-extreme)".
// For example: "zones/us-west3-b/diskTypes/pd-ssd"
String diskType = String.format("zones/%s/diskTypes/pd-ssd", zone);
// Size of the new disk in gigabytes.
int diskSizeGb = 10;
// URL of the key from KMS. The key might be from another project, as
// long as you have access to it. The data will be encrypted with the same key
// in the new disk. This value uses following format:
// "projects/{kms_project_id}/locations/{region}/keyRings/{key_ring}/cryptoKeys/{key}"
String kmsKeyName = "kms-key-name";
// A link to the disk you want to use as a source for the new disk.
// This value uses the following format:
// "projects/{project_name}/zones/{zone}/disks/{disk_name}"
String diskLink = String.format("projects/%s/zones/%s/disks/%s", "PROJECT_NAME", "ZONE",
"DISK_NAME");
// A link to the image you want to use as a source for the new disk.
// This value uses the following format:
// "projects/{project_name}/global/images/{image_name}"
String imageLink = String.format("projects/%s/global/images/%s", "PROJECT_NAME", "IMAGE_NAME");
createKmsEncryptedDisk(project, zone, diskName, diskType, diskSizeGb, kmsKeyName, diskLink,
imageLink);
}
// Creates a zonal disk in a project. If you do not provide values for diskLink or imageLink,
// an empty disk will be created.
public static void createKmsEncryptedDisk(String project, String zone, String diskName,
String diskType, int diskSizeGb, String kmsKeyName, String diskLink, String imageLink)
throws IOException, ExecutionException, InterruptedException, TimeoutException {
// Initialize client that will be used to send requests. This client only needs to be created
// once, and can be reused for multiple requests. After completing all of your requests, call
// the `disksClient.close()` method on the client to safely
// clean up any remaining background resources.
try (DisksClient disksClient = DisksClient.create()) {
// Create a disk and set the KMS encryption key name.
Disk.Builder diskBuilder = Disk.newBuilder()
.setZone(zone)
.setName(diskName)
.setType(diskType)
.setSizeGb(diskSizeGb)
.setDiskEncryptionKey(CustomerEncryptionKey.newBuilder()
.setKmsKeyName(kmsKeyName)
.build());
// Set source disk if diskLink is not empty.
if (!diskLink.isEmpty()) {
diskBuilder.setSourceDisk(diskLink);
}
// Set source image if imageLink is not empty.
if (!imageLink.isEmpty()) {
diskBuilder.setSourceImage(imageLink);
}
// Wait for the insert disk operation to complete.
Operation operation = disksClient.insertAsync(
InsertDiskRequest.newBuilder()
.setProject(project)
.setZone(zone)
.setDiskResource(diskBuilder.build())
.build()).get(3, TimeUnit.MINUTES);
if (operation.hasError()) {
System.out.println("Disk creation failed!");
throw new Error(operation.getError().toString());
}
System.out.println(
"Disk created with KMS encryption key. Operation Status: " + operation.getStatus());
}
}
}Python
试用此示例之前，请按照《Compute Engine 快速入门：使用客户端库》中的 Python 设置说明进行操作。如需了解详情，请参阅 Compute Engine Python API 参考文档。
如需向 Compute Engine 进行身份验证，请设置应用默认凭据。 如需了解详情，请参阅为本地开发环境设置身份验证。
from __future__ import annotations
import sys
from typing import Any
from google.api_core.exceptions import BadRequest
from google.api_core.extended_operation import ExtendedOperation
from google.cloud import compute_v1
def wait_for_extended_operation(
operation: ExtendedOperation, verbose_name: str = "operation", timeout: int = 300
) -> Any:
"""
Waits for the extended (long-running) operation to complete.
If the operation is successful, it will return its result.
If the operation ends with an error, an exception will be raised.
If there were any warnings during the execution of the operation
they will be printed to sys.stderr.
Args:
operation: a long-running operation you want to wait on.
verbose_name: (optional) a more verbose name of the operation,
used only during error and warning reporting.
timeout: how long (in seconds) to wait for operation to finish.
If None, wait indefinitely.
Returns:
Whatever the operation.result() returns.
Raises:
This method will raise the exception received from `operation.exception()`
or RuntimeError if there is no exception set, but there is an `error_code`
set for the `operation`.
In case of an operation taking longer than `timeout` seconds to complete,
a `concurrent.futures.TimeoutError` will be raised.
"""
result = operation.result(timeout=timeout)
if operation.error_code:
print(
f"Error during {verbose_name}: [Code: {operation.error_code}]: {operation.error_message}",
file=sys.stderr,
flush=True,
)
print(f"Operation ID: {operation.name}", file=sys.stderr, flush=True)
raise operation.exception() or RuntimeError(operation.error_message)
if operation.warnings:
print(f"Warnings during {verbose_name}:\n", file=sys.stderr, flush=True)
for warning in operation.warnings:
print(f" - {warning.code}: {warning.message}", file=sys.stderr, flush=True)
return result
def create_kms_encrypted_disk(
project_id: str,
zone: str,
disk_name: str,
disk_type: str,
disk_size_gb: int,
kms_key_name: str,
disk_link: str | None = None,
image_link: str | None = None,
) -> compute_v1.Disk:
"""
Creates a zonal disk in a project. If you do not provide values for disk_link or image_link,
an empty disk will be created.
To run this method, the service-<project_id>@compute-system.iam.gserviceaccount.com
service account needs to have the cloudkms.cryptoKeyEncrypterDecrypter role,
as described in documentation:
https://cloud.google.com/compute/docs/disks/customer-managed-encryption#before_you_begin
Args:
project_id: project ID or project number of the Cloud project you want to use.
zone: name of the zone in which you want to create the disk.
disk_name: name of the disk you want to create.
disk_type: the type of disk you want to create. This value uses the following format:
"zones/{zone}/diskTypes/(pd-standard|pd-ssd|pd-balanced|pd-extreme)".
For example: "zones/us-west3-b/diskTypes/pd-ssd"
disk_size_gb: size of the new disk in gigabytes
kms_key_name: URL of the key from KMS. The key might be from another project, as
long as you have access to it. The data will be encrypted with the same key
in the new disk. This value uses following format:
"projects/{kms_project_id}/locations/{region}/keyRings/{key_ring}/cryptoKeys/{key}"
disk_link: a link to the disk you want to use as a source for the new disk.
This value uses the following format: "projects/{project_name}/zones/{zone}/disks/{disk_name}"
image_link: a link to the image you want to use as a source for the new disk.
This value uses the following format: "projects/{project_name}/global/images/{image_name}"
Returns:
An attachable disk.
"""
disk_client = compute_v1.DisksClient()
disk = compute_v1.Disk()
disk.zone = zone
disk.size_gb = disk_size_gb
if disk_link:
disk.source_disk = disk_link
if image_link:
disk.source_image = image_link
disk.type_ = disk_type
disk.name = disk_name
disk.disk_encryption_key = compute_v1.CustomerEncryptionKey()
disk.disk_encryption_key.kms_key_name = kms_key_name
try:
operation = disk_client.insert(
project=project_id, zone=zone, disk_resource=disk
)
except BadRequest as err:
if "Permission 'cloudkms.cryptoKeyVersions.useToEncrypt' denied" in err.message:
print(
f"Please provide the cloudkms.cryptoKeyEncrypterDecrypter role to"
f"service-{project_id}@compute-system.iam.gserviceaccount.com"
)
raise err
wait_for_extended_operation(operation, "disk creation")
return disk_client.get(project=project_id, zone=zone, disk=disk_name)
后续步骤
如需搜索和过滤其他 Google Cloud 产品的代码示例，请参阅 Google Cloud 示例浏览器。