Kubernetes API

Kubernetes API 允许您查询和操作 Kubernetes 中对象的狀態。Kubernetes 控制平面的核心是 API 服务器及其公开的 HTTP API。用户、集群的不同部分以及外部组件都通过 API 服务器相互通信。

Kubernetes 控制平面的核心是 API 服务器。API 服务器公开了一个 HTTP API，允许最终用户、集群的不同部分以及外部组件相互通信。

Kubernetes API 允许您查询和操作 Kubernetes 中 API 对象的狀態（例如：Pod、命名空间、ConfigMap 和事件）。

大多数操作可以通过 kubectl 命令行界面或其他命令行工具（例如 kubeadm）执行，这些工具反过来使用 API。但是，您也可以使用 REST 调用直接访问 API。Kubernetes 为希望使用 Kubernetes API 编写应用程序的人提供了一组客户端库。

每个 Kubernetes 集群都会发布集群提供的 API 的规范。Kubernetes 使用两种机制来发布这些 API 规范；两者都有助于实现自动互操作性。例如，kubectl 工具会获取和缓存 API 规范，以启用命令行补全和其他功能。两种支持的机制如下

发现 API 提供有关 Kubernetes API 的信息：API 名称、资源、版本和支持的操作。这是一个 Kubernetes 特定的术语，因为它是一个与 Kubernetes OpenAPI 不同的 API。它旨在简要概述可用的资源，它不详细说明资源的特定模式。有关资源模式的参考，请参阅 OpenAPI 文档。
Kubernetes OpenAPI 文档提供所有 Kubernetes API 端点的（完整）OpenAPI v2.0 和 3.0 模式。OpenAPI v3 是访问 OpenAPI 的首选方法，因为它提供了更全面、更准确的 API 视图。它包括所有可用的 API 路径，以及所有资源，以及对每个端点上的每个操作的消费和产生。它还包括集群支持的任何可扩展性组件。这些数据是完整的规范，并且比发现 API 中的数据大得多。

发现 API

Kubernetes 通过发现 API 发布所有组版本和资源的列表。这包括每个资源的以下内容

名称
集群或命名空间范围
端点 URL 和支持的动词
备用名称
组、版本、种类

API 以聚合和非聚合形式提供。聚合发现提供两个端点，而非聚合发现为每个组版本提供一个单独的端点。

聚合发现

功能状态： Kubernetes v1.30 [稳定]

Kubernetes 为聚合发现提供稳定支持，通过两个端点（/api 和 /apis）发布集群支持的所有资源。请求此端点会显着减少发送到集群以获取发现数据的请求数量。您可以通过请求具有指示聚合发现资源的 Accept 标头的相应端点来访问数据：Accept: application/json;v=v2;g=apidiscovery.k8s.io;as=APIGroupDiscoveryList。

如果不使用 Accept 标头指示资源类型，/api 和 /apis 端点的默认响应是非聚合发现文档。

内置资源的发现文档可在 Kubernetes GitHub 存储库中找到。如果 Kubernetes 集群不可用以进行查询，则可以使用此 Github 文档作为可用资源基本集的参考。

该端点还支持 ETag 和 protobuf 编码。

非聚合发现

在没有发现聚合的情况下，发现按层级发布，根端点发布下游文档的发现信息。

集群支持的所有组版本的列表在 /api 和 /apis 端点发布。示例

