gcloud 命令行工具概览

该页面概述了 gcloud 命令行工具及其常用命令模式和功能。

什么是 gcloud 命令行工具?

gcloud 命令行界面是创造和管理Google Cloud 资源的主要 CLI 工具。借助此工具,您可以通过命令行或使用脚本和其他自动化功能执行多项常见平台任务。

例如,您可以使用 gcloud CLI 来创建和管理以下各项:

  • Google Compute Engine 虚拟机实例和其他资源
  • Google Cloud SQL 实例
  • Google Kubernetes Engine 集群
  • Google Cloud Dataproc 集群和作业
  • Google Cloud DNS 托管地区和记录集
  • Google Cloud Deployment Manager 部署

您还可以使用 gcloud CLI 部署 App Engine 应用程序,管理身份验证,自定义本地配置以及执行其他任务。如需详细了解此工具的功能,请参阅 gcloud CLI 参考

gcloud 命令行工具备忘单

如需快速了解 gcloud 命令行工具,常用命令列表以及这些命令的结构,请参阅 gcloud 命令行工具备忘单

gcloud CLI 和 Cloud SDK

gcloud CLI 是 Google Cloud SDK 的一部分。您必须在系统上 下载并安装 SDK,再 执行 SDK 初始化,然后才能使用 gcloud 命令行工具。

默认情况下,SDK 仅安装处于“正式版”级别的 gcloud CLI 命令。名为 alphabeta 的 SDK 组件 中提供了额外的功能。借助这些组件,您可以将 gcloud CLI 用于版本级别低于“正式版”的 Google Cloud Bigtable、Google Cloud Dataflow 以及 Cloud Platform 的其他组件。

gcloud CLI 版本与 SDK 具有相同的版本号。当前 SDK 版本是 310.0.0。您可以从下载归档下载并安装旧版 SDK。

下载 gcloud 命令行工具

您可以从下载页面下载最新版本的 Cloud SDK(其中包含 gcloud 命令行工具)。

版本级别

gcloud CLI 命令具有以下版本级别:

版本级别 标签 说明
正式版 命令被视为完全稳定,并且可以在生产环境中使用。对于那些破坏当前功能的命令,我们会提前发出警告,并会在版本说明中记录这些警告。
测试版 beta 命令在功能上是完整的,但可能仍然存在一些未解决的问题。我们可能会对这些命令做出重大更改,恕不另行通知。
Alpha 版 alpha 命令处于早期版本阶段,我们可能会对命令做出更改,恕不另行通知。

安装 SDK 时,系统默认不会安装 alphabeta 组件。您必须使用 gcloud components install 命令单独 安装这些组件。如果您尝试运行 Alpha 版或测试版命令并且未安装相应的组件,则 gcloud 命令行工具会提示您安装这些组件。

命令组

在每个版本级别中,gcloud CLI 命令都会被整理为命令组的嵌套层次结构,每个命令组代表 Cloud Platform 或其子功能组的一个产品或功能。

例如:

命令组 说明
gcloud compute 与 Compute Engine 相关的命令(正式版)
gcloud compute instances 与 Compute Engine 实例相关的命令(正式版)
gcloud beta compute 与 Compute Engine 相关的命令(测试版)
gcloud alpha app 与管理 App Engine 部署有关的命令(Alpha 版)

运行 gcloud CLI 命令

您可以像使用其他命令行工具一样,通过命令行运行 gcloud CLI 命令。您还可以通过脚本和其他自动化功能运行 gcloud CLI 命令,例如,在使用 Jenkins 自动执行 Cloud Platform 任务时运行这些命令。

属性

gcloud CLI 属性是可对 gcloud CLI 和其他 Cloud SDK 工具的行为产生影响的设置。您可以通过全局标志或命令标志设置其中一些属性。在这种情况下,系统将优先采用由标志设置的值。

您可以在此处找到可用属性的列表。

启用无障碍功能

如需获得更精简的屏幕阅读器体验,gcloud 命令行工具会附带 accessibility/screen_reader 属性。

如需启用此属性,请运行以下命令:

gcloud config set accessibility/screen_reader true

如需详细了解 gcloud 命令行工具附带的无障碍功能,请参阅 启用无障碍功能 指南。

配置

配置是一组指定的 gcloud CLI 属性。其工作原理从本质上类似于配置文件

从 Cloud SDK 开始,您将使用一个名为 default 的配置,您可以通过运行 gcloud initgcloud config set 来设置属性。这个单一的默认配置适用于大多数用例。

如果您想要处理多个项目或使用多个授权帐号,您可以使用 gcloud config configurations create 设置多个配置并在这些配置之间进行相应切换。在这些配置中,您可以自定义属性。例如,要在活动配置中设置项目,请使用 project 属性:gcloud config set project <project-id>

如需查看这些概念的详细说明,请参阅这些与 配置 及其 管理方式 有关的探索内容。

全局标志

gcloud CLI 提供了一组 gcloud CLI 范围内适用的标志,这些标志可对每次调用命令时的命令行为进行管理。这些标志还可替换 SDK 属性中设置的任何值。

位置参数和标志

尽管位置参数和标志都会影响 gcloud CLI 命令的输出,但它们的用例之间存在细微的差异。位置参数用于定义运行命令的实体,同时还需要使用标志来设置命令行为的变化。

使用 stdout 和 stderr

gcloud CLI 命令的成功输出会被写入 stdout。 所有其他类型的响应(提示、警告和错误)都会被写入 stderr。 请注意,写入 stderr 的所有内容均不稳定,您不应针对这些内容编写脚本。

要查看与处理输出有关的准则清单,请参阅本章节

提示

为了防止执行意外的破坏性操作,gcloud CLI 会在执行 gcloud projects delete 等命令之前确认您的意图。

如果您想要使用 gcloud compute instances create test-instance 来创建 Google Compute Engine 虚拟机实例(例如“test-instance”),则系统也会显示提示。系统将要求您选择创建的实例所在的地区。

如需停用提示,请使用 --quiet 标志。

请注意,提示的用语可能会发生更改,您不应针对这些用语编写脚本。

禁止提示、对终端执行写入操作以及日志记录

gcloud CLI 的 --quiet 标志(也可写作 -q)可停用运行 gcloud CLI 命令时的所有交互式提示,此功能在编写脚本时十分有用。在需要输入的情况下,系统将使用默认值。如果没有默认值,将引发错误。

如需禁止在终端的标准输出和标准错误中显示命令输出,请使用 --no-user-output-enabled 标志。

如需调整日志的详细程度,请使用具有适当级别(调试,信息,警告,错误,严重或无)的 --verbosity 标志。

确定输出结构

默认情况下,当 gcloud CLI 命令返回资源列表时,这些资源将以整齐的格式显示为标准输出。为了生成更有意义的输出,您可以通过格式、过滤器和投影标志对输出进行微调。

如果您只想定义输出的格式,请使用 --format 标志 来生成表格式或展平版本的输出(用于交互式显示),或生成机器可读版本的输出(jsoncsvyamlvalue)。

如需设置用于选择资源数据值的键列表的格式,请使用 projections。如需根据您定义的条件进一步优化输出,请使用 filter

如果您想通过快速互动教程来帮助您熟悉过滤器和格式功能,请点击以下链接。

在 Cloud Shell 中打开

后续步骤