编辑“︁Kubernetes API”︁

{{DISPLAYTITLE:Kubernetes API}}

'''Kubernetes API''' 是 Kubernetes 集群的核心接口，它定义了集群中所有资源对象的操作方式。无论是通过命令行工具（如 <code>kubectl</code>）还是直接发送 HTTP 请求，所有与 Kubernetes 交互的操作最终都会通过 API 完成。本文将详细介绍 Kubernetes API 的工作原理、核心概念及实际应用。

== 介绍 ==
Kubernetes API 是一个 RESTful 风格的 HTTP API，它允许用户查询和操作 Kubernetes 集群中的资源（如 Pod、Deployment、Service 等）。API 遵循声明式设计原则，用户只需描述期望的状态，Kubernetes 会负责将当前状态调整为期望状态。

API 的主要特点包括：
* '''标准化'''：所有资源都通过统一的 API 进行操作。
* '''可扩展'''：支持自定义资源（Custom Resource Definitions, CRDs）。
* '''版本化'''：API 分为稳定版本（如 <code>v1</code>）和测试版本（如 <code>v1beta1</code>）。

== API 结构 ==
Kubernetes API 的 URL 路径遵循以下格式：
<pre>
/api/{apiVersion}/namespaces/{namespace}/{resource}/{name}
</pre>
例如，查询默认命名空间中的 Pod 列表：
<pre>
/api/v1/namespaces/default/pods
</pre>

=== API 组 ===
Kubernetes 将 API 划分为多个逻辑组，例如：
* '''核心组'''（<code>/api/v1</code>）：包含 Pod、Service、Namespace 等核心资源。
* '''扩展组'''（如 <code>/apis/apps/v1</code>）：包含 Deployment、StatefulSet 等扩展资源。

== 实际操作示例 ==
=== 使用 kubectl 访问 API ===
<code>kubectl</code> 是 Kubernetes 官方命令行工具，它封装了 API 调用。例如，以下命令会向 API 发送请求以获取 Pod 列表：
<syntaxhighlight lang="bash">
kubectl get pods --v=6  # --v=6 显示详细的 API 请求日志
</syntaxhighlight>
输出示例：
<pre>
GET https://kubernetes-api-server/api/v1/namespaces/default/pods
</pre>

=== 直接调用 API ===
用户也可以通过 HTTP 直接访问 API。首先获取 API 服务器地址和认证令牌：
<syntaxhighlight lang="bash">
APISERVER=$(kubectl config view --minify -o jsonpath='{.clusters[0].cluster.server}')
TOKEN=$(kubectl get secret $(kubectl get serviceaccount default -o jsonpath='{.secrets[0].name}') -o jsonpath='{.data.token}' | base64 --decode)
</syntaxhighlight>

然后使用 <code>curl</code> 查询 Pod：
<syntaxhighlight lang="bash">
curl -X GET $APISERVER/api/v1/namespaces/default/pods --header "Authorization: Bearer $TOKEN" --insecure
</syntaxhighlight>

== API 版本控制 ==
Kubernetes 使用三种 API 版本：
* '''Alpha'''（如 <code>v1alpha1</code>）：可能包含错误，默认禁用。
* '''Beta'''（如 <code>v1beta1</code>）：经过测试，但可能仍有变化。
* '''Stable'''（如 <code>v1</code>）：生产环境推荐使用。

== 自定义资源（CRD） ==
用户可以通过 '''CustomResourceDefinition'''（CRD）扩展 API。例如，定义一个 <code>CronTab</code> 资源：
<syntaxhighlight lang="yaml">
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
  name: crontabs.stable.example.com
spec:
  group: stable.example.com
  versions:
    - name: v1
      served: true
      storage: true
      schema:
        openAPIV3Schema:
          type: object
          properties:
            spec:
              type: object
              properties:
                cronSpec:
                  type: string
                image:
                  type: string
  scope: Namespaced
  names:
    plural: crontabs
    singular: crontab
    kind: CronTab
</syntaxhighlight>

创建后，可以通过 <code>/apis/stable.example.com/v1/namespaces/default/crontabs</code> 访问该资源。

== 实际案例 ==
=== 自动化部署 ===
一个 CI/CD 系统可以通过 Kubernetes API 自动创建 Deployment。例如：
<syntaxhighlight lang="yaml">
apiVersion: apps/v1
kind: Deployment
metadata:
  name: nginx-deployment
spec:
  replicas: 3
  selector:
    matchLabels:
      app: nginx
  template:
    metadata:
      labels:
        app: nginx
    spec:
      containers:
      - name: nginx
        image: nginx:1.14.2
        ports:
        - containerPort: 80
</syntaxhighlight>
通过 API 提交此 YAML 后，Kubernetes 会自动创建 3 个 Nginx Pod。

=== 监控与扩缩容 ===
监控系统可以通过 API 获取 Pod 的 CPU 使用率，并根据指标自动调整 Deployment 的副本数。

== API 响应示例 ==
以下是获取 Pod 列表的 API 响应片段：
<syntaxhighlight lang="json">
{
  "kind": "PodList",
  "apiVersion": "v1",
  "metadata": {
    "resourceVersion": "12345"
  },
  "items": [
    {
      "metadata": {
        "name": "nginx-pod",
        "namespace": "default"
      },
      "spec": {
        "containers": [
          {
            "name": "nginx",
            "image": "nginx:1.14.2"
          }
        ]
      }
    }
  ]
}
</syntaxhighlight>

== 总结 ==
Kubernetes API 是集群管理的核心枢纽，它提供了：
* 统一的资源操作接口
* 声明式状态管理
* 可扩展的自定义资源支持
理解 API 是掌握 Kubernetes 的关键一步。无论是日常管理还是开发高级工具，API 都是不可或缺的组成部分。

[[Category:集成部署]]
[[Category:Kubernetes]]
[[Category:Kubernetes核心概念]]