gcloud CLI 一覽表

Google Cloud CLI 的常用指令清單，這是 Google Cloud的主要指令列工具。

(還包括：入門指南、瞭解指令和可列印的 PDF 檔案)。

一覽表

開始使用

開始使用 gcloud CLI。

• gcloud init：初始化、授權及設定 gcloud CLI。
• gcloud version：顯示版本和已安裝的元件。
• gcloud components install：安裝特定元件。
• gcloud components update：將 gcloud CLI 更新至最新版本。
• gcloud config set project：設定要處理的預設 Google Cloud 專案。
• gcloud info：顯示目前的 gcloud CLI 環境詳細資料。

說明

gcloud CLI 很樂意提供協助。

• gcloud help：在 gcloud CLI 參考文件中搜尋特定字詞。
• gcloud feedback：向 gcloud CLI 團隊提供意見回饋。
• gcloud topic：非指令主題的補充說明資料，例如無障礙功能、篩選和格式設定。

個人化

自訂 gcloud CLI，使用屬性個人化設定。

• gcloud config set：為目前的設定定義屬性 (例如 compute/zone)。
• gcloud config get：擷取 gcloud CLI 屬性的值。
• gcloud config list：顯示目前設定的所有屬性。
• gcloud config configurations create：建立新的具名設定。
• gcloud config configurations list：顯示所有可用設定的清單。
• gcloud config configurations activate：切換至現有的具名設定。

授權和憑證

授予及撤銷 gcloud CLI 的授權，並管理憑證。

• gcloud auth login：使用Google Cloud 者憑證授權 gcloud CLI 存取權，並將目前帳戶設為有效。Google Cloud
• gcloud auth activate-service-account： 授權 Google Cloud 存取權，與 gcloud auth login 類似，但使用服務帳戶憑證。
• gcloud auth application-default： 管理 Cloud 用戶端程式庫的應用程式預設憑證 (ADC)。
• gcloud auth list：列出所有已通過驗證的帳戶。
• gcloud auth print-access-token： 顯示目前帳戶的存取權杖。
• gcloud auth revoke：移除帳戶的存取憑證。

專案

管理專案存取權政策。

• gcloud projects describe：顯示專案的中繼資料 (包括 ID)。
• gcloud projects add-iam-policy-binding： 將 IAM 政策繫結新增至指定專案。

IAM

設定身分與存取權管理 (IAM) 偏好設定和服務帳戶。

• gcloud iam list-grantable-roles： 列出資源可授予的 IAM 角色。
• gcloud iam roles create： 為專案或機構建立自訂角色。
• gcloud iam service-accounts create： 為專案建立服務帳戶。
• gcloud iam service-accounts add-iam-policy-binding： 將 IAM 政策繫結新增至服務帳戶。
• gcloud iam service-accounts set-iam-policy-binding: 取代現有的 IAM 政策繫結。
• gcloud iam service-accounts keys list： 列出服務帳戶的金鑰。

Docker 和 Google Kubernetes Engine (GKE)

在 Kubernetes 上管理容器化應用程式。

• gcloud auth configure-docker： 將 gcloud CLI 註冊為 Docker 憑證輔助程式。
• gcloud container clusters create： 建立叢集來執行 GKE 容器。
• gcloud container clusters list： 列出用於執行 GKE 容器的叢集。
• gcloud container clusters get-credentials： 更新 kubeconfig，讓 kubectl 使用 GKE 叢集。
• gcloud container images list-tags：列出容器映像檔的標記和摘要中繼資料。

虛擬機器和 Compute Engine

在 Google Cloud 基礎架構上建立、執行及管理 VM。

• gcloud compute zones list： 列出 Compute Engine 區域。
• gcloud compute instances create： 建立 VM 執行個體。
• gcloud compute instances describe：顯示 VM 執行個體的詳細資料。
• gcloud compute instances list： 列出專案中的所有 VM 執行個體。
• gcloud compute disks snapshot： 建立永久磁碟的快照。
• gcloud compute snapshots describe： 顯示快照詳細資料。
• gcloud compute snapshots delete： 刪除快照。
• gcloud compute ssh：使用 SSH 連線至 VM 執行個體。

無伺服器與 App Engine

在全代管的無伺服器平台上建構具備高擴充性的應用程式

