从指定的来源磁盘创建 Windows Server 映像。
深入探索
如需查看包含此代码示例的详细文档，请参阅以下内容：
代码示例
Go
试用此示例之前，请按照《Compute Engine 快速入门：使用客户端库》中的 Go 设置说明进行操作。 如需了解详情，请参阅 Compute Engine Go API 参考文档。
如需向 Compute Engine 进行身份验证，请设置应用默认凭据。 如需了解详情，请参阅为本地开发环境设置身份验证。
import (
"context"
"fmt"
"io"
"strings"
compute "cloud.google.com/go/compute/apiv1"
computepb "cloud.google.com/go/compute/apiv1/computepb"
"google.golang.org/protobuf/proto"
)
// createWindowsOSImage creates a new Windows image from the specified source disk.
func createWindowsOSImage(
w io.Writer,
projectID, zone, sourceDiskName, imageName, storageLocation string,
forceCreate bool,
) error {
// projectID := "your_project_id"
// zone := "europe-central2-b"
// sourceDiskName := "your_source_disk_name"
// imageName := "your_image_name"
// storageLocation := "eu"
// forceCreate := false
ctx := context.Background()
instancesClient, err := compute.NewInstancesRESTClient(ctx)
if err != nil {
return fmt.Errorf("NewInstancesRESTClient: %w", err)
}
defer instancesClient.Close()
imagesClient, err := compute.NewImagesRESTClient(ctx)
if err != nil {
return fmt.Errorf("NewImagesRESTClient: %w", err)
}
defer imagesClient.Close()
disksClient, err := compute.NewDisksRESTClient(ctx)
if err != nil {
return fmt.Errorf("NewDisksRESTClient: %w", err)
}
defer disksClient.Close()
// Getting instances where source disk is attached
diskRequest := &computepb.GetDiskRequest{
Project: projectID,
Zone: zone,
Disk: sourceDiskName,
}
sourceDisk, err := disksClient.Get(ctx, diskRequest)
if err != nil {
return fmt.Errorf("unable to get disk: %w", err)
}
// Сhecking whether the instances is stopped
for _, fullInstanceName := range sourceDisk.GetUsers() {
parsedName := strings.Split(fullInstanceName, "/")
l := len(parsedName)
if l < 5 {
return fmt.Errorf(
"API returned instance name with unexpected format",
)
}
instanceReq := &computepb.GetInstanceRequest{
Project: parsedName[l-5],
Zone: parsedName[l-3],
Instance: parsedName[l-1],
}
instance, err := instancesClient.Get(ctx, instanceReq)
if err != nil {
return fmt.Errorf("unable to get instance: %w", err)
}
if instance.GetStatus() != "TERMINATED" && instance.GetStatus() != "STOPPED" {
if !forceCreate {
return fmt.Errorf("instance %s should be stopped. "+
"Please stop the instance using "+
"GCESysprep command or set forceCreate parameter to true "+
"(not recommended). More information here: "+
"https://cloud.google.com/compute/docs/instances/windows/creating-windows-os-image#api",
parsedName[l-1],
)
}
}
}
if forceCreate {
fmt.Fprintf(w, "Warning: ForceCreate option compromise the integrity of your image. "+
"Stop the instance before you create the image if possible.",
)
}
req := &computepb.InsertImageRequest{
Project: projectID,
ForceCreate: &forceCreate,
ImageResource: &computepb.Image{
Name: proto.String(imageName),
SourceDisk: proto.String(fmt.Sprintf("zones/%s/disks/%s", zone, sourceDiskName)),
StorageLocations: []string{storageLocation},
},
}
op, err := imagesClient.Insert(ctx, req)
if err != nil {
return fmt.Errorf("unable to create image: %w", err)
}
if err = op.Wait(ctx); err != nil {
return fmt.Errorf("unable to wait for the operation: %w", err)
}
fmt.Fprintf(w, "Image created\n")
return nil
}
Java
试用此示例之前，请按照《Compute Engine 快速入门：使用客户端库》中的 Java 设置说明进行操作。 如需了解详情，请参阅 Compute Engine Java API 参考文档。
如需向 Compute Engine 进行身份验证，请设置应用默认凭据。 如需了解详情，请参阅为本地开发环境设置身份验证。
import com.google.cloud.compute.v1.Disk;
import com.google.cloud.compute.v1.DisksClient;
import com.google.cloud.compute.v1.Image;
import com.google.cloud.compute.v1.ImagesClient;
import com.google.cloud.compute.v1.InsertImageRequest;
import com.google.cloud.compute.v1.Instance;
import com.google.cloud.compute.v1.InstancesClient;
import com.google.cloud.compute.v1.Operation;
import java.io.IOException;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
public class CreateImage {
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 use.
String project = "your-project-id";
// Zone of the disk you copy from.
String zone = "europe-central2-b";
// Name of the source disk you copy from.
String sourceDiskName = "source-disk-name";
// Name of the image you want to create.
String imageName = "your-image-name";
// Storage location for the image. If the value is undefined,
// function will store the image in the multi-region closest to your image's source location.
String storageLocation = "eu";
// Create the image even if the source disk is attached to a running instance.
boolean forceCreate = false;
createImage(project, zone, sourceDiskName, imageName, storageLocation, forceCreate);
}
// Creates a new disk image from the specified source disk.
public static void createImage(String project, String zone, String sourceDiskName,
String imageName, String storageLocation, boolean forceCreate)
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 `client.close()` method on the client to safely
// clean up any remaining background resources.
try (ImagesClient imagesClient = ImagesClient.create();
InstancesClient instancesClient = InstancesClient.create();
DisksClient disksClient = DisksClient.create()) {
Disk disk = disksClient.get(project, zone, sourceDiskName);
// Getting instances where source disk is attached.
for (String fullInstanceName : disk.getUsersList()) {
Map<String, String> instanceInfo = parseInstanceName(fullInstanceName);
Instance instance = instancesClient.get(instanceInfo.get("instanceProjectId"),
instanceInfo.get("instanceZone"), instanceInfo.get("instanceName"));
// Сheck whether the instances are stopped.
if (!Arrays.asList("TERMINATED", "STOPPED").contains(instance.getStatus())
&& !forceCreate) {
throw new IllegalStateException(
String.format(
"Instance %s should be stopped. For Windows instances please stop the instance "
+ "using GCESysprep command. For Linux instances just shut it down normally."
+ " You can suppress this error and create an image of the disk by setting "
+ "'forceCreate' parameter to true (not recommended). "
+ "More information here: "
+ "* https://cloud.google.com/compute/docs/instances/windows/creating-windows-os-image#api"
+ "* https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#prepare_instance_for_image",
instanceInfo.get("instanceName")));
}
}
if (forceCreate) {
System.out.println(
"Warning: forceCreate option compromise the integrity of your image. "
+ "Stop the instance before you create the image if possible.");
}
// Create Image.
Image image = Image.newBuilder()
.setName(imageName)
.setSourceDisk(String.format("/zones/%s/disks/%s", zone, sourceDiskName))
.addStorageLocations(storageLocation.isEmpty() ? "" : storageLocation)
.build();
InsertImageRequest insertImageRequest = InsertImageRequest.newBuilder()
.setProject(project)
.setForceCreate(forceCreate)
.setImageResource(image)
.build();
Operation response = imagesClient.insertAsync(insertImageRequest).get(5, TimeUnit.MINUTES);
if (response.hasError()) {
System.out.println("Image creation failed ! ! " + response);
return;
}
System.out.println("Image created.");
}
}
public static Map<String, String> parseInstanceName(String name) {
String[] parsedName = name.split("/");
int splitLength = parsedName.length;
if (splitLength < 5) {
throw new IllegalArgumentException(
"Provide correct instance name in the following format: "
+ "https://www.googleapis.com/compute/v1/projects/PROJECT/zones/ZONE/instances/INSTANCE_NAME");
}
return new HashMap<>() {
{
put("instanceName", parsedName[splitLength - 1]);
put("instanceZone", parsedName[splitLength - 3]);
put("instanceProjectId", parsedName[splitLength - 5]);
}
};
}
}Node.js
试用此示例之前，请按照《Compute Engine 快速入门：使用客户端库》中的 Node.js 设置说明进行操作。 如需了解详情，请参阅 Compute Engine Node.js API 参考文档。
如需向 Compute Engine 进行身份验证，请设置应用默认凭据。 如需了解详情，请参阅为本地开发环境设置身份验证。
/**
* TODO(developer): Uncomment and replace these variables before running the sample.
*/
// const projectId = 'YOUR_PROJECT_ID';
// const zone = 'europe-central2-b';
// const sourceDiskName = 'YOUR_SOURCE_DISK_NAME';
// const imageName = 'YOUR_IMAGE_NAME';
// const storageLocation = 'eu';
// const forceCreate = false;
const compute = require('@google-cloud/compute');
function parseInstanceName(name) {
const parsedName = name.split('/');
const l = parsedName.length;
if (parsedName.legth < 5) {
throw new Error(
'Provide correct instance name in the following format: https://www.googleapis.com/compute/v1/projects/PROJECT/zones/ZONE/instances/INSTANCE_NAME'
);
}
return [parsedName[l - 1], parsedName[l - 3], parsedName[l - 5]];
}
async function createWindowsOSImage() {
const imagesClient = new compute.ImagesClient();
const instancesClient = new compute.InstancesClient();
const disksClient = new compute.DisksClient();
// Getting instances where source disk is attached
const [sourceDisk] = await disksClient.get({
project: projectId,
zone,
disk: sourceDiskName,
});
// Сhecking whether the instances is stopped
for (const fullInstanceName of sourceDisk.users) {
const [instanceName, instanceZone, instanceProjectId] =
parseInstanceName(fullInstanceName);
const [instance] = await instancesClient.get({
project: instanceProjectId,
zone: instanceZone,
instance: instanceName,
});
if (
!['TERMINATED', 'STOPPED'].includes(instance.status) &&
!forceCreate
) {
throw new Error(
`Instance ${instanceName} should be stopped. Please stop the instance using GCESysprep command or set forceCreate parameter to true (not recommended). More information here: https://cloud.google.com/compute/docs/instances/windows/creating-windows-os-image#api.`
);
}
}
if (forceCreate) {
console.warn(
'Warning: forceCreate option compromise the integrity of your image. Stop the instance before you create the image if possible.'
);
}
const [response] = await imagesClient.insert({
project: projectId,
forceCreate,
imageResource: {
name: imageName,
sourceDisk: `/zones/${zone}/disks/${sourceDiskName}`,
storageLocations: storageLocation ? [storageLocation] : [],
},
});
let operation = response.latestResponse;
const operationsClient = new compute.GlobalOperationsClient();
// Wait for the create operation to complete.
while (operation.status !== 'DONE') {
[operation] = await operationsClient.wait({
operation: operation.name,
project: projectId,
});
}
console.log('Image created.');
}
createWindowsOSImage();Python
试用此示例之前，请按照《Compute Engine 快速入门：使用客户端库》中的 Python 设置说明进行操作。 如需了解详情，请参阅 Compute Engine Python API 参考文档。
如需向 Compute Engine 进行身份验证，请设置应用默认凭据。 如需了解详情，请参阅为本地开发环境设置身份验证。
from __future__ import annotations
import sys
from typing import Any
import warnings
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
STOPPED_MACHINE_STATUS = (
compute_v1.Instance.Status.TERMINATED.name,
compute_v1.Instance.Status.STOPPED.name,
)
def create_image_from_disk(
project_id: str,
zone: str,
source_disk_name: str,
image_name: str,
storage_location: str | None = None,
force_create: bool = False,
) -> compute_v1.Image:
"""
Creates a new disk image.
Args:
project_id: project ID or project number of the Cloud project you use.
zone: zone of the disk you copy from.
source_disk_name: name of the source disk you copy from.
image_name: name of the image you want to create.
storage_location: storage location for the image. If the value is undefined,
function will store the image in the multi-region closest to your image's
source location.
force_create: create the image even if the source disk is attached to a
running instance.
Returns:
An Image object.
"""
image_client = compute_v1.ImagesClient()
disk_client = compute_v1.DisksClient()
instance_client = compute_v1.InstancesClient()
# Get source disk
disk = disk_client.get(project=project_id, zone=zone, disk=source_disk_name)
for disk_user in disk.users:
instance_name = disk_user.split("/")[-1]
instance = instance_client.get(
project=project_id, zone=zone, instance=instance_name
)
if instance.status in STOPPED_MACHINE_STATUS:
continue
if not force_create:
raise RuntimeError(
f"Instance {disk_user} should be stopped. For Windows instances please "
f"stop the instance using `GCESysprep` command. For Linux instances just "
f"shut it down normally. You can supress this error and create an image of"
f"the disk by setting `force_create` parameter to true (not recommended). \n"
f"More information here: \n"
f" * https://cloud.google.com/compute/docs/instances/windows/creating-windows-os-image#api \n"
f" * https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#prepare_instance_for_image"
)
else:
warnings.warn(
f"Warning: The `force_create` option may compromise the integrity of your image. "
f"Stop the {disk_user} instance before you create the image if possible."
)
# Create image
image = compute_v1.Image()
image.source_disk = disk.self_link
image.name = image_name
if storage_location:
image.storage_locations = [storage_location]
operation = image_client.insert(project=project_id, image_resource=image)
wait_for_extended_operation(operation, "image creation from disk")
return image_client.get(project=project_id, image=image_name)
后续步骤
如需搜索和过滤其他 Google Cloud 产品的代码示例，请参阅 Google Cloud 示例浏览器。