{
  "kind": "APIGroupList",
  "apiVersion": "v1",
  "groups": [
    {
      "name": "apiregistration.k8s.io",
      "versions": [
        {
          "groupVersion": "apiregistration.k8s.io/v1",
          "version": "v1"
        }
      ],
      "preferredVersion": {
        "groupVersion": "apiregistration.k8s.io/v1",
        "version": "v1"
      }
    },
    {
      "name": "apps",
      "versions": [
        {
          "groupVersion": "apps/v1",
          "version": "v1"
        }
      ],
      "preferredVersion": {
        "groupVersion": "apps/v1",
        "version": "v1"
      }
    },
    ...
}

需要额外的请求才能在 /apis/<group>/<version>（例如：/apis/rbac.authorization.k8s.io/v1alpha1）处获得每个组版本的发现文档，该文档会宣传在特定组版本下提供的资源列表。这些端点由 kubectl 用于获取集群支持的资源列表。

OpenAPI 接口定义

有关 OpenAPI 规范的详细信息，请参阅 OpenAPI 文档。

Kubernetes 提供 OpenAPI v2.0 和 OpenAPI v3.0。OpenAPI v3 是访问 OpenAPI 的首选方法，因为它提供了更全面的（无损）Kubernetes 资源表示。由于 OpenAPI 版本 2 的限制，某些字段已从发布的 OpenAPI 中删除，包括但不限于 default、nullable、oneOf。

OpenAPI V2

Kubernetes API 服务器通过 /openapi/v2 端点提供一个聚合的 OpenAPI v2 规范。您可以使用请求标头请求响应格式，如下所示

OpenAPI v2 查询的有效请求标头值
标头	可能的值	注释
`Accept-Encoding`	`gzip`	不提供此标头也是可以接受的
`Accept`	`application/com.github.proto-openapi.spec.v2@v1.0+protobuf`	主要用于集群内使用
	`application/json`	默认
	`*`	提供`application/json`

OpenAPI V3

功能状态： Kubernetes v1.27 [稳定]

Kubernetes 支持将 API 描述发布为 OpenAPI v3。

提供一个发现端点 /openapi/v3 来查看所有可用的组/版本列表。此端点仅返回 JSON。这些组/版本以以下格式提供

{
    "paths": {
        ...,
        "api/v1": {
            "serverRelativeURL": "/openapi/v3/api/v1?hash=CC0E9BFD992D8C59AEC98A1E2336F899E8318D3CF4C68944C3DEC640AF5AB52D864AC50DAA8D145B3494F75FA3CFF939FCBDDA431DAD3CA79738B297795818CF"
        },
        "apis/admissionregistration.k8s.io/v1": {
            "serverRelativeURL": "/openapi/v3/apis/admissionregistration.k8s.io/v1?hash=E19CC93A116982CE5422FC42B590A8AFAD92CDE9AE4D59B5CAAD568F083AD07946E6CB5817531680BCE6E215C16973CD39003B0425F3477CFD854E89A9DB6597"
        },
        ....
    }
}

相对 URL 指向不可变的 OpenAPI 描述，以提高客户端缓存效率。API 服务器还为该目的设置了正确的 HTTP 缓存标头（Expires 在未来 1 年内，Cache-Control 为 immutable）。当使用过时的 URL 时，API 服务器将返回一个重定向到最新 URL 的重定向。

Kubernetes API 服务器在 /openapi/v3/apis/<group>/<version>?hash=<hash> 端点发布每个 Kubernetes 组版本的 OpenAPI v3 规范。

请参阅下表了解可接受的请求标头。

OpenAPI v3 查询的有效请求标头值
标头	可能的值	注释
`Accept-Encoding`	`gzip`	不提供此标头也是可以接受的
`Accept`	`application/com.github.proto-openapi.spec.v3@v1.0+protobuf`	主要用于集群内使用
	`application/json`	默认
	`*`	提供`application/json`

Golang 实现用于获取 OpenAPI V3 在包 k8s.io/client-go/openapi3 中提供。

Kubernetes 1.31 发布 OpenAPI v2.0 和 v3.0；目前没有计划在短期内支持 3.1。

Protobuf 序列化

Kubernetes 实现了一个基于 Protobuf 的替代序列化格式，该格式主要用于集群内通信。有关此格式的更多信息，请参阅 Kubernetes Protobuf 序列化设计提案以及位于定义 API 对象的 Go 包中的每个模式的接口定义语言 (IDL) 文件。

持久性

Kubernetes 通过将对象的序列化状态写入 etcd 来存储这些状态。

API 组和版本控制

为了更容易地消除字段或重新构造资源表示，Kubernetes 支持多个 API 版本，每个版本都在不同的 API 路径，例如 /api/v1 或 /apis/rbac.authorization.k8s.io/v1alpha1。

版本控制是在 API 级而不是在资源或字段级别进行的，以确保 API 对系统资源和行为提供清晰一致的视图，并能够控制对生命周期结束和/或实验性 API 的访问。

为了更容易地发展和扩展其 API，Kubernetes 实现 API 组，这些组可以启用或禁用。

API 资源通过其 API 组、资源类型、命名空间（对于命名空间资源）和名称来区分。API 服务器透明地处理 API 版本之间的转换：所有不同的版本实际上都是相同持久化数据的表示形式。API 服务器可能通过多个 API 版本提供相同的基础数据。

例如，假设同一个资源有两个 API 版本，v1 和 v1beta1。如果您最初使用 API 的 v1beta1 版本创建了一个对象，那么您之后可以使用 v1beta1 或 v1 API 版本读取、更新或删除该对象，直到 v1beta1 版本被弃用并删除。到那时，您可以继续使用 v1 API 访问和修改该对象。

API 更改

任何成功的系统都需要随着新用例的出现或现有用例的变化而发展和改变。因此，Kubernetes 设计了 Kubernetes API 以持续变化和发展。Kubernetes 项目的目标是 *不* 破坏与现有客户端的兼容性，并保持该兼容性一段时间，以便其他项目有机会进行调整。

通常，可以经常添加新的 API 资源和新的资源字段。资源或字段的消除需要遵循 API 弃用策略。

Kubernetes 承诺在官方 Kubernetes API 达到通用可用性 (GA) 时（通常在 API 版本 v1 时）保持兼容性。此外，Kubernetes 保持与通过官方 Kubernetes API 的 *beta* API 版本持久化数据的兼容性，并确保在功能稳定后，可以通过 GA API 版本转换和访问数据。

如果您采用 beta API 版本，则需要在 API 毕业后过渡到后续 beta 或稳定 API 版本。最佳时机是在 beta API 处于弃用期期间，因为此时可以通过两种 API 版本同时访问对象。一旦 beta API 完成其弃用期并不再提供服务，则必须使用替换的 API 版本。

注意

虽然 Kubernetes 还旨在维护 *alpha* API 版本的兼容性，但在某些情况下这是不可能的。如果您使用任何 alpha API 版本，请在升级集群时查看 Kubernetes 的发行说明，以防 API 以不兼容的方式发生更改，需要在升级之前删除所有现有的 alpha 对象。

有关 API 版本级别定义的更多详细信息，请参阅 API 版本参考。

API 扩展

Kubernetes API 可以通过以下两种方式之一进行扩展

自定义资源允许您声明性地定义 API 服务器应如何提供您选择的资源 API。
您还可以通过实现聚合层来扩展 Kubernetes API。

下一步

了解如何通过添加您自己的 CustomResourceDefinition 来扩展 Kubernetes API。
控制对 Kubernetes API 的访问描述了集群如何管理对 API 访问的认证和授权。
通过阅读 API 参考来了解 API 端点、资源类型和示例。
从 API 更改了解构成兼容更改的内容以及如何更改 API。

上次修改时间：2024 年 7 月 4 日下午 9:15 PST：修复发现文档的断开链接 (2b1ea305be)

Kubernetes API

发现 API

聚合发现

非聚合发现

OpenAPI 接口定义

OpenAPI V2

OpenAPI V3

Protobuf 序列化

持久性

API 组和版本控制

API 更改

注意

API 扩展

下一步

反馈