IngressClass

IngressClass 表示 Ingress 的类别,由 Ingress Spec 引用。

apiVersion: networking.k8s.io/v1

import "k8s.io/api/networking/v1"

IngressClass

IngressClass 表示 Ingress 的类别,由 Ingress Spec 引用。可以使用 ingressclass.kubernetes.io/is-default-class 注解来指示一个 IngressClass 应该被认为是默认的。当只有一个 IngressClass 资源将此注解设置为 true 时,未指定类的新 Ingress 资源将被分配此默认类。


IngressClassSpec

IngressClassSpec 提供了关于 Ingress 类别的详细信息。


  • controller (string)

    controller 指的是应该处理此类别的控制器的名称。这允许由同一控制器控制不同的“类型”。例如,您可能对同一个实现控制器有不同的参数。这应该指定为一个域前缀路径,长度不超过 250 个字符,例如 "acme.io/ingress-controller"。此字段不可变。

  • parameters (IngressClassParametersReference)

    parameters 是一个指向自定义资源的链接,该资源包含控制器的附加配置。如果控制器不需要额外的参数,此字段是可选的。

    IngressClassParametersReference 标识一个 API 对象。此字段可用于指定集群或命名空间范围的资源。

    • parameters.kind (string),必需

      kind 是所引用资源的类型。

    • parameters.name (string),必需

      name 是所引用资源的名称。

    • parameters.apiGroup (string)

      apiGroup 是所引用资源的 API 组。如果未指定 APIGroup,则指定的 Kind 必须在核心 API 组中。对于任何其他第三方类型,APIGroup 是必需的。

    • parameters.namespace (string)

      namespace 是所引用资源的命名空间。当 scope 设置为 "Namespace" 时,此字段是必需的;当 scope 设置为 "Cluster" 时,此字段必须未设置。

    • parameters.scope (string)

      scope 表示这指的是集群范围还是命名空间范围的资源。此字段可以设置为 "Cluster"(默认)或 "Namespace"。

IngressClassList

IngressClassList 是一个 IngressClass 的集合。


  • apiVersion: networking.k8s.io/v1

  • kind: IngressClassList

  • metadata (ListMeta)

    标准列表元数据。

  • items ([]IngressClass),必需

    items 是 IngressClasses 的列表。

操作


get 读取指定的 IngressClass

HTTP 请求

GET /apis/networking.k8s.io/v1/ingressclasses/{name}

参数

  • name (在路径中): string,必需

    IngressClass 的名称

  • pretty (在查询中): string

    pretty

响应

200 (IngressClass): 成功

401: 未授权

list 列出或监听 IngressClass 类型的对象

HTTP 请求

GET /apis/networking.k8s.io/v1/ingressclasses

参数

响应

200 (IngressClassList): 成功

401: 未授权

create 创建一个 IngressClass

HTTP 请求

POST /apis/networking.k8s.io/v1/ingressclasses

参数

响应

200 (IngressClass): 成功

201 (IngressClass): 已创建

202 (IngressClass): 已接受

401: 未授权

update 替换指定的 IngressClass

HTTP 请求

PUT /apis/networking.k8s.io/v1/ingressclasses/{name}

参数

  • name (在路径中): string,必需

    IngressClass 的名称

  • body: IngressClass,必需

  • dryRun (在查询中): string

    dryRun

  • fieldManager (在查询中): string

    fieldManager

  • fieldValidation (在查询中): string

    fieldValidation

  • pretty (在查询中): string

    pretty

响应

200 (IngressClass): 成功

201 (IngressClass): 已创建

401: 未授权

patch 部分更新指定的 IngressClass

HTTP 请求

PATCH /apis/networking.k8s.io/v1/ingressclasses/{name}

参数

  • name (在路径中): string,必需

    IngressClass 的名称

  • body: Patch,必需

  • dryRun (在查询中): string

    dryRun

  • fieldManager (在查询中): string

    fieldManager

  • fieldValidation (在查询中): string

    fieldValidation

  • force (在查询中): boolean

    force

  • pretty (在查询中): string

    pretty

响应

200 (IngressClass): 成功

201 (IngressClass): 已创建

401: 未授权

delete 删除一个 IngressClass

HTTP 请求

DELETE /apis/networking.k8s.io/v1/ingressclasses/{name}

参数

响应

200 (Status): 成功

202 (Status): 已接受

401: 未授权

deletecollection 删除 IngressClass 集合

HTTP 请求

DELETE /apis/networking.k8s.io/v1/ingressclasses

参数

响应

200 (Status): 成功

401: 未授权

本页面是自动生成的。

如果你打算报告此页面的问题,请在你的问题描述中提及此页面是自动生成的。修复可能需要在 Kubernetes 项目的其他地方进行。

上次修改于 2025 年 4 月 9 日下午 6:36 PST:Update API reference docs for v1.32 (a3b579d035)