常見的 gcloud compute 指令


本文件列出一些最常用的 gcloud compute 指令。

事前準備

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

說明專案

執行下列指令,查詢 Compute Engine 專案的相關資訊,例如專案中繼資料、SSH 金鑰和配額指標:

 gcloud compute project-info describe

如要進一步瞭解如何描述專案,請參閱 gcloud compute project-info describe 參考說明文件。

使用 VM

以下範例說明使用虛擬機器 (VM) 執行個體時的常見工作。如要進一步瞭解虛擬機器 (VM) 執行個體,請參閱「虛擬機器執行個體」。

建立 VM

執行下列指令建立 VM:

gcloud compute instances create VM_NAME \
    [--image IMAGE | --image-family IMAGE_FAMILY] \
    --image-project IMAGE_PROJECT

更改下列內容:

  • VM_NAME:新 VM 的名稱
  • IMAGEIMAGE_FAMILY: 指定下列其中一個選項:
    • IMAGE:公開映像檔的必要版本。例如:--image debian-10-buster-v20200309
    • IMAGE_FAMILY圖片群組。這會使用最新的非淘汰作業系統映像檔建立 VM。舉例來說,如果您指定 --image-family debian-10,Compute Engine 會使用 Debian 10 映像檔系列中的最新 OS 映像檔建立 VM。
  • IMAGE_PROJECT:包含圖片的專案

如要進一步瞭解如何建立 VM,請參閱「建立及啟動 VM 執行個體」一文,以及 gcloud compute instances create 參考說明文件。

列出 VM

執行下列指令,即可顯示專案中的所有 VM:

gcloud compute instances list

如要進一步瞭解如何列出 VM,請參閱 gcloud compute instances list 參考說明文件。

列出具有 GPU 的 VM

執行下列指令,即可顯示專案中所有具有 GPU 的 VM:

gcloud compute instances list --filter="guestAccelerators.acceleratorCount>0" --format="table(name,zone,guestAccelerators.acceleratorType,guestAccelerators.acceleratorCount,disks.type)"

列出含有本機 SSD 的 VM

執行下列指令,即可顯示專案中所有使用本機 SSD 的 VM:

gcloud compute instances list  --filter="disks.type='SCRATCH'"  --format="table(name,zone,guestAccelerators.acceleratorType,guestAccelerators.acceleratorCount,disks.type)"

描述 VM

執行下列指令,顯示與 VM 相關聯的所有資料:

gcloud compute instances describe VM_NAME

VM_NAME 替換為 VM 名稱。

如要進一步瞭解如何描述 VM,請參閱 gcloud compute instances describe 參考說明文件。

啟動 VM

執行下列指令,啟動已停止的 VM:

gcloud compute instances start VM_NAME

VM_NAME 替換為 VM 名稱。

如要進一步瞭解如何啟動 VM,請參閱「啟動及停止執行個體」和 gcloud compute instances start 參考說明文件。

停止 VM

執行下列指令,停止 VM:

gcloud compute instances stop VM_NAME

VM_NAME 替換為 VM 名稱。

如要進一步瞭解如何停止 VM,請參閱「啟動及停止執行個體」一文,以及 gcloud compute instances stop 參考說明文件。

為 VM 新增標籤

執行下列指令,為 VM 新增標籤:

gcloud compute instances add-labels VM_NAME \
    --labels=KEY=VALUE

更改下列內容:

  • VM_NAME:VM 名稱。
  • KEY=VALUE:標籤的鍵/值組合。

如要進一步瞭解如何為 VM 加上標記,請參閱「標記資源」和 gcloud compute instances add-labels 參考說明文件。

連線至 VM

使用 SSH 連線至執行個體

執行下列指令,使用 SSH 連線至 VM:

gcloud compute ssh VM_NAME

VM_NAME 替換為 VM 名稱。

如要進一步瞭解如何使用 SSH 連線至 VM,請參閱「連線至 Linux VM」和 gcloud compute ssh 參考文件。

使用 SCP 將檔案轉移至執行個體

執行下列指令,將檔案複製到 VM:

gcloud compute scp LOCAL_FILE_PATH VM_NAME:REMOTE_DIRECTORY

執行下列指令,從 VM 複製檔案:

gcloud compute scp VM_NAME:REMOTE_DIRECTORY LOCAL_FILE_PATH

更改下列內容:

  • LOCAL_FILE_PATH:工作站上檔案的路徑。
  • VM_NAME:VM 的名稱。
  • REMOTE_DIRECTORY:VM 上目錄的路徑。

如要進一步瞭解如何使用 SCP 將檔案移入和移出 VM,請參閱「使用 Google Cloud CLI 轉移檔案」和 gcloud compute scp 參考說明文件。

使用磁碟

以下範例說明處理磁碟時的常見工作。如要進一步瞭解磁碟,請參閱「儲存空間選項」。

列出磁碟

執行下列指令,即可顯示專案中的所有磁碟:

gcloud compute disks list

如要進一步瞭解如何列出磁碟,請參閱 gcloud compute disks list 參考說明文件。

處理快照

以下範例說明使用快照時的常見工作。如要進一步瞭解快照,請參閱「永久磁碟快照」。

列出快照

執行下列指令,即可顯示專案中的所有快照:

gcloud compute snapshots list

如要進一步瞭解如何描述快照,請參閱 gcloud compute snapshots list 參考說明文件。

說明快照

執行下列指令,顯示與快照相關的所有資料:

gcloud compute snapshots describe SNAPSHOT_NAME

