プランの制限 API

GitLab 13.10で導入されました

プランリミットAPIは、既存のサブスクリプションプランのアプリケーションリミットをメンテナーすることができます。

既存のプランはGitLabのエディションによって異なります。Community Editionでは、プランdefault のみが利用可能です。Enterprise Editionでは、その他のプランも利用可能です。

このAPIを利用するには管理者権限が必要です。

現在のプランの制限値を取得

GitLabインスタンス上のプランの現在の制限を一覧表示します。

GET /application/plan_limits
属性種類必須説明
plan_name文字列です。いいえ制限値を取得するプランの名前。デフォルト:default.
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/application/plan_limits"

応答例

{
  "ci_pipeline_size": 0,
  "ci_active_jobs": 0,
  "ci_project_subscriptions": 2,
  "ci_pipeline_schedules": 10,
  "ci_needs_size_limit": 50,
  "ci_registered_group_runners": 1000,
  "ci_registered_project_runners": 1000,
  "conan_max_file_size": 3221225472,
  "enforcement_limit": 10000,
  "generic_packages_max_file_size": 5368709120,
  "helm_max_file_size": 5242880,
  "notification_limit": 10000,
  "maven_max_file_size": 3221225472,
  "npm_max_file_size": 524288000,
  "nuget_max_file_size": 524288000,
  "pypi_max_file_size": 3221225472,
  "terraform_module_max_file_size": 1073741824,
  "storage_size_limit": 15000
}

プランの制限を変更

GitLabインスタンスのプランの制限を変更します。

PUT /application/plan_limits
属性種類必須説明
plan_name文字列です。yes更新するプランの名称
ci_pipeline_size整数。いいえ単一のパイプラインにおけるジョブの最大数。GitLab 15.0で導入
ci_active_jobs整数。いいえ現在アクティブなパイプラインのジョブ総数。GitLab 15.0で導入
ci_project_subscriptions整数。いいえプロジェクトとのパイプラインサブスクリプションの最大数。GitLab 15.0で導入
ci_pipeline_schedules整数。いいえパイプラインスケジュールの最大数。GitLab 15.0で導入
ci_needs_size_limit整数。いいえジョブが持つことができるDAG依存関係の最大数。GitLab 15.0で導入
ci_registered_group_runners整数。いいえグループごとに登録されるRunnerの最大数。GitLab 15.0で導入
ci_registered_project_runners整数。いいえプロジェクトごとに登録できるRunnerの最大数。GitLab 15.0で導入
conan_max_file_size整数。いいえConanパッケージファイルの最大サイズ(バイト)。
enforcement_limit整数。いいえルート名前空間の制限を実施するための最大ストレージサイズ(MiB)。
generic_packages_max_file_size整数。いいえ汎用パッケージファイルの最大サイズ(バイト)。
helm_max_file_size整数。いいえHelmチャートファイルの最大サイズ(バイト)。
maven_max_file_size整数。いいえバイト単位の最大Mavenパッケージファイルサイズ。
notification_limit整数。いいえルート名前空間制限通知の最大ストレージサイズ(MiB)。
npm_max_file_size整数。いいえnpmパッケージファイルの最大サイズ(バイト単位)。
nuget_max_file_size整数。いいえNuGetパッケージの最大ファイルサイズ(バイト)。
pypi_max_file_size整数。いいえPyPIパッケージのファイルサイズの最大値(バイト)。
terraform_module_max_file_size整数。いいえTerraformモジュールのパッケージファイルの最大サイズをバイト単位で指定します。
storage_size_limit整数。いいえルート・ネームスペースの最大ストレージ・サイズ(MiB単位)。
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/application/plan_limits?plan_name=default&conan_max_file_size=3221225472"

応答例

{
  "ci_pipeline_size": 0,
  "ci_active_jobs": 0,
  "ci_project_subscriptions": 2,
  "ci_pipeline_schedules": 10,
  "ci_needs_size_limit": 50,
  "ci_registered_group_runners": 1000,
  "ci_registered_project_runners": 1000,
  "conan_max_file_size": 3221225472,
  "generic_packages_max_file_size": 5368709120,
  "helm_max_file_size": 5242880,
  "maven_max_file_size": 3221225472,
  "npm_max_file_size": 524288000,
  "nuget_max_file_size": 524288000,
  "pypi_max_file_size": 3221225472,
  "terraform_module_max_file_size": 1073741824
}