2.9. mirror
2.9.1. syncCancel
为给定存储库的镜像配置更新 sync_status。
POST /api/v1/repository/{repository}/mirror/sync-cancel
Authorizations: oauth2_implicit(repo:admin)
路径参数
类型 | Name | 描述 | 模式 |
---|---|---|---|
path |
软件仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
响应
HTTP 代码 | 描述 | 模式 |
---|---|---|
201 | 成功创建 | |
400 | 错误请求 | |
401 | 必需的会话 | |
403 | 未授权访问 | |
404 | 未找到 |
2.9.2. syncNow
为给定存储库的镜像配置更新 sync_status。
POST /api/v1/repository/{repository}/mirror/sync-now
Authorizations: oauth2_implicit(repo:admin)
路径参数
类型 | Name | 描述 | 模式 |
---|---|---|---|
path |
软件仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
响应
HTTP 代码 | 描述 | 模式 |
---|---|---|
201 | 成功创建 | |
400 | 错误请求 | |
401 | 必需的会话 | |
403 | 未授权访问 | |
404 | 未找到 |
2.9.3. getRepoMirrorConfig
返回一个给定存储库的 Mirror 配置。
GET /api/v1/repository/{repository}/mirror
Authorizations: oauth2_implicit(repo:admin)
路径参数
类型 | Name | 描述 | 模式 |
---|---|---|---|
path |
软件仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
响应
HTTP 代码 | 描述 | 模式 |
---|---|---|
200 | 成功调用 | |
400 | 错误请求 | |
401 | 必需的会话 | |
403 | 未授权访问 | |
404 | 未找到 |
2.9.4. createRepoMirrorConfig
为给定的存储库创建一个 RepoMirrorConfig。
POST /api/v1/repository/{repository}/mirror
Authorizations: 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 列表。如需对象引用,请参阅 root_rule api 示例。 | 对象 |
external_registry_config | 对象 |
响应
HTTP 代码 | 描述 | 模式 |
---|---|---|
201 | 成功创建 | |
400 | 错误请求 | |
401 | 必需的会话 | |
403 | 未授权访问 | |
404 | 未找到 |
2.9.5. changeRepoMirrorConfig
允许用户修改存储库的镜像配置。
PUT /api/v1/repository/{repository}/mirror
Authorizations: 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 列表。如需对象引用,请参阅 root_rule api 示例。 | 对象 |
external_registry_config | 对象 |
响应
HTTP 代码 | 描述 | 模式 |
---|---|---|
200 | 成功调用 | |
400 | 错误请求 | |
401 | 必需的会话 | |
403 | 未授权访问 | |
404 | 未找到 |