Red Hat Summit 红帽全球峰会支持控制台（Console）开发人员开始试用联系人

1.16. DiscoveryConfig API

1.16.1. 概述
复制链接

本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的 DiscoveryConfig 资源相关的 API 信息。DiscoveryConfig 资源有 4 个可用的请求：create、query、delete 和 update。

1.16.1.1. 版本信息
复制链接

版本 : 2.5.0

1.16.1.2. URI scheme
复制链接

BasePath : /kubernetes/apis
Schemes : HTTPS

1.16.1.3. Tags
复制链接

  • discoveryconfigs.discovery.open-cluster-management.io : 创建和管理 DiscoveryConfigs

1.16.2. 路径
复制链接

1.16.2.1. 创建 DiscoveryConfig
复制链接

POST /app.k8s.io/v1/namespaces/{namespace}/discoveryconfigs
Copy to Clipboard Toggle word wrap
1.16.2.1.1. 描述
复制链接

创建 DiscoveryConfig。

1.16.2.1.2. 参数
复制链接
Expand
类型Name描述模式

Header

COOKIE
必需

身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

namespace
必需

要使用的命名空间，如 default。

字符串

Body

body
必需

描述要创建的 DiscoveryConfig 的参数。

DiscoveryConfig

1.16.2.1.3. 响应
复制链接
Expand
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.16.2.1.4. 使用
复制链接
  • discoveryconfigs/yaml
1.16.2.1.5. Tags
复制链接
  • 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": []
  }
}
Copy to Clipboard Toggle word wrap

1.16.2.2. 查询所有 DiscoveryConfigs
复制链接

GET /operator.open-cluster-management.io/v1/namespaces/{namespace}/operator
Copy to Clipboard Toggle word wrap
1.16.2.2.1. 描述
复制链接

查询发现配置 operator 以获取更多详细信息。

1.16.2.2.2. 参数
复制链接
Expand
类型Name描述模式

Header

COOKIE
必需

身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

namespace
必需

要使用的命名空间，如 default。

字符串

1.16.2.2.3. 响应
复制链接
Expand
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.16.2.2.4. 使用
复制链接
  • operator/yaml
1.16.2.2.5. Tags
复制链接
  • discoveryconfigs.discovery.open-cluster-management.io

1.16.2.3. 删除 DiscoveryConfig Operator
复制链接

DELETE /operator.open-cluster-management.io/v1/namespaces/{namespace}/operator/{discoveryconfigs_name}
Copy to Clipboard Toggle word wrap
1.16.2.3.1. 参数
复制链接
Expand
类型名称描述模式

Header

COOKIE
必需

身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

application_name
必需

要删除的 Discovery Config operator 的名称。

字符串

路径

namespace
必需

要使用的命名空间，如 default。

字符串

1.16.2.3.2. 响应
复制链接
Expand
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.16.2.3.3. Tags
复制链接
  • discoveryconfigs.operator.open-cluster-management.io

1.16.3. 定义
复制链接

1.16.3.1. DiscoveryConfig
复制链接

Expand
名称描述模式

apiVersion
必需

discoveryconfig 的版本化模式。

字符串

kind
必需

代表 REST 资源的字符串值。

字符串

metadata
必需

描述定义资源的规则。

object

spec
必需

定义 DiscoveryConfig 所需的状态。

请参阅 specs 列表

1.16.3.2. specs 列表
复制链接

Expand
名称描述模式

credential
必需

凭据是包含代表用户连接到 OCM API 的凭证的 secret。

字符串

filters
可选

对要发现的集群类型设置限制。

请参阅过滤器列表

1.16.3.3. 过滤器列表
复制链接

Expand
名称描述模式

lastActive
必需

lastActive 是集群中要发现的最新活跃天数的集群，由活动时间戳决定。

integer

openShiftVersions
optional

OpenShiftVersions 是 OpenShift 的发行版本列表，格式为 "<Major>.<Minor>"

object

返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务，以及可以信赖的内容，帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情，请参阅红帽博客.

關於紅帽

我们提供强化的解决方案，使企业能够更轻松地跨平台和环境（从核心数据中心到网络边缘）工作。

Theme

© 2025 Red Hat