7.9. mirror
7.9.1. syncCancel
为给定 Repository 的镜像配置更新 sync_status。
POST /api/v1/repository/{repository}/mirror/sync-cancel
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 201 | 成功创建 | |
| 400 | 错误请求 | |
| 401 | 需要会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
示例命令
$ curl -X POST "https://<quay-server.example.com>/api/v1/repository/<namespace>/<repo>/mirror/sync-cancel" \
7.9.2. syncNow
为给定 Repository 的镜像配置更新 sync_status。
POST /api/v1/repository/{repository}/mirror/sync-now
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 201 | 成功创建 | |
| 400 | 错误请求 | |
| 401 | 需要会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
示例命令
$ curl -X POST "https://<quay-server.example.com>/api/v1/repository/<namespace>/<repo>/mirror/sync-now" \
-H "Authorization: Bearer <access_token>"7.9.3. getRepoMirrorConfig
返回一个给定存储库的 Mirror 配置。
GET /api/v1/repository/{repository}/mirror
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功调用 | |
| 400 | 错误请求 | |
| 401 | 需要会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
示例命令
$ curl -X GET "https://<quay-server.example.com>/api/v1/repository/<namespace>/<repo>/mirror" \
-H "Authorization: Bearer <access_token>"7.9.4. changeRepoMirrorConfig
允许用户修改存储库的镜像配置。
PUT /api/v1/repository/{repository}/mirror
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
请求正文模式(application/json)
更新存储库镜像配置。
| 名称 | 描述 | 模式 |
|---|---|---|
|
is_enabled | 用于启用或禁用同步。 | 布尔值 |
|
external_reference | 外部存储库的位置。 | 字符串 |
|
external_registry_username | 用于与外部 registry 进行身份验证的用户名。 | |
|
external_registry_password | 用于与外部 registry 进行身份验证的密码。 | |
|
sync_start_date | 决定此存储库下次准备同步的时间。 | 字符串 |
|
sync_interval | next_start_date 开始同步后的秒数。 | 整数 |
|
robot_username | 用于镜像推送的机器人的用户名。 | 字符串 |
|
root_rule | 用于决定应同步哪些标签的 glob-patterns 列表。 | 对象 |
|
external_registry_config | 对象 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 201 | 成功调用 | |
| 400 | 错误请求 | |
| 401 | 需要会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
示例命令
$ curl -X PUT "https://<quay-server.example.com>/api/v1/repository/<namespace>/<repo>/mirror" \
-H "Authorization: Bearer <access_token>" \
-H "Content-Type: application/json" \
-d '{
"is_enabled": <false>, 1
"external_reference": "<external_reference>",
"external_registry_username": "<external_registry_username>",
"external_registry_password": "<external_registry_password>",
"sync_start_date": "<sync_start_date>",
"sync_interval": <sync_interval>,
"robot_username": "<robot_username>",
"root_rule": {
"rule": "<rule>",
"rule_type": "<rule_type>"
}
}'- 1
- 禁用自动同步。
7.9.5. createRepoMirrorConfig
为给定存储库创建一个 RepoMirrorConfig。
POST /api/v1/repository/{repository}/mirror
授权： oauth2_implicit (repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
需要 仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
请求正文模式(application/json)
创建存储库镜像配置。
| 名称 | 描述 | 模式 |
|---|---|---|
|
is_enabled | 用于启用或禁用同步。 | 布尔值 |
|
external_reference | 外部存储库的位置。 | 字符串 |
|
external_registry_username | 用于与外部 registry 进行身份验证的用户名。 | |
|
external_registry_password | 用于与外部 registry 进行身份验证的密码。 | |
|
sync_start_date | 决定此存储库下次准备同步的时间。 | 字符串 |
|
sync_interval | next_start_date 开始同步后的秒数。 | 整数 |
|
robot_username | 用于镜像推送的机器人的用户名。 | 字符串 |
|
root_rule | 用于决定应同步哪些标签的 glob-patterns 列表。 | 对象 |
|
external_registry_config | 对象 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 201 | 成功创建 | |
| 400 | 错误请求 | |
| 401 | 需要会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
示例命令
$ curl -X POST "https://<quay-server.example.com>/api/v1/repository/<namespace>/<repo>/mirror" \
-H "Authorization: Bearer <access_token>" \
-H "Content-Type: application/json" \
-d '{
"is_enabled": <is_enabled>,
"external_reference": "<external_reference>",
"external_registry_username": "<external_registry_username>",
"external_registry_password": "<external_registry_password>",
"sync_start_date": "<sync_start_date>",
"sync_interval": <sync_interval>,
"robot_username": "<robot_username>",
"root_rule": {
"rule": "<rule>",
"rule_type": "<rule_type>"
}
}'