11장. api

PDF

클러스터 라이프사이클 관리를 위해 Kubernetes Operator용 멀티 클러스터 엔진의 API에 액세스할 수 있습니다. 사용자 필수 액세스: 역할이 할당된 작업만 수행할 수 있습니다. 자세한 내용은 다음 리소스 각각에 대한 API 설명서를 참조하십시오.

11.1. 클러스터 API

11.1.1. 개요

이 문서는 Kubernetes용 다중 클러스터 엔진의 클러스터 리소스에 대한 것입니다. 클러스터 리소스에는 생성, 쿼리, 삭제 및 업데이트 등 네 가지 요청이 있습니다.

11.1.1.1. URI 스키마

BasePath : /kubernetes/apis
Schemes : HTTPS

11.1.1.2. 태그

cluster.open-cluster-management.io : 클러스터 생성 및 관리

11.1.2. 경로

11.1.2.1. 모든 클러스터 쿼리

GET /cluster.open-cluster-management.io/v1/managedclusters

11.1.2.1.1. 설명

자세한 내용은 클러스터를 쿼리합니다.

11.1.2.1.2. 매개 변수

유형	이름	설명	스키마
header	COOKIE 필요	권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.	string

11.1.2.1.3. 응답

HTTP 코드	설명	스키마
200	성공	콘텐츠 없음
403	액세스 금지	콘텐츠 없음
404	리소스를 찾을 수 없음	콘텐츠 없음
500	내부 서비스 오류	콘텐츠 없음
503	서비스를 사용할 수 없음	콘텐츠 없음

11.1.2.1.4. Use

cluster/yaml

11.1.2.1.5. 태그

cluster.open-cluster-management.io

11.1.2.2. 클러스터 생성

POST /cluster.open-cluster-management.io/v1/managedclusters

11.1.2.2.1. 설명

클러스터 생성

11.1.2.2.2. 매개 변수

유형	이름	설명	스키마
header	COOKIE 필요	권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.	string
body	본문 필요	생성할 클러스터를 설명하는 매개변수입니다.	Cluster

11.1.2.2.3. 응답

HTTP 코드	설명	스키마
200	성공	콘텐츠 없음
403	액세스 금지	콘텐츠 없음
404	리소스를 찾을 수 없음	콘텐츠 없음
500	내부 서비스 오류	콘텐츠 없음
503	서비스를 사용할 수 없음	콘텐츠 없음

11.1.2.2.4. Use

cluster/yaml

11.1.2.2.5. 태그

cluster.open-cluster-management.io

11.1.2.2.6. HTTP 요청의 예

11.1.2.2.6.1. 요청 본문

{
  "apiVersion" : "cluster.open-cluster-management.io/v1",
  "kind" : "ManagedCluster",
  "metadata" : {
    "labels" : {
      "vendor" : "OpenShift"
    },
    "name" : "cluster1"
  },
  "spec": {
    "hubAcceptsClient": true,
    "managedClusterClientConfigs": [
      {
        "caBundle": "test",
        "url": "https://test.com"
      }
    ]
  },
  "status" : { }
}

11.1.2.3. 단일 클러스터 쿼리

GET /cluster.open-cluster-management.io/v1/managedclusters/{cluster_name}

11.1.2.3.1. 설명

자세한 내용은 단일 클러스터를 쿼리합니다.

11.1.2.3.2. 매개 변수

유형	이름	설명	스키마
header	COOKIE 필요	권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.	string
경로	cluster_name required	쿼리할 클러스터의 이름입니다.	string

11.1.2.3.3. 응답

HTTP 코드	설명	스키마
200	성공	콘텐츠 없음
403	액세스 금지	콘텐츠 없음
404	리소스를 찾을 수 없음	콘텐츠 없음
500	내부 서비스 오류	콘텐츠 없음
503	서비스를 사용할 수 없음	콘텐츠 없음

11.1.2.3.4. 태그

cluster.open-cluster-management.io

11.1.2.4. 클러스터 삭제

DELETE /cluster.open-cluster-management.io/v1/managedclusters/{cluster_name}

11.1.2.4.1. 설명

단일 클러스터 삭제

11.1.2.4.2. 매개 변수

유형	이름	설명	스키마
header	COOKIE 필요	권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.	string
경로	cluster_name required	삭제할 클러스터의 이름입니다.	string

11.1.2.4.3. 응답

HTTP 코드	설명	스키마
200	성공	콘텐츠 없음
403	액세스 금지	콘텐츠 없음
404	리소스를 찾을 수 없음	콘텐츠 없음
500	내부 서비스 오류	콘텐츠 없음
503	서비스를 사용할 수 없음	콘텐츠 없음

11.1.2.4.4. 태그

cluster.open-cluster-management.io

11.1.3. 정의

11.1.3.1. Cluster

이름	스키마
apiVersion 필요	string
kind 필수	string
메타데이터 필요	object
spec 필수	spec

spec

이름	스키마
hubAcceptsClient required	bool
managedClusterClientConfigs optional	< managedClusterClientConfigs > array
leaseDurationSeconds optional	정수(int32)

managedClusterClientConfigs

이름	설명	스키마
URL 필요		string
cabundle 선택 사항	Pattern : `"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$"`	문자열(바이트)