1.17. DiscoveryConfig API
1.17.1. 개요
이 문서는 Red Hat Advanced Cluster Management for Kubernetes용 DiscoveryConfig 리소스에 대한 것입니다. DiscoveryConfig 리소스에는 생성, 쿼리, 삭제 및 업데이트의 네 가지 요청이 있습니다.
1.17.1.1. 버전 정보
버전 : 2.12.0
1.17.1.2. URI 스키마
BasePath : /kubernetes/apis
Schemes : HTTPS
1.17.1.3. 태그
- discoveryconfigs.discovery.open-cluster-management.io : DiscoveryConfigs 생성 및 관리
1.17.2. 경로
1.17.2.1. DiscoveryConfig 생성
POST /app.k8s.io/v1/namespaces/{namespace}/discoveryconfigs
1.17.2.1.1. 설명
DiscoveryConfig를 생성합니다.
1.17.2.1.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
본문 |
본문 | 생성할 DiscoveryConfig를 설명하는 매개변수입니다. | DiscoveryConfig |
1.17.2.1.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.17.2.1.4. 사용
-
discoveryconfigs/yaml
1.17.2.1.5. 태그
- discoveryconfigs.discovery.open-cluster-management.io
1.17.2.1.5.1. 요청 본문
{ "apiVersion": "apiextensions.k8s.io/v1", "kind": "CustomResourceDefinition", "metadata": { "annotations": { "controller-gen.kubebuilder.io/version": "v0.4.1", }, "creationTimestamp": null, "name": "discoveryconfigs.discovery.open-cluster-management.io", }, "spec": { "group": "discovery.open-cluster-management.io", "names": { "kind": "DiscoveryConfig", "listKind": "DiscoveryConfigList", "plural": "discoveryconfigs", "singular": "discoveryconfig" }, "scope": "Namespaced", "versions": [ { "name": "v1", "schema": { "openAPIV3Schema": { "description": "DiscoveryConfig is the Schema for the discoveryconfigs API", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", "type": "string" }, "kind": { "description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", "type": "string" }, "metadata": { "type": "object" }, "spec": { "description": "DiscoveryConfigSpec defines the desired state of DiscoveryConfig", "properties": { "credential": { "description": "Credential is the secret containing credentials to connect to the OCM api on behalf of a user", "type": "string" }, "filters": { "description": "Sets restrictions on what kind of clusters to discover", "properties": { "lastActive": { "description": "LastActive is the last active in days of clusters to discover, determined by activity timestamp", "type": "integer" }, "openShiftVersions": { "description": "OpenShiftVersions is the list of release versions of OpenShift of the form \"<Major>.<Minor>\"", "items": { "description": "Semver represents a partial semver string with the major and minor version in the form \"<Major>.<Minor>\". For example: \"4.15\"", "pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$", "type": "string" }, "type": "array" } }, "type": "object" } }, "required": [ "credential" ], "type": "object" }, "status": { "description": "DiscoveryConfigStatus defines the observed state of DiscoveryConfig", "type": "object" } }, "type": "object" } }, "served": true, "storage": true, "subresources": { "status": {} } } ] }, "status": { "acceptedNames": { "kind": "", "plural": "" }, "conditions": [], "storedVersions": [] } }
1.17.2.2. 모든 DiscoveryConfig 쿼리
GET /operator.open-cluster-management.io/v1/namespaces/{namespace}/operator
1.17.2.2.1. 설명
자세한 내용은 Discovery config Operator를 쿼리합니다.
1.17.2.2.2. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
1.17.2.2.3. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.17.2.2.4. 사용
-
operator/yaml
1.17.2.2.5. 태그
- discoveryconfigs.discovery.open-cluster-management.io
1.17.2.3. DiscoveryConfig Operator 삭제
DELETE /operator.open-cluster-management.io/v1/namespaces/{namespace}/operator/{discoveryconfigs_name}
1.17.2.3.1. 매개 변수
유형 | 이름 | 설명 | 스키마 |
---|---|---|---|
헤더 |
COOKIE | 권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다. | string |
경로 |
application_name | 삭제할 Discovery Config Operator의 이름입니다. | string |
경로 |
네임스페이스 | 사용할 네임스페이스(예: default)입니다. | string |
1.17.2.3.2. 응답
HTTP 코드 | 설명 | 스키마 |
---|---|---|
200 | 성공 | 콘텐츠 없음 |
403 | 액세스 금지 | 콘텐츠 없음 |
404 | 리소스를 찾을 수 없음 | 콘텐츠 없음 |
500 | 내부 서비스 오류 | 콘텐츠 없음 |
503 | 서비스를 사용할 수 없음 | 콘텐츠 없음 |
1.17.2.3.3. 태그
- discoveryconfigs.operator.open-cluster-management.io
1.17.3. 정의
1.17.3.1. DiscoveryConfig
이름 | 설명 | 스키마 |
---|---|---|
apiVersion | discoveryconfigs의 버전이 지정된 스키마입니다. | string |
종류 | REST 리소스를 나타내는 문자열 값입니다. | string |
메타데이터 | 리소스를 정의하는 규칙을 설명합니다. | object |
사양 | DiscoveryConfig의 원하는 상태를 정의합니다. | 사양 목록을참조하십시오. |
1.17.3.2. 사양 목록
이름 | 설명 | 스키마 |
---|---|---|
인증 정보 | 인증 정보는 사용자를 대신하여 OCM API에 연결하기 위한 인증 정보가 포함된 시크릿입니다. | string |
필터 | 검색할 클러스터 유형에 대한 제한을 설정합니다. | 필터 목록보기 |
1.17.3.3. 필터 목록
이름 | 설명 | 스키마 |
---|---|---|
lastActive | LastActive는 활동 타임 스탬프에 의해 결정되는 검색 할 클러스터의 며칠 동안 마지막으로 활성 상태입니다. | integer |
openShiftVersions | OpenShiftVersions는 "<Major>.<Minor>" 형식의 OpenShift 릴리스 버전 목록입니다. | object |