仮想レジストリクリーンアップポリシーAPI

プラン: Premium、Ultimate
提供形態: GitLab.com、GitLab Self-Managed、GitLab Dedicated
ステータス: 実験的機能

これらのエンドポイントの可用性は機能フラグによって制御されます。詳細については、履歴を参照してください。使用する前に、ドキュメントを注意深く確認してください。

このAPIを使用して、以下を行います:

仮想レジストリクリーンアップポリシーを作成管理します。
クリーンアップポリシーのスケジュールと保持設定を構成します。
未使用のキャッシュエントリを自動的にクリーンアップします。

クリーンアップポリシーの管理

仮想レジストリクリーンアップポリシーの作成と管理には、次のエンドポイントを使用します。各グループには1つのクリーンアップポリシーのみ設定できます。

グループのクリーンアップポリシーを取得する

指定されたグループのクリーンアップポリシーを取得する。各グループには1つのクリーンアップポリシーのみ設定できます。

GET /groups/:id/-/virtual_registries/cleanup/policy

サポートされている属性は以下のとおりです:

属性	型	必須	説明
`id`	文字列または整数	はい	グループIDまたはグループのフルパス。トップレベルグループである必要があります。

リクエスト例:

curl --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Accept: application/json" \
     --url "https://gitlab.example.com/api/v4/groups/5/-/virtual_registries/cleanup/policy"

レスポンス例:

{
  "group_id": 5,
  "next_run_at": "2024-06-06T12:28:27.855Z",
  "last_run_at": "2024-05-30T12:28:27.855Z",
  "last_run_deleted_size": 1048576,
  "last_run_deleted_entries_count": 25,
  "keep_n_days_after_download": 30,
  "status": "scheduled",
  "cadence": 7,
  "enabled": true,
  "notify_on_success": false,
  "notify_on_failure": false,
  "failure_message": null,
  "last_run_detailed_metrics": {
    "maven": {
      "deleted_entries_count": 25,
      "deleted_size": 1048576
    }
  },
  "created_at": "2024-05-30T12:28:27.855Z",
  "updated_at": "2024-05-30T12:28:27.855Z"
}

クリーンアップポリシーを作成する

指定されたグループのクリーンアップポリシーを作成します。各グループには1つのクリーンアップポリシーのみ設定できます。

POST /groups/:id/-/virtual_registries/cleanup/policy

属性	型	必須	説明
`id`	文字列または整数	はい	グループIDまたはグループのフルパス。トップレベルグループである必要があります。
`cadence`	整数	いいえ	クリーンアップポリシーを実行する頻度。次のいずれかである必要があります: `1` (毎日)、`7` (毎週)、`14` (隔週)、`30` (毎月)、`90` (四半期ごと)。
`enabled`	ブール値	いいえ	クリーンアップポリシーを有効または無効にします。
`keep_n_days_after_download`	整数	いいえ	未使用のキャッシュエントリがクリーンアップされるまでの日数。1から365の間である必要があります。
`notify_on_success`	ブール値	いいえ	クリーンアップポリシーの実行が成功した場合にグループオーナーに通知します。
`notify_on_failure`	ブール値	いいえ	クリーンアップポリシーの実行が失敗した場合にグループオーナーに通知します。

リクエスト例:

curl --request POST \
     --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Content-Type: application/json" \
     --header "Accept: application/json" \
     --data '{"enabled": true, "keep_n_days_after_download": 30, "cadence": 7}' \
     --url "https://gitlab.example.com/api/v4/groups/5/-/virtual_registries/cleanup/policy"

レスポンス例:

{
  "group_id": 5,
  "next_run_at": "2024-06-06T12:28:27.855Z",
  "last_run_at": null,
  "last_run_deleted_size": 0,
  "last_run_deleted_entries_count": 0,
  "keep_n_days_after_download": 30,
  "status": "scheduled",
  "cadence": 7,
  "enabled": true,
  "notify_on_success": false,
  "notify_on_failure": false,
  "failure_message": null,
  "last_run_detailed_metrics": {},
  "created_at": "2024-05-30T12:28:27.855Z",
  "updated_at": "2024-05-30T12:28:27.855Z"
}

クリーンアップポリシーを更新する

指定されたグループのクリーンアップポリシーを更新します。

PATCH /groups/:id/-/virtual_registries/cleanup/policy

属性	型	必須	説明
`id`	文字列または整数	はい	グループIDまたはグループのフルパス。トップレベルグループである必要があります。
`cadence`	整数	いいえ	クリーンアップポリシーを実行する頻度。次のいずれかである必要があります: `1` (毎日)、`7` (毎週)、`14` (隔週)、`30` (毎月)、`90` (四半期ごと)。
`enabled`	ブール値	いいえ	ポリシーを有効/無効にするブール値。
`keep_n_days_after_download`	整数	いいえ	未使用のキャッシュエントリがクリーンアップされるまでの日数。1から365の間である必要があります。
`notify_on_success`	ブール値	いいえ	クリーンアップポリシーの実行が成功した場合にグループオーナーに通知します。
`notify_on_failure`	ブール値	いいえ	クリーンアップポリシーの実行が失敗した場合にグループオーナーに通知します。

リクエストには、オプションのパラメータを少なくとも1つ指定する必要があります。

リクエスト例:

curl --request PATCH \
     --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Content-Type: application/json" \
     --data '{"keep_n_days_after_download": 60}' \
     --url "https://gitlab.example.com/api/v4/groups/5/-/virtual_registries/cleanup/policy"

レスポンス例:

{
  "group_id": 5,
  "next_run_at": "2024-06-06T12:28:27.855Z",
  "last_run_at": "2024-05-30T12:28:27.855Z",
  "last_run_deleted_size": 1048576,
  "last_run_deleted_entries_count": 25,
  "keep_n_days_after_download": 60,
  "status": "scheduled",
  "cadence": 7,
  "enabled": true,
  "notify_on_success": false,
  "notify_on_failure": false,
  "failure_message": null,
  "last_run_detailed_metrics": {
    "maven": {
      "deleted_entries_count": 25,
      "deleted_size": 1048576
    }
  },
  "created_at": "2024-05-30T12:28:27.855Z",
  "updated_at": "2024-05-30T12:28:27.855Z"
}

クリーンアップポリシーを削除する

指定されたグループのクリーンアップポリシーを削除します。

DELETE /groups/:id/-/virtual_registries/cleanup/policy

属性	型	必須	説明
`id`	文字列または整数	はい	グループIDまたはグループのフルパス。トップレベルグループである必要があります。

リクエスト例:

curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Accept: application/json" \
     --url "https://gitlab.example.com/api/v4/groups/5/-/virtual_registries/cleanup/policy"

成功した場合、204 No Contentステータスコードを返します。