1.6. 서브스크립션 API
1.6.1. 개요
이 문서는 Red Hat Advanced Cluster Management for Kubernetes 서브스크립션 리소스에 대한 것입니다. 서브스크립션 리소스에는 생성, 쿼리, 삭제 및 업데이트의 네 가지 요청이 있습니다. 더 이상 사용되지 않음: PlacementRule
1.6.1.1. 버전 정보
버전 : 2.10.0
1.6.1.2. URI 스키마
BasePath : /kubernetes/apis
Schemes : HTTPS
1.6.1.3. 태그
- subscriptions.apps.open-cluster-management.io : 서브스크립션 생성 및 관리
1.6.2. 경로
1.6.2.1. 서브스크립션 생성
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions
1.6.2.1.1. 설명
서브스크립션을 생성합니다.
1.6.2.1.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
본문 |
본문 | 생성할 서브스크립션을 설명하는 매개변수입니다. |
1.6.2.1.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.6.2.1.4. 사용
-
subscription/yaml
1.6.2.1.5. 태그
- subscriptions.apps.open-cluster-management.io
1.6.2.1.6. HTTP 요청의 예
1.6.2.1.6.1. 요청 본문
{ "apiVersion" : "apps.open-cluster-management.io/v1", "kind" : "Subscription", "metadata" : { "name" : "sample_subscription", "namespace" : "default", "labels" : { "app" : "sample_subscription-app" }, "annotations" : { "apps.open-cluster-management.io/git-path" : "apps/sample/", "apps.open-cluster-management.io/git-branch" : "sample_branch" } }, "spec" : { "channel" : "channel_namespace/sample_channel", "packageOverrides" : [ { "packageName" : "my-sample-application", "packageAlias" : "the-sample-app", "packageOverrides" : [ { "path" : "spec", "value" : { "persistence" : { "enabled" : false, "useDynamicProvisioning" : false }, "license" : "accept", "tls" : { "hostname" : "my-mcm-cluster.icp" }, "sso" : { "registrationImage" : { "pullSecret" : "hub-repo-docker-secret" } } } } ] } ], "placement" : { "placementRef" : { "kind" : "PlacementRule", "name" : "demo-clusters" } } } }
1.6.2.2. 모든 서브스크립션 쿼리
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions
1.6.2.2.1. 설명
자세한 내용은 서브스크립션을 쿼리합니다.
1.6.2.2.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
1.6.2.2.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.6.2.2.4. 사용
-
subscription/yaml
1.6.2.2.5. 태그
- subscriptions.apps.open-cluster-management.io
1.6.2.3. 단일 서브스크립션 쿼리
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}
1.6.2.3.1. 설명
자세한 내용은 단일 서브스크립션을 쿼리합니다.
1.6.2.3.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
경로 |
subscription_name | 쿼리할 서브스크립션의 이름입니다. | string |
1.6.2.3.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.6.2.3.4. 태그
- subscriptions.apps.open-cluster-management.io
1.6.2.4. 서브스크립션 삭제
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}
1.6.2.4.1. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
경로 |
subscription_name | 삭제할 서브스크립션의 이름입니다. | string |
1.6.2.4.2. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.6.2.4.3. 태그
- subscriptions.apps.open-cluster-management.io
1.6.3. 정의
1.6.3.1. 서브스크립션
이름 | 스키마 |
---|---|
apiVersion | string |
종류 | string |
메타데이터 | |
사양 | |
상태 |
메타데이터
이름 | 스키마 |
---|---|
주석 | object |
레이블 | object |
이름 | string |
네임스페이스 | string |
spec
이름 | 스키마 |
---|---|
채널 | string |
이름 | string |
| 배열 덮어쓰기 |
packageFilter | |
packageOverrides | packageOverrides array |
배치 | |
Timewindow |
덮어쓰기
이름 | 스키마 |
---|---|
클러스터 이름 | string |
clusterOverrides | 오브젝트 배열 |
packageFilter
이름 | 설명 | 스키마 |
---|---|---|
주석 | 문자열, 문자열 맵 | |
filterRef | ||
labelSelector | ||
버전 |
패턴 : | string |
filterRef
이름 | 스키마 |
---|---|
이름 | string |
labelSelector
이름 | 스키마 |
---|---|
matchExpressions | |
matchLabels | 문자열, 문자열 맵 |
matchExpressions
이름 | 스키마 |
---|---|
키 | string |
Operator | string |
| 문자열 배열 |
packageOverrides
이름 | 스키마 |
---|---|
packageAlias | string |
PACKAGENAME | string |
packageOverrides | 오브젝트 배열 |
배치
이름 | 스키마 |
---|---|
clusterSelector | |
클러스터 | 클러스터 배열 |
로컬 | boolean |
placementRef |
clusterSelector
이름 | 스키마 |
---|---|
matchExpressions | |
matchLabels | 문자열, 문자열 맵 |
matchExpressions
이름 | 스키마 |
---|---|
키 | string |
Operator | string |
| 문자열 배열 |
클러스터
이름 | 스키마 |
---|---|
이름 | string |
placementRef
이름 | 스키마 |
---|---|
apiVersion | string |
fieldPath | string |
종류 | string |
이름 | string |
네임스페이스 | string |
resourceVersion | string |
UID | string |
Timewindow
이름 | 스키마 |
---|---|
daysof week | 문자열 배열 |
시간 | 시간 배열 |
위치 | string |
windowtype | enum (active, blocked, Active, Blocked) |
몇 시간
이름 | 스키마 |
---|---|
| string |
| string |
status
이름 | 스키마 |
---|---|
lastUpdateTime | 문자열 (date-time) |
메시지 | string |
| string |
이유 | string |
상태 | object |