• gcloud app deploy：將應用程式的程式碼和設定部署至 App Engine 伺服器。
• gcloud app versions list：列出部署至 App Engine 伺服器的所有服務的所有版本。
• gcloud app browse：在網路瀏覽器中開啟目前的應用程式。
• gcloud app create：在目前專案中建立 App Engine 應用程式。
• gcloud app logs read：顯示最新的 App Engine 應用程式記錄。

其他

可能派得上用場的指令

• gcloud kms decrypt：使用 Cloud Key Management Service 金鑰解密密文 (成為純文字檔案)。
• gcloud logging logs list：列出專案的記錄。
• gcloud sql backups describe： 顯示 Cloud SQL 執行個體備份的相關資訊。
• gcloud sql export sql：將 Cloud SQL 執行個體中的資料匯出至 SQL 檔案。

入門指南

快速入門導覽課程：說明如何開始使用 gcloud CLI。

安裝 Google Cloud CLI

按照這些安裝說明安裝 Google Cloud CLI。

旗標、引數和其他精彩功能

引數可以是位置引數或旗標：

• 位置引數：在指令名稱後設定，必須遵守位置引數的順序。

• 旗標：在位置引數後設定，旗標順序不重要。

  標記可以是下列任一項：

  • 名稱/值組合 (--foo=bar)，或
  • Boolean (--force/no-force)。

  此外，旗標可以是：

  • 必要
  • 選用：如未定義選用旗標，系統會使用預設值

通用標記

部分旗標可在整個 gcloud CLI 體驗中使用，例如：

• --help：如有疑問，請使用這個指令，顯示指令的詳細說明。
• --project：如果使用非目前的專案。
• --quiet：停用互動式提示 (並為輸入內容套用預設值)。
• --verbosity： 可將詳細程度等級設為 debug、info、warning、error、critical 和 none。
• --version： 顯示 gcloud 版本資訊。
• --format：將輸出格式設為 config、csv、default、diff、disable、flattened、get、json、list、multi、none、object、table、text、value 或 yaml。

清除結果

使用篩選器、格式、限制和排序依據標記，充分發揮輸出內容的效用。

如果是前置字元為 us 且不是機型的 Compute Engine 執行個體 f1-micro：

gcloud compute instances list --filter="zone ~ ^us AND -machineType:f1-micro"

如要查看 2018 年 1 月 15 日當天或之後建立的專案清單 (依建立時間排序，從舊到新)，請參閱下表。表格會列出專案編號、專案 ID 和建立時間，並以當地時區顯示日期和時間：

gcloud projects list --format="table(projectNumber,projectId,createTime.date(tz=LOCAL))"
--filter="createTime>=2018-01-15T12:00:00" --sort-by=createTime

如要列出標籤為 my-label (任何值) 的十個 Compute Engine 執行個體：

gcloud compute instances list --filter="labels.my-label:*" --limit=10

瞭解指令

gcloud CLI 指令的基礎模式，有助於自行探索指令。

尋找 gcloud CLI 指令

gcloud CLI 是一棵樹，非葉節點是指令群組，葉節點則是指令。(此外，Tab 鍵自動完成功能也適用於指令和資源！)

大多數 gcloud 指令都採用下列格式：

gcloud + release level (optional) + component + entity + operation + positional args + flags

例如：gcloud + compute + instances + create + example-instance-1 + --zone=us-central1-a

版本層級

發布層級是指指令的發布狀態。

範例：Alpha 版指令為 alpha，Beta 版指令為 beta，正式版指令則不需要發布層級。

元件

「元件」是指不同的 Google Cloud 服務。

範例：Compute Engine 為 compute，App Engine 為 app 等。

實體

「實體」是指元件下元素或元素集合的複數形式。

示例： disks、firewalls、images、instances、regions、zones (適用於運算)

作業

「作業」是指要對實體執行的作業的祈使動詞形式。

示例：常見的作業包括 describe、list、create/update、delete/clear、import、export、copy、remove、add、reset、restart、restore、run 和 deploy。

位置引數

位置引數是指執行指令時，必須依特定順序提供的引數。

範例： <INSTANCE_NAMES> 是 gcloud compute instances create 的必要位置引數。

旗標

旗標是指傳遞至指令的其他引數 --flag-name(=value) (位於位置引數之後)。

範例： --machine-type=<MACHINE_TYPE> 和 --preemptible 是 gcloud compute instances create 的選用標記。