2.9. mirror
2.9.1. syncCancel
指定したリポジトリーのミラーリング設定の sync_status を更新します。
POST /api/v1/repository/{repository}/mirror/sync-cancel
承認: oauth2_implicit(repo:admin)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
repository | リポジトリーの完全パス (例: namespace/name) | string |
レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 201 | 作成成功 | |
| 400 | 不適切な要求 | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
2.9.2. syncNow
指定したリポジトリーのミラーリング設定の sync_status を更新します。
POST /api/v1/repository/{repository}/mirror/sync-now
承認: oauth2_implicit(repo:admin)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
repository | リポジトリーの完全パス (例: namespace/name) | string |
レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 201 | 作成成功 | |
| 400 | 不適切な要求 | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
2.9.3. getRepoMirrorConfig
指定したリポジトリーのミラーリング設定を返します。
GET /api/v1/repository/{repository}/mirror
承認: oauth2_implicit(repo:admin)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
repository | リポジトリーの完全パス (例: namespace/name) | string |
レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 正常な呼び出し | |
| 400 | 不適切な要求 | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
2.9.4. createRepoMirrorConfig
特定のリポジトリーの RepoMirrorConfig を作成します。
POST /api/v1/repository/{repository}/mirror
承認: oauth2_implicit(repo:admin)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
repository | リポジトリーの完全パス (例: namespace/name) | string |
要求のボディースキーマ (アプリケーション/json)
リポジトリーのミラーリング設定を作成します。
| 名前 | 説明 | スキーマ |
|---|---|---|
|
is_enabled | 同期を有効または無効にするために使用されます。 | boolean |
|
external_reference | 外部リポジトリーの場所。 | string |
|
external_registry_username | 外部レジストリーでの認証に使用されるユーザー名。 | |
|
external_registry_password | 外部レジストリーでの認証に使用されるパスワード。 | |
|
sync_start_date | このリポジトリーの次の同期時間を決定します。 | string |
|
sync_interval | next_start_date が同期を開始するまでの秒数。 | integer |
|
robot_username | イメージのプッシュに使用されるロボットのユーザー名。 | string |
|
root_rule | 同期する必要のあるタグの判別に使用する glob パターンの一覧。オブジェクトリファレンスについては、root_rule API の例 を参照してください。 | object |
|
external_registry_config | object |
応答
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 201 | 作成成功 | |
| 400 | 不適切な要求 | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
2.9.5. changeRepoMirrorConfig
ユーザーがリポジトリーのミラーリング設定を変更できるようにします。
PUT /api/v1/repository/{repository}/mirror
承認: oauth2_implicit(repo:admin)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
repository | リポジトリーの完全パス (例: namespace/name) | string |
要求のボディースキーマ (アプリケーション/json)
リポジトリーミラーリング設定を更新します。
| 名前 | 説明 | スキーマ |
|---|---|---|
|
is_enabled | 同期を有効または無効にするために使用されます。 | boolean |
|
external_reference | 外部リポジトリーの場所。 | string |
|
external_registry_username | 外部レジストリーでの認証に使用されるユーザー名。 | |
|
external_registry_password | 外部レジストリーでの認証に使用されるパスワード。 | |
|
sync_start_date | このリポジトリーの次の同期時間を決定します。 | string |
|
sync_interval | next_start_date が同期を開始するまでの秒数。 | integer |
|
robot_username | イメージのプッシュに使用されるロボットのユーザー名。 | string |
|
root_rule | 同期する必要のあるタグの判別に使用する glob パターンの一覧。オブジェクトリファレンスについては、root_rule API の例 を参照してください。 | object |
|
external_registry_config | object |
応答
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 正常な呼び出し | |
| 400 | 不適切な要求 | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
