검색

1.16. DiscoveryConfig API

download PDF

1.16.1. 개요

이 문서는 Red Hat Advanced Cluster Management for Kubernetes용 DiscoveryConfig 리소스용입니다. DiscoveryConfig 리소스에는 생성, 쿼리, 삭제, 업데이트 등 네 가지 요청이 있습니다.

1.16.1.1. 버전 정보

버전 : 2.5.0

1.16.1.2. URI 스키마

BasePath : /kubernetes/apis
Schemes : HTTPS

1.16.1.3. 태그

  • discoveryconfigs.discovery.open-cluster-management.io : DiscoveryConfig 만들기 및 관리

1.16.2. 경로

1.16.2.1. DiscoveryConfig 생성

POST /app.k8s.io/v1/namespaces/{namespace}/discoveryconfigs
1.16.2.1.1. 설명

DiscoveryConfig를 생성합니다.

1.16.2.1.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

네임스페이스
필요

사용하려는 네임스페이스(예: default)입니다.

string

body

본문
필요

생성할 DiscoveryConfig를 설명하는 매개변수입니다.

DiscoveryConfig

1.16.2.1.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.16.2.1.4. Use
  • discoveryconfigs/yaml
1.16.2.1.5. 태그
  • discoveryconfigs.discovery.open-cluster-management.io
1.16.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.5\"",
                          "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.16.2.2. 모든 DiscoveryConfigs 쿼리

GET /operator.open-cluster-management.io/v1/namespaces/{namespace}/operator
1.16.2.2.1. 설명

자세한 내용은 검색 구성 Operator를 쿼리합니다.

1.16.2.2.2. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

네임스페이스
필요

사용하려는 네임스페이스(예: default)입니다.

string

1.16.2.2.3. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.16.2.2.4. Use
  • operator/yaml
1.16.2.2.5. 태그
  • discoveryconfigs.discovery.open-cluster-management.io

1.16.2.3. DiscoveryConfig Operator 삭제

DELETE /operator.open-cluster-management.io/v1/namespaces/{namespace}/operator/{discoveryconfigs_name}
1.16.2.3.1. 매개 변수
유형이름설명스키마

header

COOKIE
필요

권한 부여: 베어러 {ACCESS_TOKEN} ; ACCESS_TOKEN은 사용자 액세스 토큰입니다.

string

경로

application_name
required

삭제할 Discovery Config Operator의 이름입니다.

string

경로

네임스페이스
필요

사용하려는 네임스페이스(예: default)입니다.

string

1.16.2.3.2. 응답
HTTP 코드설명스키마

200

성공

콘텐츠 없음

403

액세스 금지

콘텐츠 없음

404

리소스를 찾을 수 없음

콘텐츠 없음

500

내부 서비스 오류

콘텐츠 없음

503

서비스를 사용할 수 없음

콘텐츠 없음

1.16.2.3.3. 태그
  • discoveryconfigs.operator.open-cluster-management.io

1.16.3. 정의

1.16.3.1. DiscoveryConfig

이름설명스키마

apiVersion
필요

버전이 지정된 discoveryconfigs 스키마입니다.

string

kind
필수

REST 리소스를 나타내는 문자열 값입니다.

string

메타데이터
필요

리소스를 정의하는 규칙을 설명합니다.

object

spec
필수

원하는 DiscoveryConfig 상태를 정의합니다.

사양 목록보기

1.16.3.2. 사양 목록

이름설명스키마

인증 정보
필요

자격 증명은 사용자를 대신하여 OCM API에 연결할 인증 정보가 포함된 시크릿입니다.

string


필터선택 사항

검색할 클러스터 유형에 대한 제한을 설정합니다.

필터 목록보기

1.16.3.3. 필터 목록

이름설명스키마

lastActive
required

LastActive는 활동 타임 스탬프에 따라 감지할 클러스터의 마지막 활성 기간입니다.

integer

openShiftVersions
optional

OpenShiftVersions는 "<Major>.<Minor>" 형식의 OpenShift 릴리스 버전 목록입니다.

object

Red Hat logoGithubRedditYoutubeTwitter

자세한 정보

평가판, 구매 및 판매

커뮤니티

Red Hat 문서 정보

Red Hat을 사용하는 고객은 신뢰할 수 있는 콘텐츠가 포함된 제품과 서비스를 통해 혁신하고 목표를 달성할 수 있습니다.

보다 포괄적 수용을 위한 오픈 소스 용어 교체

Red Hat은 코드, 문서, 웹 속성에서 문제가 있는 언어를 교체하기 위해 최선을 다하고 있습니다. 자세한 내용은 다음을 참조하세요.Red Hat 블로그.

Red Hat 소개

Red Hat은 기업이 핵심 데이터 센터에서 네트워크 에지에 이르기까지 플랫폼과 환경 전반에서 더 쉽게 작업할 수 있도록 강화된 솔루션을 제공합니다.

© 2024 Red Hat, Inc.