グループクラスタAPI

GitLab 12.1で導入されました。

注意:これらのエンドポイントを使用するには、少なくともグループのメンテナー権限が必要です。

リストグループクラスター

グループ・クラスターのリストを返します。 

GET /groups/:id/clusters

パラメーター

属性 タイプ 必須 説明
id 整数/文字列 はい グループのIDまたはURLエンコードされたパス

リクエスト例 

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

回答例 

[
  {
    "id":18,
    "name":"cluster-1",
    "domain":"example.com",
    "created_at":"2019-01-02T20:18:12.563Z",
    "provider_type":"user",
    "platform_type":"kubernetes",
    "environment_scope":"*",
    "cluster_type":"group_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",
      "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 /groups/:id/clusters/:cluster_id

パラメーター

属性 タイプ 必須 説明
id 整数/文字列 はい グループのIDまたはURLエンコードされたパス
cluster_id 整数 はい クラスターのID

リクエスト例 

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

回答例 

{
  "id":18,
  "name":"cluster-1",
  "domain":"example.com",
  "created_at":"2019-01-02T20:18:12.563Z",
  "provider_type":"user",
  "platform_type":"kubernetes",
  "environment_scope":"*",
  "cluster_type":"group_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",
    "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"
  },
  "group":
  {
    "id":26,
    "name":"group-with-clusters-api",
    "web_url":"https://gitlab.example.com/group-with-clusters-api"
  }
}

既存のクラスターをグループに追加

既存のKubernetesクラスターをグループに追加します。 

POST /groups/:id/clusters/user

パラメーター

属性 タイプ 必須 説明
id 整数/文字列 はい グループのIDまたはURLエンコードされたパス
name 列 はい クラスターの名前
domain 列 いいえ クラスターのベースドメイン
management_project_id 整数 いいえ クラスターの管理プロジェクトのID
enabled ブーリアン いいえ クラスターがアクティブかどうかを判断します。
managed ブーリアン いいえ GitLab がこのクラスターの名前空間とサービスアカウントを管理するかどうかを決定します。
platform_kubernetes_attributes[api_url] 列 はい Kubernetes APIにアクセスするためのURL。
platform_kubernetes_attributes[token] 列 はい Kubernetes を認証するためのトークン。
platform_kubernetes_attributes[ca_cert] 列 いいえ APIが自己署名TLS証明書を使用する場合に必要。
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/groups/26/clusters/user" \
-H "Accept: application/json" \
-H "Content-Type:application/json" \
--request POST --data '{"name":"cluster-5", "platform_kubernetes_attributes":{"api_url":"https://35.111.51.20","token":"12345","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",
  "provider_type":"user",
  "platform_type":"kubernetes",
  "environment_scope":"*",
  "cluster_type":"group_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",
    "authorization_type":"rbac",
    "ca_cert":"-----BEGIN CERTIFICATE-----\r\nhFiK1L61owwDQYJKoZIhvcNAQELBQAw\r\nLzEtMCsGA1UEAxMkZDA1YzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM4ZDBj\r\nMB4XDTE4MTIyNzIwMDM1MVoXDTIzMTIyNjIxMDM1MVowLzEtMCsGA1UEAxMkZDA1\r\nYzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM.......-----END CERTIFICATE-----"
  },
  "management_project":null,
  "group":
  {
    "id":26,
    "name":"group-with-clusters-api",
    "web_url":"https://gitlab.example.com/root/group-with-clusters-api"
  }
}

グループクラスターの編集

既存のグループ・クラスターを更新します。 

PUT /groups/:id/clusters/:cluster_id

パラメーター

属性 タイプ 必須 説明
id 整数/文字列 はい グループのIDまたはURLエンコードされたパス
cluster_id 整数 はい クラスターのID
name 列 いいえ クラスターの名前
domain 列 いいえ クラスターのベースドメイン
management_project_id 整数 いいえ クラスターの管理プロジェクトのID
platform_kubernetes_attributes[api_url] 列 いいえ Kubernetes APIにアクセスするためのURL。
platform_kubernetes_attributes[token] 列 いいえ Kubernetes を認証するためのトークン。
platform_kubernetes_attributes[ca_cert] 列 いいえ APIが自己署名TLS証明書を使用する場合に必要。
environment_scope 列 いいえ クラスターに関連する環境
注：name、api_url、ca_cert 、token を更新できるのは、「既存のKubernetesクラスターを追加」オプションまたは「既存のクラスターをグループに追加」エンドポイントを通じてクラスターが追加された場合のみです。

リクエスト例 

curl --header "Private-Token: <your_access_token>" "https://gitlab.example.com/api/v4/groups/26/clusters/24" \
-H "Content-Type:application/json" \
--request 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",
  "provider_type":"user",
  "platform_type":"kubernetes",
  "environment_scope":"*",
  "cluster_type":"group_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",
    "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"
  },
  "group":
  {
    "id":26,
    "name":"group-with-clusters-api",
    "web_url":"https://gitlab.example.com/group-with-clusters-api"
  }
}

グループクラスターの削除

既存のグループ・クラスターを削除します。 

DELETE /groups/:id/clusters/:cluster_id

パラメーター

属性 タイプ 必須 説明
id 整数/文字列 はい グループのIDまたはURLエンコードされたパス
cluster_id 整数 はい クラスターのID

リクエスト例 

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