前提条件

本文档介绍了使用 Compute Engine API 的前提条件。

如果您尚未完成一些准备工作,请先完成,然后才能开始编写您的第一个客户端应用。

获取 Google 账号

您需要 Google 账号才能访问 Compute Engine API。如果您已有账号,则表示您已获得访问权限。

您可能还需要一个用来测试的单独 Google 账号。

注册并试用 Compute Engine

首先,您可以使用以下指南之一在 Compute Engine 上创建虚拟机实例:

在继续操作之前,请务必先熟悉 Compute Engine。API 文档假定您已使用 Compute Engine,并且您熟悉 Web 编程概念和 Web 数据格式。

了解身份验证

您可以通过多种不同的方式向 Compute Engine 进行身份验证,具体取决于您访问 API 的方式。如需了解详情,请参阅向 Compute Engine 进行身份验证

了解 REST

您可以通过以下两种方式调用 API:

  • 发送 HTTP 请求并解析响应。
  • 使用客户端库

如果您决定不使用客户端库,则将需要了解 REST 的基础知识。

REST 基础知识

REST 是一种软件架构样式,可提供便利、一致的方法来请求和修改数据。

术语 REST 是“具象状态传输”的简称。在 Google API 的上下文中,指的是使用 HTTP 谓词来检索和修改由 Google 存储的数据的表示法。

在 RESTful 系统中,资源存储在数据存储区中;在客户端发送要求服务器执行特定操作(例如创建、检索、更新或删除资源)的请求之后,服务器便会执行该操作并发送响应,此响应的格式通常为所指定资源的表示法。

在 Google 的 RESTful API 中,客户端使用 HTTP 谓词(例如 POSTGETPUTDELETE)指定操作。它通过以下格式的全局唯一 URI 来指定资源:

https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters

由于所有 API 资源都具有 HTTP 可访问的唯一 URI,因此 REST 启用了数据缓存,而且经过优化以与网络的分布式基础架构一起使用。

您可能会发现 HTTP 1.1 标准文档中的方法定义十分有用;这些定义中包含了 GETPOSTPUTDELETE 的规范。

Compute Engine API 中的 REST

Compute Engine API 操作可直接映射到 REST HTTP 谓词。

Compute Engine API 使用以下 URI 格式:

https://www.googleapis.com/compute/API_VERSION/RESOURCE_PATH

URI 包含以下值:

  • API_VERSION:您要使用的 API 版本,对应于 Compute Engine 资源的发布阶段,如下所示:
    • 对于正式版的资源:v1
    • 对于处于公开预览版阶段的资源:beta
    • 对于处于非公开预览版阶段的资源:alpha
  • RESOURCE_PATH:特定 Compute Engine 资源的路径,例如 projects/example-project/aggregated/instances。如需查看每个 API 版本的可用资源,请参阅以下内容:

如果您想添加查询参数,请在 URI 中的英文问号 (?) 后添加查询:

https://www.googleapis.com/compute/API_VERSION/RESOURCE_PATH?QUERY_PARAMETERS

在 URI 中,QUERY_PARAMETERS 是一个查询参数列表,以 & 符号 (&) 分隔,例如 format=json&filter=zone=us-central1-a

了解 JSON 数据格式

Compute Engine API 以 JSON 格式返回数据。

JSON(JavaScript 对象表示法)是一种与语言无关的常见数据格式,可通过简单的文本来表示任意数据结构。如需了解详情,请参阅 json.org