重新啟動或重設 Compute Engine 執行個體


本文件說明如何重新啟動或重設 Compute Engine 執行個體。如要進一步瞭解重設執行個體的影響,以及暫停、停止或重設執行個體的差異,請參閱「暫停、停止或重設 Compute Engine 執行個體」。

重新啟動或重設執行個體有助於確保最佳效能和穩定性,或協助解決問題,例如凍結、速度緩慢或當機的來賓作業系統 (OS)。根據執行個體的訪客 OS 狀態,執行下列任一操作:

  • 重新啟動執行個體。如果客體作業系統速度緩慢或當機,重新啟動可讓系統有足夠的時間在關機前完成執行中的作業。

  • 重設執行個體。只有在客體作業系統發生當機或無回應,且您沒有其他選項時,才應重設執行個體。重設執行個體不會讓客體 OS 安全關機。這項操作會捨棄未儲存的資料,並可能損毀任何磁碟的檔案系統。

事前準備

  • 如果尚未設定,請先設定驗證機制。「驗證」是指驗證身分,以便存取 Google Cloud 服務和 API 的程序。如要從本機開發環境執行程式碼或範例,請選取下列任一選項,以便對 Compute Engine 進行驗證:

    Select the tab for how you plan to use the samples on this page:

    Console

    When you use the Google Cloud console to access Google Cloud services and APIs, you don't need to set up authentication.

    gcloud

    1. After installing the Google Cloud CLI, initialize it by running the following command:

      gcloud init

      If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

    2. Set a default region and zone.
    3. Go

      如要在本機開發環境中使用本頁面上的 Go 範例,請先安裝並初始化 gcloud CLI,然後使用您的使用者憑證設定應用程式預設憑證。

      1. Install the Google Cloud CLI.

      2. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

      3. To initialize the gcloud CLI, run the following command:

        gcloud init
      4. If you're using a local shell, then create local authentication credentials for your user account:

        gcloud auth application-default login

        You don't need to do this if you're using Cloud Shell.

        If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.

      5. 詳情請參閱 Set up authentication for a local development environment

      Java

      如要在本機開發環境中使用本頁面上的 Java 範例,請先安裝並初始化 gcloud CLI,然後使用您的使用者憑證設定應用程式預設憑證。

      1. Install the Google Cloud CLI.

      2. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

      3. To initialize the gcloud CLI, run the following command:

        gcloud init
      4. If you're using a local shell, then create local authentication credentials for your user account:

        gcloud auth application-default login

        You don't need to do this if you're using Cloud Shell.

        If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.

      5. 詳情請參閱 Set up authentication for a local development environment

      Node.js

      如要在本機開發環境中使用本頁面上的 Node.js 範例,請先安裝並初始化 gcloud CLI,然後使用您的使用者憑證設定應用程式預設憑證。

      1. Install the Google Cloud CLI.

      2. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

      3. To initialize the gcloud CLI, run the following command:

        gcloud init
      4. If you're using a local shell, then create local authentication credentials for your user account:

        gcloud auth application-default login

        You don't need to do this if you're using Cloud Shell.

        If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.

      5. 詳情請參閱 Set up authentication for a local development environment

      PHP

      如要在本機開發環境中使用本頁面上的 PHP 範例,請先安裝並初始化 gcloud CLI,然後使用您的使用者憑證設定應用程式預設憑證。

      1. Install the Google Cloud CLI.

      2. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

      3. To initialize the gcloud CLI, run the following command:

        gcloud init
      4. If you're using a local shell, then create local authentication credentials for your user account:

        gcloud auth application-default login

        You don't need to do this if you're using Cloud Shell.

        If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.

      5. 詳情請參閱 Set up authentication for a local development environment

      Python

      如要在本機開發環境中使用本頁面上的 Python 範例,請先安裝並初始化 gcloud CLI,然後使用您的使用者憑證設定應用程式預設憑證。

      1. Install the Google Cloud CLI.

      2. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

      3. To initialize the gcloud CLI, run the following command:

        gcloud init
      4. If you're using a local shell, then create local authentication credentials for your user account:

        gcloud auth application-default login

        You don't need to do this if you're using Cloud Shell.

        If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.

      5. 詳情請參閱 Set up authentication for a local development environment

      REST

      如要在本機開發環境中使用本頁的 REST API 範例,請使用您提供給 gcloud CLI 的憑證。

        After installing the Google Cloud CLI, initialize it by running the following command:

        gcloud init

        If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

      詳情請參閱 Google Cloud 驗證說明文件中的「驗證以使用 REST」。

      必要的角色

      如要取得重設或重新啟動運算執行個體所需的權限,請要求管理員為您授予執行個體的 Compute 執行個體管理員 (v1) (roles/compute.instanceAdmin.v1) IAM 角色。如要進一步瞭解如何授予角色,請參閱「管理專案、資料夾和機構的存取權」。

      這個預先定義的角色包含重設或重新啟動運算執行個體所需的權限。如要查看確切的必要權限,請展開「必要權限」部分:

      所需權限

      如要重設或重新啟動運算執行個體,您必須具備下列權限:

      • 如要重設執行個體,請按照下列步驟操作: compute.instances.reset
      • 如要從訪客 OS 重新啟動執行個體,請按照下列指示操作: compute.instances.setMetadata

      您或許還可透過自訂角色或其他預先定義的角色取得這些權限。

      重新啟動執行個體

      重新啟動運算執行個體後,執行個體中的訪客作業系統就能在 Compute Engine 傳送 ACPI 關機訊號前,完成執行中的任務。這有助於確保訪客作業系統的乾淨關機作業。

      重新啟動執行個體會清除執行個體使用的記憶體。如果您在執行個體中使用 RAM 磁碟,且需要保留該資料,請先備份資料,再重新啟動執行個體。

      如要重新啟動執行個體,請選取下列任一選項:

      Linux

      1. 如果您尚未連線,請連線至執行個體

      2. 如要重新啟動執行個體,請執行下列指令:

        sudo reboot
        

      Windows

      1. 如果您尚未連線,請使用下列任一方法連線至執行個體:

      2. 如要重新啟動執行個體,請執行下列指令:

        shutdown /r /t 0
        
      3. 選用:如要監控關閉及重新啟動執行個體的程序,請啟用 Windows 開機管理員選單

      重設執行個體

      重設執行個體會清除執行個體記憶體中的所有資料,包括儲存在 RAM 磁碟上的所有暫存檔案。這類資料會永久遺失,而且 Compute Engine 不會在重設執行個體前建立備份。

      您可以同時重設多個執行個體,也可以個別重設。如果是多個執行個體,請使用 Google Cloud 控制台;如果是位於同一區域的執行個體,請使用 Google Cloud CLI。針對個別執行個體,請選取下列任一選項:

      主控台

      1. 前往 Google Cloud 控制台的「VM instances」(VM 執行個體) 頁面

        前往 VM 執行個體

      2. 選取要重設的執行個體。

      3. 依序點選「重設」和「重設」確認操作。

      gcloud

      如要在單一區域中重設一或多個執行中的執行個體,請使用 gcloud compute instances reset 指令

      gcloud compute instances reset INSTANCE_NAMES \
          --zone=ZONE
      

      更改下列內容:

      • INSTANCE_NAMES:以空格分隔的例項名稱清單,例如 instance-01 instance-02 instance-03

      • ZONE:執行個體所在的區域。

      Go

      import (
      	"context"
      	"fmt"
      	"io"
      
      	compute "cloud.google.com/go/compute/apiv1"
      	computepb "cloud.google.com/go/compute/apiv1/computepb"
      )
      
      // resetInstance resets a running Google Compute Engine instance (with unencrypted disks).
      func resetInstance(w io.Writer, projectID, zone, instanceName string) error {
      	// projectID := "your_project_id"
      	// zone := "europe-central2-b"
      	// instanceName := "your_instance_name"
      
      	ctx := context.Background()
      	instancesClient, err := compute.NewInstancesRESTClient(ctx)
      	if err != nil {
      		return fmt.Errorf("NewInstancesRESTClient: %w", err)
      	}
      	defer instancesClient.Close()
      
      	req := &computepb.ResetInstanceRequest{
      		Project:  projectID,
      		Zone:     zone,
      		Instance: instanceName,
      	}
      
      	op, err := instancesClient.Reset(ctx, req)
      	if err != nil {
      		return fmt.Errorf("unable to reset instance: %w", err)
      	}
      
      	if err = op.Wait(ctx); err != nil {
      		return fmt.Errorf("unable to wait for the operation: %w", err)
      	}
      
      	fmt.Fprintf(w, "Instance reset\n")
      
      	return nil
      }
      

      Java

      
      import com.google.api.gax.longrunning.OperationFuture;
      import com.google.cloud.compute.v1.InstancesClient;
      import com.google.cloud.compute.v1.Operation;
      import com.google.cloud.compute.v1.Operation.Status;
      import com.google.cloud.compute.v1.ResetInstanceRequest;
      import java.io.IOException;
      import java.util.concurrent.ExecutionException;
      import java.util.concurrent.TimeUnit;
      import java.util.concurrent.TimeoutException;
      
      public class ResetInstance {
      
        public static void main(String[] args)
            throws IOException, ExecutionException, InterruptedException, TimeoutException {
          // TODO(developer): Replace these variables before running the sample.
          /* project: project ID or project number of the Cloud project your instance belongs to.
             zone: name of the zone your instance belongs to.
             instanceName: name of the instance your want to reset.
           */
          String project = "your-project-id";
          String zone = "zone-name";
          String instanceName = "instance-name";
      
          resetInstance(project, zone, instanceName);
        }
      
        // Resets a running Google Compute Engine instance (with unencrypted disks).
        public static void resetInstance(String project, String zone, String instanceName)
            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 `instancesClient.close()` method on the client to safely
             clean up any remaining background resources. */
          try (InstancesClient instancesClient = InstancesClient.create()) {
      
            ResetInstanceRequest resetInstanceRequest = ResetInstanceRequest.newBuilder()
                .setProject(project)
                .setZone(zone)
                .setInstance(instanceName)
                .build();
      
            OperationFuture, Operation> operation = instancesClient.resetAsync(
                resetInstanceRequest);
            Operation response = operation.get(3, TimeUnit.MINUTES);
      
            if (response.getStatus() == Status.DONE) {
              System.out.println("Instance reset successfully ! ");
            }
          }
        }
      
      }

      Node.js

      /**
       * TODO(developer): Uncomment and replace these variables before running the sample.
       */
      // const projectId = 'YOUR_PROJECT_ID';
      // const zone = 'europe-central2-b'
      // const instanceName = 'YOUR_INSTANCE_NAME'
      
      const compute = require('@google-cloud/compute');
      
      async function resetInstance() {
        const instancesClient = new compute.InstancesClient();
      
        const [response] = await instancesClient.reset({
          project: projectId,
          zone,
          instance: instanceName,
        });
        let operation = response.latestResponse;
        const operationsClient = new compute.ZoneOperationsClient();
      
        // Wait for the operation to complete.
        while (operation.status !== 'DONE') {
          [operation] = await operationsClient.wait({
            operation: operation.name,
            project: projectId,
            zone: operation.zone.split('/').pop(),
          });
        }
      
        console.log('Instance reset.');
      }
      
      resetInstance();

      PHP

      use Google\Cloud\Compute\V1\Client\InstancesClient;
      use Google\Cloud\Compute\V1\ResetInstanceRequest;
      
      /**
       * Reset a running Google Compute Engine instance (with unencrypted disks).
       *
       * @param string $projectId Project ID or project number of the Cloud project your instance belongs to.
       * @param string $zone Name of the zone your instance belongs to.
       * @param string $instanceName Name of the instance you want to reset.
        *
       * @throws \Google\ApiCore\ApiException if the remote call fails.
       * @throws \Google\ApiCore\ValidationException if local error occurs before remote call.
       */
      function reset_instance(
          string $projectId,
          string $zone,
          string $instanceName
      ) {
          // Stop the Compute Engine instance using InstancesClient.
          $instancesClient = new InstancesClient();
          $request = (new ResetInstanceRequest())
              ->setInstance($instanceName)
              ->setProject($projectId)
              ->setZone($zone);
          $operation = $instancesClient->reset($request);
      
          // Wait for the operation to complete.
          $operation->pollUntilComplete();
          if ($operation->operationSucceeded()) {
              printf('Instance %s reset successfully' . PHP_EOL, $instanceName);
          } else {
              $error = $operation->getError();
              printf('Failed to reset instance: %s' . PHP_EOL, $error?->getMessage());
          }
      }
      

      Python

      from __future__ import annotations
      
      import sys
      from typing import Any
      
      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 reset_instance(project_id: str, zone: str, instance_name: str) -> None:
          """
          Resets a stopped Google Compute Engine instance (with unencrypted disks).
          Args:
              project_id: project ID or project number of the Cloud project your instance belongs to.
              zone: name of the zone your instance belongs to.
              instance_name: name of the instance your want to reset.
          """
          instance_client = compute_v1.InstancesClient()
      
          operation = instance_client.reset(
              project=project_id, zone=zone, instance=instance_name
          )
      
          wait_for_extended_operation(operation, "instance reset")
      
      

      REST

      如要重新啟動執行中的執行個體,請對 instances.reset 方法發出 POST 要求:

       POST https://compute.googleapis.com//compute/v1/projects/PROJECT_ID/zones/ZONE/instances/INSTANCE_NAME/reset
      

      更改下列內容:

      • INSTANCE_NAME:執行個體的名稱。

      • PROJECT_ID:執行個體所在專案的 ID。

      • ZONE:執行個體所在的區域。

      後續步驟