プロジェクトクラスタAPI（証明書ベース）（非推奨）

GitLab 11.7 で導入されました。
GitLab 14.5 で非推奨。

この機能はGitLab 14.5で非推奨となりました。

これらのエンドポイントを使うには、ユーザーは少なくともメンテナーのロールが必要です。

プロジェクト・クラスターの一覧

プロジェクト・クラスターのリストを返します。

GET /projects/:id/clusters

パラメータを指定します：

属性	種類	必須	説明
`id`	整数または文字列。	yes	認証ユーザーが所有するプロジェクトのIDまたはURLエンコードされたパス

リクエストの例

curl --header "Private-Token: <your_access_token>" "https://gitlab.example.com/api/v4/projects/26/clusters"

応答例

[
  {
    "id":18,
    "name":"cluster-1",
    "domain":"example.com",
    "created_at":"2019-01-02T20:18:12.563Z",
    "managed": true,
    "enabled": true,
    "provider_type":"user",
    "platform_type":"kubernetes",
    "environment_scope":"*",
    "cluster_type":"project_type",
    "user":
    {
      "id":1,
      "name":"Administrator",
      "username":"root",
      "state":"active",
      "avatar_url":"https://www.gravatar.com/avatar/4249f4df72b..",
      "web_url":"https://gitlab.example.com/root"
    },
    "platform_kubernetes":
    {
      "api_url":"https://104.197.68.152",
      "namespace":"cluster-1-namespace",
      "authorization_type":"rbac",
      "ca_cert":"-----BEGIN CERTIFICATE-----\r\nhFiK1L61owwDQYJKoZIhvcNAQELBQAw\r\nLzEtMCsGA1UEAxMkZDA1YzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM4ZDBj\r\nMB4XDTE4MTIyNzIwMDM1MVoXDTIzMTIyNjIxMDM1MVowLzEtMCsGA1UEAxMkZDA1\r\nYzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM.......-----END CERTIFICATE-----"
    },
    "management_project":
    {
      "id":2,
      "description":null,
      "name":"project2",
      "name_with_namespace":"John Doe8 / project2",
      "path":"project2",
      "path_with_namespace":"namespace2/project2",
      "created_at":"2019-10-11T02:55:54.138Z"
    }
  },
  {
    "id":19,
    "name":"cluster-2",
    ...
  }
]

単一のプロジェクトクラスタの取得

単一のプロジェクト・クラスターを取得します。

GET /projects/:id/clusters/:cluster_id

パラメータを指定します：

属性	種類	必須	説明
`id`	整数または文字列。	yes	認証ユーザーが所有するプロジェクトのIDまたはURLエンコードされたパス
`cluster_id`	整数。	yes	クラスターのID

リクエストの例

curl --header "Private-Token: <your_access_token>" "https://gitlab.example.com/api/v4/projects/26/clusters/18"

応答例

{
  "id":18,
  "name":"cluster-1",
  "domain":"example.com",
  "created_at":"2019-01-02T20:18:12.563Z",
  "managed": true,
  "enabled": true,
  "provider_type":"user",
  "platform_type":"kubernetes",
  "environment_scope":"*",
  "cluster_type":"project_type",
  "user":
  {
    "id":1,
    "name":"Administrator",
    "username":"root",
    "state":"active",
    "avatar_url":"https://www.gravatar.com/avatar/4249f4df72b..",
    "web_url":"https://gitlab.example.com/root"
  },
  "platform_kubernetes":
  {
    "api_url":"https://104.197.68.152",
    "namespace":"cluster-1-namespace",
    "authorization_type":"rbac",
    "ca_cert":"-----BEGIN CERTIFICATE-----\r\nhFiK1L61owwDQYJKoZIhvcNAQELBQAw\r\nLzEtMCsGA1UEAxMkZDA1YzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM4ZDBj\r\nMB4XDTE4MTIyNzIwMDM1MVoXDTIzMTIyNjIxMDM1MVowLzEtMCsGA1UEAxMkZDA1\r\nYzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM.......-----END CERTIFICATE-----"
  },
  "management_project":
  {
    "id":2,
    "description":null,
    "name":"project2",
    "name_with_namespace":"John Doe8 / project2",
    "path":"project2",
    "path_with_namespace":"namespace2/project2",
    "created_at":"2019-10-11T02:55:54.138Z"
  },
  "project":
  {
    "id":26,
    "description":"",
    "name":"project-with-clusters-api",
    "name_with_namespace":"Administrator / project-with-clusters-api",
    "path":"project-with-clusters-api",
    "path_with_namespace":"root/project-with-clusters-api",
    "created_at":"2019-01-02T20:13:32.600Z",
    "default_branch":null,
    "tag_list":[], //deprecated, use `topics` instead
    "topics":[],
    "ssh_url_to_repo":"ssh://gitlab.example.com/root/project-with-clusters-api.git",
    "http_url_to_repo":"https://gitlab.example.com/root/project-with-clusters-api.git",
    "web_url":"https://gitlab.example.com/root/project-with-clusters-api",
    "readme_url":null,
    "avatar_url":null,
    "star_count":0,
    "forks_count":0,
    "last_activity_at":"2019-01-02T20:13:32.600Z",
    "namespace":
    {
      "id":1,
      "name":"root",
      "path":"root",
      "kind":"user",
      "full_path":"root",
      "parent_id":null
    }
  }
}