SNAPSHOT_NAME 替換為快照的名稱。

如要進一步瞭解如何描述快照,請參閱 gcloud compute snapshots describe 參考說明文件。

刪除快照

執行下列指令即可刪除快照:

gcloud compute snapshots delete SNAPSHOT_NAME

SNAPSHOT_NAME 替換為快照的名稱。

如要進一步瞭解如何刪除快照,請參閱「刪除快照」和 gcloud compute snapshots delete 參考說明文件。

使用防火牆規則

以下範例說明使用防火牆規則時的常見工作。如要進一步瞭解防火牆規則,請參閱虛擬私有雲防火牆規則總覽

說明防火牆規則

執行下列指令,顯示與防火牆規則相關聯的所有資料:

gcloud compute firewall-rules describe FIREWALL_RULE_NAME

請將 FIREWALL_RULE_NAME 替換為防火牆規則的名稱。

如要進一步瞭解如何描述防火牆規則,請參閱 gcloud compute firewall-rules describe 參考說明文件。

建立防火牆規則

執行下列指令來建立防火牆規則:

gcloud compute firewall-rules create FIREWALL_RULE_NAME \
    [--allow=PROTOCOL:PORT | --action=ACTION --rules=PROTOCOL:PORT]

指定 --allow--action--rules,然後取代以下內容:

  • FIREWALL_RULE_NAME:防火牆規則的名稱。
  • ACTION:相符時執行的動作。allowdeny
  • PROTOCOL:PORT:通訊協定和通訊埠,其流量會受到防火牆規則影響。

如要進一步瞭解如何建立防火牆規則,請參閱「建立防火牆規則」和 gcloud compute firewall-rules create 參考文件。

使用代管執行個體群組 (MIG)

以下範例說明使用 MIG 時的常見工作。如要進一步瞭解 MIG,請參閱「代管執行個體群組 (MIG)」一文。

建立代管執行個體群組

執行下列指令建立 MIG:

gcloud compute instance-groups managed create INSTANCE_GROUP_NAME \
    --size=SIZE \
    --template=INSTANCE_TEMPLATE_URL

更改下列內容:

  • INSTANCE_GROUP_NAME:這個執行個體群組的名稱
  • SIZE:執行個體群組的大小
  • INSTANCE_TEMPLATE_URL:您要在 MIG 中用來建立 VM 的執行個體範本網址。網址可以包含執行個體範本的ID 或名稱。請指定下列其中一個值:
    • 區域執行個體範本:projects/PROJECT_ID/regions/REGION/instanceTemplates/INSTANCE_TEMPLATE_ID
    • 全域執行個體範本:INSTANCE_TEMPLATE_ID

如要進一步瞭解如何建立 MIG,請參閱「建立 MIG 的基本情境」和 gcloud compute instance-groups managed create 參考說明文件。

設定自動調度資源

執行下列指令,根據 CPU 使用率在 MIG 上設定自動調度資源:

gcloud compute instance-groups managed set-autoscaling INSTANCE_GROUP_NAME \
    --max-num-replicas=MAX_NUM_REPLICAS \
    --target-cpu-utilization=TARGET_CPU_UTILIZATION

更改下列內容:

  • INSTANCE_GROUP_NAME:MIG 名稱
  • MAX_NUM_REPLICAS:自動調整器可建立的備援機制數量上限
  • TARGET_CPU_UTILIZATION:自動配置器應維持的 CPU 等級,介於 0.01.0 之間

如要進一步瞭解如何設定自動調度功能,請參閱「自動調度執行個體群組資源」和 gcloud compute instance-groups managed set-autoscaling 參考文件。

使用中繼資料

以下範例說明使用中繼資料時的常見工作。如要進一步瞭解中繼資料,請參閱「儲存和擷取中繼資料」。

新增專案層級中繼資料

執行下列指令,為專案新增中繼資料:

gcloud compute project-info add-metadata VM_NAME \
    --metadata=KEY=VALUE,[KEY=VALUE]

更改下列內容:

  • VM_NAME:VM 名稱
  • KEY=VALUE:中繼資料鍵/值組合

如要進一步瞭解如何在 VM 中新增中繼資料,請參閱「設定全專案自訂中繼資料」和 gcloud compute project-info add-metadata 參考文件。

新增執行個體層級中繼資料

執行下列指令,將中繼資料新增至 VM:

gcloud compute instances add-metadata VM_NAME \
    --metadata=KEY=VALUE,[KEY=VALUE]

更改下列內容:

  • VM_NAME:VM 名稱
  • KEY=VALUE:中繼資料鍵/值組合

如要進一步瞭解如何在 VM 中加入中繼資料,請參閱「設定執行個體中繼資料」和 gcloud compute instances add-metadata 參考說明文件。

取得說明頁面

下列指令示範了各種不同的說明類型存取方式,包括 gcloud compute 指令的一般說明,乃至資源群組 (instances) 或指令 (create) 的特定說明。所有資源與指令的完整說明皆會按照以下模式:

gcloud compute --help
gcloud compute instances --help
gcloud compute instances create --help

您可使用 -h 旗標替代 --help 旗標來取得快速說明,也可以查看 Google Cloud CLI 參考資料中的所有詳盡說明。

如需設定 gcloud CLI 專用指令的完整說明,請執行:

gcloud topic TOPIC

TOPIC 替換為您需要說明的主題。如需可取得說明的主題清單,請參閱 gcloud topic 參考資料說明文件。

後續步驟