Admin API 操作直接映射到 REST HTTP 谓词,这意味着您可以使用标准 HTTP 方法来检索和操作资源。
Admin API URI 的具体格式为:
https://appengine.googleapis.com/v1/resourcePath?parameters
例如,如需列出 my-app
项目中应用的 my-
frontend
服务的 my-v1
版本的所有详情,您可以使用 ?view=FULL
参数发送 HTTP 请求:
GET https://appengine.googleapis.com/v1/apps/my-app/services/my-frontend/versions/my-v1?view=FULL
如需了解 Admin API 中支持的各项操作使用的全套 URI,请参阅 App Engine Admin API 参考文档。
了解基础知识
初次使用 REST API?以下资源可帮助您入门。
REST 基础知识
您可以通过以下两种方式调用 Admin API:
- 发送 HTTP 请求并解析响应。
- 使用客户端库。
如果您不打算使用客户端库,则需要了解 REST 的基础知识。
REST 是一种软件架构样式,可提供便捷且一致的方法用于请求和修改数据。
术语 REST 是“具象状态传输”的简称。在 Google API 的上下文中,指的是使用 HTTP 谓词来检索和修改由 Google 存储的数据的表示法。
在 RESTful 系统中,资源存储在数据存储区中;在客户端发送要求服务器执行特定操作(例如创建、检索、更新或删除资源)的请求之后,服务器便会执行该操作并发送响应,此响应的格式通常为所指定资源的表示法。
在 Google 的 RESTful API 中,客户端使用 HTTP 谓词(例如 POST
、GET
、PUT
或 DELETE
)指定操作。它通过以下格式的全局唯一 URI 来指定资源:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
由于所有 API 资源都具有 HTTP 可访问的唯一 URI,因此 REST 启用了数据缓存,而且经过优化以与网络的分布式基础架构一起使用。
您可能会发现 HTTP 1.1 标准文档中的方法定义十分有用;这些定义中包含了 GET
、POST
、PUT
和 DELETE
的规范。
JSON 基础知识
Admin API 以 JSON 格式返回数据。
JSON(JavaScript 对象表示法)是一种与语言无关的常见数据格式,可通过简单的文本来表示任意数据结构。如需了解详情,请参阅 json.org。