第 1 章 使用 Red Hat Quay API

Red Hat Quay 提供了完整的 OAuth 2 RESTful API,它:

  • 可通过 URL https://<yourquayhost>/api/v1的每个 Red Hat Quay 实例端点提供
  • 您可以通过浏览器连接到端点,通过启用 Swagger UI 来获取、删除、发布并放置 Red Hat Quay 设置
  • 可以通过发出 API 调用的应用访问并使用 OAuth 令牌
  • 以 JSON 格式发送和接收数据

以下文本描述了如何访问 Red Hat Quay API,并使用它来查看和修改 Red Hat Quay 集群中的设置。下一节将列出并描述 API 端点。

1.1. 从 Quay.io 访问 Quay API

如果您还没有运行自己的 Red Hat Quay 集群,您可以从 Web 浏览器浏览 Quay.io 中的 Red Hat Quay API:

https://docs.quay.io/api/swagger/

出现的 API Explorer 显示 Quay.io API 端点。您不会看到 Quay.io 上未启用的 Red Hat Quay 功能的超级用户 API 端点或端点(如存储库镜像)。

在 API Explorer 中,您可以获得并有时变化,以及以下信息:

  • 账单、订阅和计划
  • 仓库构建和构建触发器
  • 错误消息和全局消息
  • 仓库镜像、清单、权限、通知、漏洞和镜像签名
  • 使用日志
  • 机构、成员和 OAuth 应用程序
  • 用户和机器人帐户
  • 和更多…​

选择打开端点,以查看端点的每个部分的 Model Schema。打开端点,输入任何所需的参数(如存储库名称或镜像),然后选择 Try it out! 按钮以查询或更改与 Quay.io 端点关联的设置。