本页面简要介绍 Google Cloud CLI 及其常见命令模式和功能。
什么是 gcloud CLI?
Google Cloud CLI 是一套用于创建和管理 Google Cloud 资源的工具。借助这些工具,您可以通过命令行或通过脚本和其他自动化功能执行许多常见的平台任务。
例如,您可以使用 gcloud CLI 创建和管理以下内容:
- Compute Engine 虚拟机实例和其他资源
- Cloud SQL 实例
- Google Kubernetes Engine 集群
- Managed Service for Apache Spark 集群和作业
- Cloud DNS 托管可用区和记录集
- Cloud Deployment Manager 部署
您还可以使用 gcloud CLI 部署 App Engine 应用程序,管理身份验证,自定义本地配置以及执行其他任务。
下载并安装 gcloud CLI
当前 gcloud CLI 版本为 564.0.0。
虽然我们强烈建议您使用当前版本的 gcloud CLI,但您也可以从下载归档下载并安装先前版本 。
如果您使用的是 Cloud Shell,则 gcloud CLI 会自动提供,您无需安装。否则, 请下载并安装 gcloud CLI,然后 对其进行初始化。
默认情况下,gcloud CLI 安装正式版级别的命令。gcloud CLI 组件中提供了额外的功能,这些组件名为 alpha、beta 和 preview。借助这些组件
,您可以将 gcloud CLI 用于版本级别低于“正式版”的 Bigtable
、Dataflow 以及其他组件 Google Cloud 。
gcloud CLI 备忘单
如需快速了解 gcloud CLI、常用 命令列表以及这些命令的结构,请参阅 gcloud CLI 备忘单。
版本级别
gcloud CLI 命令具有以下版本级别:
| 版本级别 | 标签 | 说明 |
|---|---|---|
| 正式版 | 无 | 命令被视为完全稳定,并且可以在生产环境中使用。如需取得破坏当前功能的命令的更改的提前通知,请参阅版本说明。 |
| 预览 | preview |
命令处于预览版级别,用于收集客户的反馈。预览版产品通常会公开发布,但功能不一定完整,不提供服务等级协议 (SLA),也没有技术支持承诺。除非 Google 另有说明,否则预览版产品 仅适用于测试环境。预览版阶段平均持续约六个月。 |
| Beta 版 | beta |
命令在功能上是完整的,但可能仍然存在一些未解决的问题。我们可能会对这些命令做出重大更改,恕不另行通知。 |
| Alpha | alpha |
命令处于早期版本阶段,我们可能会对命令做出更改,恕不另行通知。 |
安装 gcloud CLI 时,系统不会默认安装 alpha、beta 和 preview 组件。您必须单独安装这些组件
使用 gcloud components install 命令。如果您尝试运行 Alpha 版、Beta 版或预览版命令但未安装相应的组件,gcloud CLI 会提示您安装这些组件。
命令组
在每个版本级别中,gcloud CLI 命令都会整理到一个由命令组构成的 嵌套层次结构中,每个命令组都代表的一个产品或 功能或 Google Cloud 其子功能组。
例如:
| 命令组 | 说明 |
|---|---|
gcloud compute |
与 Compute Engine 相关的命令(正式版) |
gcloud compute instances |
与 Compute Engine 实例相关的命令(正式版) |
gcloud beta compute |
与 Compute Engine 相关的命令(测试版) |
gcloud preview |
与相关的命令(预览版) Google Cloud |
gcloud alpha app |
与管理 App Engine 部署有关的命令(Alpha 版) |
运行 gcloud CLI 命令
您可以通过命令行以及 脚本和其他自动化功能运行 gcloud CLI 命令。例如,在使用 Jenkins 自动执行 Google Cloud 任务时运行这些命令。
属性
gcloud CLI 属性是可 影响 gcloud CLI 工具 行为的设置。您可以通过全局选项或命令选项设置其中一些属性。在这种情况下,系统将优先采用由选项设置的值。
启用无障碍功能
如需获得更精简的屏幕阅读器体验,可以使用 gcloud CLI 附带的 accessibility/screen_reader 属性。
如需启用无障碍属性,请运行以下命令:
gcloud config set accessibility/screen_reader true
如需详细了解 gcloud 命令行工具附带的无障碍功能,请参阅启用无障碍功能指南。
配置
配置是一组 gcloud CLI 属性。配置的工作原理类似于 配置文件。
开始使用 gcloud CLI 时,您将使用名为 default 的单个配置,您可以通过运行 gcloud init 或 gcloud config set 来设置属性。这个单一的默认配置适用于大多数用例。
如需处理多个项目或使用多个授权账号,您可以使用 gcloud config configurations create 设置多个配置并在这些配置之间切换。在配置中,您可以自定义属性。例如,要在活动配置中设置项目,请使用 project 属性:
gcloud config set project <project-id>
如需查看这些概念的详细说明,请参阅配置指南。
全局选项
gcloud CLI 提供了一组 gcloud CLI 选项 ,可控制每次调用命令时的命令行为。选项会替换 gcloud CLI 属性中设置的值。
位置参数和选项
尽管位置参数和选项都会影响 gcloud CLI 命令的输出结果,但它们的使用场景有细微的差异。位置参数用于定义运行命令的实体,而选项用于设置命令行为的变化。
使用 stdout 和 stderr
成功 gcloud CLI 命令的输出将写入 stdout。所有其他类型的响应(提示、警告和错误)都会写入 stderr。请勿针对写入 stderr 的响应编写脚本,因为这些响应不稳定。
如需查看处理输出的准则,请参阅脚本指南。
提示
为了防止执行意外的破坏性操作,gcloud CLI 会在执行 gcloud projects delete 等命令之前确认您的意图。
当需要其他信息时,系统可能会提示您。
例如,当您使用 gcloud compute instances create test-instance 创建 Compute Engine 虚拟机实例时,系统会要求您选择可用区。
如需停用提示,请使用 --quiet 选项。
请勿根据提示措辞编写脚本,因为措辞可能会发生变化。
禁止提示、对终端执行写入操作以及日志记录
--quiet 选项(也可使用 -q)会
在运行 gcloud CLI 命令时停用所有交互式提示,这对编写脚本很有用。如果需要输入,则使用默认值。如果没有默认值,则会引发错误。
如需禁止在终端的标准输出和标准错误中显示命令输出,请使用 --no-user-output-enabled 选项。
如需调整日志的详细程度,请使用 --verbosity 选项指定详尽程度(调试、信息、警告、错误、严重或无)。
确定输出结构
默认情况下,当 gcloud CLI 命令返回资源列表时,这些资源将以整齐的格式显示在标准输出中。为了生成更有意义的输出,您可以通过 format、filter 和 projection 选项对输出进行微调。
若只需定义输出的格式,请使用 --format 选项来生成表格式或展平版本的输出(用于交互式显示),或生成机器可读版本的输出(json、csv、yaml、value)。
如需设置用于选择资源数据值的键列表的格式,请使用 projections。如需根据您定义的条件进一步优化
输出,请使用
filter。
后续步骤
- 如需详细了解 gcloud CLI 命令,请参阅 gcloud CLI 参考。
