OpenShift 文档正在迁移，不久后将仅在 docs.redhat.com（所有 Red Hat 产品文档的中心）提供。立即体验 新的文档体验。
  1. 文档
    2. history bug_report picture_as_pdf
×

IngressClass [networking.k8s.io/v1]

描述

IngressClass表示Ingress的类别，由Ingress Spec引用。ingressclass.kubernetes.io/is-default-class注释可用于指示应将IngressClass视为默认值。当单个IngressClass资源将此注释设置为true时，没有指定类的新Ingress资源将被分配此默认类。

类型

对象

规格

属性 类型 描述

apiVersion

字符串

APIVersion定义此对象表示的版本化模式。服务器应将识别的模式转换为最新的内部值，并可能拒绝无法识别的值。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

字符串

Kind是一个字符串值，表示此对象表示的REST资源。服务器可以从客户端提交请求的端点推断出这一点。无法更新。使用驼峰命名法。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

标准对象的元数据。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

对象

IngressClassSpec提供有关Ingress类别的信息。

.spec

描述

IngressClassSpec提供有关Ingress类别的信息。

类型

对象

属性 类型 描述

controller

字符串

controller指的是应该处理此类的控制器的名称。这允许由相同控制器控制的不同“风格”。例如，您可以为相同的实现控制器设置不同的参数。这应指定为长度不超过250个字符的域前缀路径，例如“acme.io/ingress-controller”。此字段是不可变的。

parameters

对象

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

.spec.parameters

描述

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

类型

对象

必需

  • kind

  • name

属性 类型 描述

apiGroup

字符串

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

kind

字符串

kind是被引用资源的类型。

name

字符串

name是被引用资源的名称。

namespace

字符串

namespace是被引用资源的命名空间。当scope设置为“Namespace”时，此字段是必需的；当scope设置为“Cluster”时，此字段必须取消设置。

scope

字符串

scope表示这指的是集群范围还是命名空间范围的资源。这可以设置为“Cluster”（默认）或“Namespace”。

API端点

提供以下API端点

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

    • DELETE：删除IngressClass集合

    • GET：列出或监视IngressClass类型的对象

    • POST：创建IngressClass

  • /apis/networking.k8s.io/v1/watch/ingressclasses

    • GET：监视对IngressClass列表的单个更改。已弃用：改为使用列表操作的“watch”参数。

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

    • DELETE：删除IngressClass

    • GET：读取指定的IngressClass

    • PATCH：部分更新指定的IngressClass

    • PUT：替换指定的IngressClass

  • /apis/networking.k8s.io/v1/watch/ingressclasses/{name}

    • GET：监视对IngressClass类型对象的更改。已弃用：改为使用列表操作的“watch”参数，并使用“fieldSelector”参数过滤为单个项目。

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

HTTP方法

DELETE

描述

删除IngressClass集合

表1. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应保存修改。无效或无法识别的dryRun指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有dry run阶段
表2. HTTP响应
HTTP代码 响应体

200 - OK

Status 模式

401 - 未授权

空
HTTP方法

GET

描述

列出或监听 IngressClass 对象

表 3. HTTP 响应
HTTP代码 响应体

200 - OK

IngressClassList 模式

401 - 未授权

空
HTTP方法

POST

描述

创建 IngressClass

表 4. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应保存修改。无效或无法识别的dryRun指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有dry run阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：忽略任何未知字段，这些字段将从对象中静默删除，并且忽略解码器遇到的所有重复字段（只保留最后一个）。这是 v1.23 之前的默认行为。- Warn：对于从对象中删除的每个未知字段以及遇到的每个重复字段，都将通过标准警告响应头发送警告。如果没有任何其他错误，请求仍将成功，并且只会保留任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值。- Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，则将使用 BadRequest 错误使请求失败。服务器返回的错误将包含遇到的所有未知和重复字段。
表 5. 请求体参数
参数 类型 描述

body

IngressClass 模式
表 6. HTTP 响应
HTTP代码 响应体

200 - OK

IngressClass 模式

201 - 已创建

IngressClass 模式

202 - 已接受

IngressClass 模式

401 - 未授权

空

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

HTTP方法

GET

描述

监听 IngressClass 列表的单个更改。已弃用：请改用列表操作中的“watch”参数。

表 7. HTTP 响应
HTTP代码 响应体

200 - OK

WatchEvent 模式

401 - 未授权

空

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

表 8. 全局路径参数
参数 类型 描述

name

字符串

IngressClass 的名称
HTTP方法

DELETE

描述

删除 IngressClass

表 9. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应保存修改。无效或无法识别的dryRun指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有dry run阶段
表 10. HTTP 响应
HTTP代码 响应体

200 - OK

Status 模式

202 - 已接受

Status 模式

401 - 未授权

空
HTTP方法

GET

描述

读取指定的 IngressClass

表 11. HTTP 响应
HTTP代码 响应体

200 - OK

IngressClass 模式

401 - 未授权

空
HTTP方法

PATCH

描述

部分更新指定的 IngressClass

表 12. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应保存修改。无效或无法识别的dryRun指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有dry run阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：忽略任何未知字段，这些字段将从对象中静默删除，并且忽略解码器遇到的所有重复字段（只保留最后一个）。这是 v1.23 之前的默认行为。- Warn：对于从对象中删除的每个未知字段以及遇到的每个重复字段，都将通过标准警告响应头发送警告。如果没有任何其他错误，请求仍将成功，并且只会保留任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值。- Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，则将使用 BadRequest 错误使请求失败。服务器返回的错误将包含遇到的所有未知和重复字段。
表 13. HTTP 响应
HTTP代码 响应体

200 - OK

IngressClass 模式

201 - 已创建

IngressClass 模式

401 - 未授权

空
HTTP方法

PUT

描述

替换指定的 IngressClass

表 14. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应保存修改。无效或无法识别的dryRun指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有dry run阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：忽略任何未知字段，这些字段将从对象中静默删除，并且忽略解码器遇到的所有重复字段（只保留最后一个）。这是 v1.23 之前的默认行为。- Warn：对于从对象中删除的每个未知字段以及遇到的每个重复字段，都将通过标准警告响应头发送警告。如果没有任何其他错误，请求仍将成功，并且只会保留任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值。- Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，则将使用 BadRequest 错误使请求失败。服务器返回的错误将包含遇到的所有未知和重复字段。
表 15. 请求体参数
参数 类型 描述

body

IngressClass 模式
表 16. HTTP 响应
HTTP代码 响应体

200 - OK

IngressClass 模式

201 - 已创建

IngressClass 模式

401 - 未授权

空

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

表 17. 全局路径参数
参数 类型 描述

name

字符串

IngressClass 的名称
HTTP方法

GET

描述

监听 IngressClass 对象的更改。已弃用：请改用列表操作中的“watch”参数，并使用“fieldSelector”参数过滤为单个项目。

表 18. HTTP 响应
HTTP代码 响应体

200 - OK

WatchEvent 模式

401 - 未授权

空