Project clusters API

Project clusters API

在 GitLab 11.7 中引入 .

注意：用户将至少需要维护者访问权限才能使用这些端点.

返回项目集群的列表.

Parameters:

请求示例：

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

响应示例：

  1. [  {  "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":"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",  ...  }  ]
  1. GET /projects/:id/clusters/:cluster_id

Parameters:

请求示例：

响应示例：

  1. {  "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":"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":[],  "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 集群添加到项目中.

  1. POST /projects/:id/clusters/user

Parameters:

请求示例：

  1. curl --header "Private-Token: <your_access_token>" "https://gitlab.example.com/api/v4/projects/26/clusters/user" \
  2. -H "Content-Type:application/json" \
  3. -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-----"}}'

更新现有项目集群.

  1. PUT /projects/:id/clusters/:cluster_id

Parameters:

注意：仅通过选项或通过“将现有群集添加到项目”端点才能更新name ， api_url ， ca_cert和token .

请求示例：

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

响应示例：

  1. {  "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":"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":[],  "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  }  }  }

删除现有项目集群.

请求示例：

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