1장. API
API에 액세스하여 애플리케이션 리소스, 채널, 서브스크립션 및 정보를 생성 및 관리하고 정보를 쿼리할 수 있습니다.
사용자 필수 액세스: 역할이 할당된 작업만 수행할 수 있습니다. 역할 기반 액세스 제어 설명서에서 액세스 요구 사항에 대해 알아봅니다.
통합 콘솔에서 모든 API에 액세스할 수도 있습니다. local-cluster 보기에서 Home > API Explorer 로 이동하여 API 그룹을 살펴봅니다.
자세한 내용은 다음 리소스 각각에 대한 API 설명서를 참조하십시오.
- 클러스터 API
- ClusterSets API (v1beta2)
- ClusterSetBindings API (v1beta2)
- 채널 API
- 서브스크립션 API
- PlacementRules API (더 이상 사용되지 않음)
- 애플리케이션 API
- Helm API
- 정책 API
- 관찰 기능 API
- 검색 쿼리 API
- MultiClusterHub API
- 배치 API(v1beta1)
- PlacementDecisions API (v1beta1)
- DiscoveryConfig API
- DiscoveredCluster API
- AddOnDeploymentConfig API (v1alpha1)
- ClusterManagementAddOn API (v1alpha1)
- ManagedClusterAddOn API (v1alpha1)
- ManagedClusterSet API
- KlusterletConfig API (v1alpha1)
- 정책 규정 준수 API (기술 프리뷰)
1.1. 클러스터 API 링크 복사링크가 클립보드에 복사되었습니다!
1.1.1. 개요 링크 복사링크가 클립보드에 복사되었습니다!
이 문서는 Red Hat Advanced Cluster Management for Kubernetes용 클러스터 리소스에 대한 것입니다. 클러스터 리소스에는 생성, 쿼리, 삭제 및 업데이트의 네 가지 요청이 있습니다. ManagedCluster 는 관리 클러스터의 원하는 상태 및 현재 상태를 나타냅니다. ManagedCluster 는 클러스터 범위 리소스입니다.
1.1.1.1. 버전 정보 링크 복사링크가 클립보드에 복사되었습니다!
버전 : 2.11.0
1.1.1.2. URI 스키마 링크 복사링크가 클립보드에 복사되었습니다!
BasePath : /kubernetes/apis
Schemes : HTTPS
1.1.1.3. 태그 링크 복사링크가 클립보드에 복사되었습니다!
- cluster.open-cluster-management.io : 클러스터 생성 및 관리
1.1.2. 경로 링크 복사링크가 클립보드에 복사되었습니다!
1.1.2.1. 모든 클러스터 쿼리 링크 복사링크가 클립보드에 복사되었습니다!
GET /cluster.open-cluster-management.io/v1/managedclusters
GET /cluster.open-cluster-management.io/v1/managedclusters
1.1.2.1.1. 설명 링크 복사링크가 클립보드에 복사되었습니다!
자세한 내용은 클러스터를 쿼리합니다.
1.1.2.1.2. 매개 변수 링크 복사링크가 클립보드에 복사되었습니다!
| 유형 | 이름 | 설명 | 스키마 |
|---|---|---|---|
| 헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
1.1.2.1.3. 응답 링크 복사링크가 클립보드에 복사되었습니다!
| HTTP 코드 | 설명 | 스키마 |
|---|---|---|
| 200 | 성공 | 콘텐츠 없음 |
| 403 | 액세스 금지 | 콘텐츠 없음 |
| 404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
| 500 | 내부 서비스 오류 | 콘텐츠 없음 |
| 503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.1.2.1.4. 사용 링크 복사링크가 클립보드에 복사되었습니다!
-
cluster/yaml
1.1.2.1.5. 태그 링크 복사링크가 클립보드에 복사되었습니다!
- cluster.open-cluster-management.io
1.1.2.2. 클러스터 생성 링크 복사링크가 클립보드에 복사되었습니다!
POST /cluster.open-cluster-management.io/v1/managedclusters
POST /cluster.open-cluster-management.io/v1/managedclusters
1.1.2.2.1. 설명 링크 복사링크가 클립보드에 복사되었습니다!
클러스터 생성
1.1.2.2.2. 매개 변수 링크 복사링크가 클립보드에 복사되었습니다!
| 유형 | 이름 | 설명 | 스키마 |
|---|---|---|---|
| 헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
| 본문 |
본문 | 생성할 클러스터를 설명하는 매개변수입니다. |
1.1.2.2.3. 응답 링크 복사링크가 클립보드에 복사되었습니다!
| HTTP 코드 | 설명 | 스키마 |
|---|---|---|
| 200 | 성공 | 콘텐츠 없음 |
| 403 | 액세스 금지 | 콘텐츠 없음 |
| 404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
| 500 | 내부 서비스 오류 | 콘텐츠 없음 |
| 503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.1.2.2.4. 사용 링크 복사링크가 클립보드에 복사되었습니다!
-
cluster/yaml
1.1.2.2.5. 태그 링크 복사링크가 클립보드에 복사되었습니다!
- cluster.open-cluster-management.io
1.1.2.2.6. HTTP 요청의 예 링크 복사링크가 클립보드에 복사되었습니다!
1.1.2.2.6.1. 요청 본문 링크 복사링크가 클립보드에 복사되었습니다!
1.1.2.3. 단일 클러스터 쿼리 링크 복사링크가 클립보드에 복사되었습니다!
GET /cluster.open-cluster-management.io/v1/managedclusters/{cluster_name}
GET /cluster.open-cluster-management.io/v1/managedclusters/{cluster_name}
1.1.2.3.1. 설명 링크 복사링크가 클립보드에 복사되었습니다!
자세한 내용은 단일 클러스터를 쿼리합니다.
1.1.2.3.2. 매개 변수 링크 복사링크가 클립보드에 복사되었습니다!
| 유형 | 이름 | 설명 | 스키마 |
|---|---|---|---|
| 헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
| 경로 |
cluster_name | 쿼리할 클러스터의 이름입니다. | string |
1.1.2.3.3. 응답 링크 복사링크가 클립보드에 복사되었습니다!
| HTTP 코드 | 설명 | 스키마 |
|---|---|---|
| 200 | 성공 | 콘텐츠 없음 |
| 403 | 액세스 금지 | 콘텐츠 없음 |
| 404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
| 500 | 내부 서비스 오류 | 콘텐츠 없음 |
| 503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.1.2.3.4. 태그 링크 복사링크가 클립보드에 복사되었습니다!
- cluster.open-cluster-management.io
1.1.2.4. 클러스터 삭제 링크 복사링크가 클립보드에 복사되었습니다!
DELETE /cluster.open-cluster-management.io/v1/managedclusters/{cluster_name}
DELETE /cluster.open-cluster-management.io/v1/managedclusters/{cluster_name}
DELETE /hive.openshift.io/v1/{cluster_name}/clusterdeployments/{cluster_name}
DELETE /hive.openshift.io/v1/{cluster_name}/clusterdeployments/{cluster_name}
1.1.2.4.1. 설명 링크 복사링크가 클립보드에 복사되었습니다!
단일 클러스터 삭제
1.1.2.4.2. 매개 변수 링크 복사링크가 클립보드에 복사되었습니다!
| 유형 | 이름 | 설명 | 스키마 |
|---|---|---|---|
| 헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
| 경로 |
cluster_name | 삭제할 클러스터의 이름입니다. | string |
1.1.2.4.3. 응답 링크 복사링크가 클립보드에 복사되었습니다!
| HTTP 코드 | 설명 | 스키마 |
|---|---|---|
| 200 | 성공 | 콘텐츠 없음 |
| 403 | 액세스 금지 | 콘텐츠 없음 |
| 404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
| 500 | 내부 서비스 오류 | 콘텐츠 없음 |
| 503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.1.2.4.4. 태그 링크 복사링크가 클립보드에 복사되었습니다!
- cluster.open-cluster-management.io
1.1.3. 정의 링크 복사링크가 클립보드에 복사되었습니다!
1.1.3.1. Cluster 링크 복사링크가 클립보드에 복사되었습니다!
| 이름 | 설명 | 스키마 |
|---|---|---|
|
apiVersion |
| string |
|
종류 | REST 리소스를 나타내는 문자열 값입니다. | string |
|
메타데이터 |
| object |
|
사양 |
|
spec
| 이름 | 설명 | 스키마 |
|---|---|---|
|
hubAcceptsClient |
허브가 관리 클러스터에서 klusterlet 에이전트와의 연결을 설정할 수 있는지 여부를 지정합니다. 기본값은 | bool |
|
managedClusterClientConfigs | 관리 클러스터의 apiserver 주소를 나열합니다. | |
|
leaseDurationSeconds | 관리 클러스터에서 klusterlet 에이전트의 리스 업데이트 시간 간격을 지정합니다. 기본적으로 klusterlet 에이전트는 60초마다 리스를 업데이트합니다. | 정수(int32) |
|
테인트 | 예약 중에 관리 클러스터가 하나 이상의 관리 클러스터 세트에 할당되지 않도록 합니다. | taint 배열 |
managedClusterClientConfigs
| 이름 | 설명 | 스키마 |
|---|---|---|
|
URL | string | |
|
cabundle | 패턴 : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"
| 문자열(바이트) |
taint
| 이름 | 설명 | 스키마 |
|---|---|---|
|
키 | 클러스터에 적용되는 taint 키입니다. | string |
|
값 | taint 키에 해당하는 taint 값입니다. | string |
|
effect |
테인트를 허용하지 않는 배치에 테인트의 영향 유효한 값은 | string |