プラン制限API
- プラン: Free、Premium、Ultimate
- 提供形態: GitLab Self-Managed、GitLab Dedicated
既存のサブスクリプションプランのアプリケーション制限と対話するには、このAPIを使用します。
既存のプランはGitLabエディションによって異なります。Community Editionでは、プランdefaultのみが利用可能です。Enterprise Editionでも、追加のプランが利用可能です。
前提条件:
- インスタンスへの管理者アクセス権が必要です。
現在のプラン制限を取得する
GitLabインスタンス上のプランの現在の制限を取得します。
GET /application/plan_limits| 属性 | 型 | 必須 | 説明 |
|---|---|---|---|
plan_name | 文字列 | いいえ | 制限を取得するプランの名前。デフォルト: default。 |
curl --request GET \
--header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/application/plan_limits"レスポンス例:
{
"ci_instance_level_variables": 25,
"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,
"dotenv_size": 5120,
"dotenv_variables": 20,
"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,
"max_pipelines_per_merge_train": 20,
"pipeline_hierarchy_size": 1000,
"pypi_max_file_size": 3221225472,
"terraform_module_max_file_size": 1073741824,
"storage_size_limit": 15000
}プラン制限を更新する
GitLabインスタンス上のプランの制限を更新します。
PUT /application/plan_limits| 属性 | 型 | 必須 | 説明 |
|---|---|---|---|
plan_name | 文字列 | はい | 更新するプランの名前。 |
ci_instance_level_variables | 整数 | いいえ | 定義できるインスタンスレベルのCI/CD変数の最大数。 |
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 | 整数 | いいえ | 1つのジョブが持つことができるneeds依存関係の最大数。GitLab 15.0で導入されました。 |
ci_registered_group_runners | 整数 | いいえ | 過去7日間にグループで作成またはアクティブだったRunnerの最大数。GitLab 15.0で導入されました。 |
ci_registered_project_runners | 整数 | いいえ | 過去7日間にプロジェクトで作成またはアクティブだったRunnerの最大数。GitLab 15.0で導入されました。 |
dotenv_size | 整数 | いいえ | .envアーティファクトの最大サイズ(バイト単位)。GitLab 17.1で導入されました。 |
dotenv_variables | 整数 | いいえ | .envアーティファクト内の変数の最大数。GitLab 17.1で導入されました。 |
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パッケージファイルの最大サイズ(バイト単位)。 |
max_pipelines_per_merge_train | 整数 | いいえ | マージトレインごとの並列パイプラインの最大数。デフォルト値: 20。最小値: 1。GitLab 19.0で導入されました。 |
pipeline_hierarchy_size | 整数 | いいえ | パイプラインの階層ツリーにおけるダウンストリームパイプラインの最大数。デフォルト値: 1000。1000を超える値は推奨されません。 |
pypi_max_file_size | 整数 | いいえ | PyPIパッケージファイルの最大サイズ(バイト単位)。 |
terraform_module_max_file_size | 整数 | いいえ | Terraformモジュールパッケージファイルの最大サイズ(バイト単位)。 |
storage_size_limit | 整数 | いいえ | ルートネームスペースの最大ストレージサイズ(MiB単位)。 |
web_hook_calls | 整数 | いいえ | トップレベルネームスペースごとに1分間にWebhookを呼び出すことができる最大回数。GitLab 18.5で導入されました。 |
curl --request PUT \
--header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/application/plan_limits?plan_name=default&conan_max_file_size=3221225472"レスポンス例:
{
"ci_instance_level_variables": 25,
"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,
"dotenv_variables": 20,
"dotenv_size": 5120,
"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,
"max_pipelines_per_merge_train": 20,
"pipeline_hierarchy_size": 1000,
"pypi_max_file_size": 3221225472,
"terraform_module_max_file_size": 1073741824
}