第 17 章 使用 Red Hat Quay API
Red Hat Quay 提供完整的 OAuth 2 RESTful API。[OAuth 2] RESTful API 提供了以下优点:
-
它可从 Red Hat Quay 主机的端点
/api/v1
端点获取。例如:https://<quay-server.example.com>/api/v1
。 -
它允许用户通过其浏览器连接到端点,通过启用 Swagger UI 来通过浏览器连接到
GET
、POST
、DELETE
和PUT
Red Hat Quay 设置。 - 它可以被发出 API 调用和使用 OAuth 令牌的应用程序访问。
- 它将数据作为 JSON 发送和接收。
下面的部分论述了如何访问 Red Hat Quay API,使其可用于您的部署。
17.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 端点或端点(如 Repository Mirroring)。
在 API Explorer 中,您可以获得以下相关信息:
- 账单、订阅和计划
- 存储库构建和构建触发器
- 错误消息和全局消息
- 存储库镜像、清单、权限、通知、漏洞和镜像签名
- 使用日志
- 机构、成员和 OAuth 应用程序
- 用户和机器人帐户
- 更多…
选择以打开端点,以查看端点的每个部分的 Model Schema。打开端点,输入任何所需参数(如存储库名称或镜像),然后选择 Try it out!
按钮来查询或更改与 Quay.io 端点关联的设置。