既存のクラスターをプロジェクトに追加します。

既存のKubernetesクラスターをプロジェクトに追加します。

POST /projects/:id/clusters/user

パラメータを指定します：

属性	種類	必須	説明
`id`	整数または文字列。	yes	認証ユーザーが所有するプロジェクトのIDまたはURLエンコードされたパス
`name`	文字列です。	yes	クラスターの名前
`domain`	文字列です。	いいえ	クラスターのベースドメイン
`management_project_id`	整数。	いいえ	クラスターの管理プロジェクトのID
`enabled`	boolean	いいえ	クラスターがアクティブかどうかを決定します。`true`
`managed`	boolean	いいえ	GitLabがこのクラスターの名前空間とサービスアカウントを管理するかどうかを決定します。デフォルトは`true`
`platform_kubernetes_attributes[api_url]`	文字列です。	yes	Kubernetes APIにアクセスするためのURL。
`platform_kubernetes_attributes[token]`	文字列です。	yes	Kubernetesに対して認証するためのトークンです。
`platform_kubernetes_attributes[ca_cert]`	文字列です。	いいえ	TLS証明書。APIが自己署名TLS証明書を使用している場合は必要です。
`platform_kubernetes_attributes[namespace]`	文字列です。	いいえ	プロジェクトに関連する固有の名前空間
`platform_kubernetes_attributes[authorization_type]`	文字列です。	いいえ	クラスター作成者タイプ：`rbac` `abac` または`unknown_authorization`。デフォルトは`rbac`です。
`environment_scope`	文字列です。	いいえ	クラスターに関連付けられた環境。デフォルトは`*` です。

リクエストの例

curl --header "Private-Token: <your_access_token>" "https://gitlab.example.com/api/v4/projects/26/clusters/user" \
-H "Accept: application/json" \
-H "Content-Type:application/json" \
-X POST --data '{"name":"cluster-5", "platform_kubernetes_attributes":{"api_url":"https://35.111.51.20","token":"12345","namespace":"cluster-5-namespace","ca_cert":"-----BEGIN CERTIFICATE-----\r\nhFiK1L61owwDQYJKoZIhvcNAQELBQAw\r\nLzEtMCsGA1UEAxMkZDA1YzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM4ZDBj\r\nMB4XDTE4MTIyNzIwMDM1MVoXDTIzMTIyNjIxMDM1MVowLzEtMCsGA1UEAxMkZDA1\r\nYzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM.......-----END CERTIFICATE-----"}}'

応答例

{
  "id":24,
  "name":"cluster-5",
  "created_at":"2019-01-03T21:53:40.610Z",
  "managed": true,
  "enabled": true,
  "provider_type":"user",
  "platform_type":"kubernetes",
  "environment_scope":"*",
  "cluster_type":"project_type",
  "user":
  {
    "id":1,
    "name":"Administrator",
    "username":"root",
    "state":"active",
    "avatar_url":"https://www.gravatar.com/avatar/4249f4df72b..",
    "web_url":"https://gitlab.example.com/root"
  },
  "platform_kubernetes":
  {
    "api_url":"https://35.111.51.20",
    "namespace":"cluster-5-namespace",
    "authorization_type":"rbac",
    "ca_cert":"-----BEGIN CERTIFICATE-----\r\nhFiK1L61owwDQYJKoZIhvcNAQELBQAw\r\nLzEtMCsGA1UEAxMkZDA1YzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM4ZDBj\r\nMB4XDTE4MTIyNzIwMDM1MVoXDTIzMTIyNjIxMDM1MVowLzEtMCsGA1UEAxMkZDA1\r\nYzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM.......-----END CERTIFICATE-----"
  },
  "management_project":null,
  "project":
  {
    "id":26,
    "description":"",
    "name":"project-with-clusters-api",
    "name_with_namespace":"Administrator / project-with-clusters-api",
    "path":"project-with-clusters-api",
    "path_with_namespace":"root/project-with-clusters-api",
    "created_at":"2019-01-02T20:13:32.600Z",
    "default_branch":null,
    "tag_list":[], //deprecated, use `topics` instead
    "topics":[],
    "ssh_url_to_repo":"ssh:://gitlab.example.com/root/project-with-clusters-api.git",
    "http_url_to_repo":"https://gitlab.example.com/root/project-with-clusters-api.git",
    "web_url":"https://gitlab.example.com/root/project-with-clusters-api",
    "readme_url":null,
    "avatar_url":null,
    "star_count":0,
    "forks_count":0,
    "last_activity_at":"2019-01-02T20:13:32.600Z",
    "namespace":
    {
      "id":1,
      "name":"root",
      "path":"root",
      "kind":"user",
      "full_path":"root",
      "parent_id":null
    }
  }
}

