第 5 章 启用并使用 Red Hat Quay API
通过使用 Red Hat Quay API,您可以简化容器 registry 管理,自动执行任务,并将 Red Hat Quay 的功能整合到现有工作流中。这可以提高效率,提供更高的灵活性(通过存储库管理、用户管理、用户权限、镜像管理等),提高您的组织的稳定性、存储库或整体部署等。
以下章节解释了如何启用和使用 Red Hat Quay API。
5.1. 使用 Red Hat Quay API 复制链接链接已复制到粘贴板!
创建应用程序并使用所需设置生成 OAuth 2 访问令牌后,您可以通过使用 CLI 的 API 将访问令牌传递给 GET、PUT、POST 或 DELETE 设置。通常,Red Hat Quay API 命令类似以下示例:
$ curl -X GET -H "Authorization: Bearer <your_access_token>" \
https://<quay-server.example.com>/api/v1/<example>/<endpoint>/
所有 Red Hat Quay API 均记录在 应用程序编程接口(API) 章节中。了解它们的记录方式对于成功调用至关重要。例如,为 createAppToken API 端点使用以下条目:
*createAppToken*
Create a new app specific token for user.
*POST /api/v1/user/apptoken*
**Authorizations: **oauth2_implicit (**user:admin**)
Request body schema (application/json)
*Path parameters*
Name: **title**
Description: Friendly name to help identify the token.
Schema: string
*Responses*
|HTTP Code|Description |Schema
|201 |Successful creation |
|400 |Bad Request |<<_apierror,ApiError>>
|401 |Session required |<<_apierror,ApiError>>
|403 |Unauthorized access |<<_apierror,ApiError>>
|404 |Not found |<<_apierror,ApiError>>
|===
要使用 API 端点,您可以传递访问令牌,然后根据您的需要包含适当的字段。以下流程演示了如何使用 POST /api/v1/user/apptoken 端点。
先决条件
- 您可以访问 Red Hat Quay API,它要求已创建了 OAuth 2 访问令牌。
流程
输入
POST /api/v1/user/apptokenAPI 调用来创建用户应用程序:$ curl -X POST \ -H "Authorization: Bearer <access_token>"1 -H "Content-Type: application/json" \ -d '{ "title": "MyAppToken"2 }' \ "http://quay-server.example.com/api/v1/user/apptoken"3 输出示例
{"token": {"uuid": "6b5aa827-cee5-4fbe-a434-4b7b8a245ca7", "title": "MyAppToken", "last_accessed": null, "created": "Wed, 08 Jan 2025 19:32:48 -0000", "expiration": null, "token_code": "string"}}
验证
在 Red Hat Quay UI 中,在导航窗格
Account Settings 中点您的用户名。应用的名称显示在 Docker CLI 和其他应用程序 Tokens 标题下。例如: