gcloud CLI 备忘单

Google Cloud 的主要命令行工具 Google Cloud CLI 的参考命令清单。

（其中还包括：入门介绍、了解命令和可打印的 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：定义当前配置的属性（例如计算/可用区）。
• 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 用户凭据授权 Google Cloud 访问 gcloud CLI，并将当前帐号设置为活跃帐号。
• 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

配置 Identity and Access Management (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 基础架构上创建、运行和管理虚拟机。

• gcloud compute zones list：列出 Compute Engine 可用区。
• gcloud compute instances create：创建虚拟机实例。
• gcloud compute instances describe：显示虚拟机实例的详细信息。
• gcloud compute instances list：列出项目中的所有虚拟机实例。
• gcloud compute disks snapshot：创建永久性磁盘的快照。
• gcloud compute snapshots describe：显示快照的详细信息。
• gcloud compute snapshots delete：删除快照。
• gcloud compute ssh：使用 SSH 连接到虚拟机实例。

无服务器和 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 而非机器类型 f1-micro 的 Compute Engine 实例：

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（任意值）的 10 个 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，GA 命令不需要版本级别。

组件

组件是指不同的 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 的可选标志。