プロジェクトクラスターの編集

既存のプロジェクトクラスターを更新します。

PUT /projects/:id/clusters/:cluster_id

パラメータを指定します：

属性	種類	必須	説明
`id`	整数または文字列。	yes	認証ユーザーが所有するプロジェクトのIDまたはURLエンコードされたパス
`cluster_id`	整数。	yes	クラスターのID
`name`	文字列です。	いいえ	クラスターの名前
`domain`	文字列です。	いいえ	クラスターのベースドメイン
`management_project_id`	整数。	いいえ	クラスターの管理プロジェクトのID
`enabled`	boolean	いいえ	クラスターがアクティビティかどうかを判断します。
`managed`	boolean	いいえ	GitLabがこのクラスターの名前空間とサービスアカウントを管理するかどうかを決定します
`platform_kubernetes_attributes[api_url]`	文字列です。	いいえ	Kubernetes APIにアクセスするためのURL。
`platform_kubernetes_attributes[token]`	文字列です。	いいえ	Kubernetesに対して認証するためのトークンです。
`platform_kubernetes_attributes[ca_cert]`	文字列です。	いいえ	TLS証明書。APIが自己署名TLS証明書を使用している場合は必要です。
`platform_kubernetes_attributes[namespace]`	文字列です。	いいえ	プロジェクトに関連する固有の名前空間
`environment_scope`	文字列です。	いいえ	クラスターに関連する環境

name,api_url,ca_cert およびtoken は、クラスターが“Add existing Kubernetes cluster”オプションまたは“Add existing cluster to project”エンドポイントを通じて追加された場合にのみ更新できます。

リクエストの例

curl --header "Private-Token: <your_access_token>" "https://gitlab.example.com/api/v4/projects/26/clusters/24" \
-H "Content-Type:application/json" \
-X PUT --data '{"name":"new-cluster-name","domain":"new-domain.com","api_url":"https://new-api-url.com"}'

応答例

{
  "id":24,
  "name":"new-cluster-name",
  "domain":"new-domain.com",
  "created_at":"2019-01-03T21:53:40.610Z",
  "managed": true,
  "enabled": true,
  "provider_type":"user",
  "platform_type":"kubernetes",
  "environment_scope":"*",
  "cluster_type":"project_type",
  "user":
  {
    "id":1,
    "name":"Administrator",
    "username":"root",
    "state":"active",
    "avatar_url":"https://www.gravatar.com/avatar/4249f4df72b..",
    "web_url":"https://gitlab.example.com/root"
  },
  "platform_kubernetes":
  {
    "api_url":"https://new-api-url.com",
    "namespace":"cluster-5-namespace",
    "authorization_type":"rbac",
    "ca_cert":null
  },
  "management_project":
  {
    "id":2,
    "description":null,
    "name":"project2",
    "name_with_namespace":"John Doe8 / project2",
    "path":"project2",
    "path_with_namespace":"namespace2/project2",
    "created_at":"2019-10-11T02:55:54.138Z"
  },
  "project":
  {
    "id":26,
    "description":"",
    "name":"project-with-clusters-api",
    "name_with_namespace":"Administrator / project-with-clusters-api",
    "path":"project-with-clusters-api",
    "path_with_namespace":"root/project-with-clusters-api",
    "created_at":"2019-01-02T20:13:32.600Z",
    "default_branch":null,
    "tag_list":[], //deprecated, use `topics` instead
    "topics":[],
    "ssh_url_to_repo":"ssh:://gitlab.example.com/root/project-with-clusters-api.git",
    "http_url_to_repo":"https://gitlab.example.com/root/project-with-clusters-api.git",
    "web_url":"https://gitlab.example.com/root/project-with-clusters-api",
    "readme_url":null,
    "avatar_url":null,
    "star_count":0,
    "forks_count":0,
    "last_activity_at":"2019-01-02T20:13:32.600Z",
    "namespace":
    {
      "id":1,
      "name":"root",
      "path":"root",
      "kind":"user",
      "full_path":"root",
      "parent_id":null
    }
  }
}

プロジェクトクラスタの削除

既存のプロジェクトクラスタを削除します。接続されているKubernetesクラスター内の既存のリソースは削除しません。

DELETE /projects/:id/clusters/:cluster_id

パラメータを指定します：

属性	種類	必須	説明
`id`	整数または文字列。	yes	認証ユーザーが所有するプロジェクトのIDまたはURLエンコードされたパス
`cluster_id`	整数。	yes	クラスターのID

リクエストの例

curl --request DELETE --header "Private-Token: <your_access_token>" "https://gitlab.example.com/api/v4/projects/26/clusters/23"

プロジェクトクラスタAPI（証明書ベース）（非推奨）

プロジェクト・クラスターの一覧

単一のプロジェクトクラスタの取得

既存のクラスターをプロジェクトに追加します。

プロジェクトクラスターの編集

プロジェクトクラスタの削除

Help & feedback

Docs

Product

Feature availability and product trials

Get Help