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

APIService [apiregistration.k8s.io/v1]

规格

属性 类型 描述

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

对象

APIServiceSpec 包含用于查找和与服务器通信的信息。仅支持 https，但您可以禁用证书验证。

status

对象

APIServiceStatus 包含关于 API 服务器的派生信息

.spec

描述

APIServiceSpec 包含用于查找和与服务器通信的信息。仅支持 https，但您可以禁用证书验证。

类型

对象

必需

  • groupPriorityMinimum

  • versionPriority

属性 类型 描述

caBundle

字符串

CABundle 是一个 PEM 编码的 CA 捆绑包，它将用于验证 API 服务器的服务证书。如果未指定，则使用 apiserver 上的系统信任根。

group

字符串

Group 是此服务器托管的 API 组名称

groupPriorityMinimum

整数

GroupPriorityMinimum 是此组至少应具有的优先级。优先级越高表示客户端比优先级低的组更倾向于此组。请注意，此组的其他版本可能指定更高的 GroupPriorityMinimum 值，以便整个组获得更高的优先级。主要排序基于 GroupPriorityMinimum，按数字从高到低排序（20 在 10 之前）。次要排序基于对象的名称的字母顺序比较。（v1.bar 在 v1.foo 之前）我们建议：*.k8s.io（extensions 除外）为 18000，建议 PaaSes（OpenShift、Deis）在 2000 年代

insecureSkipTLSVerify

布尔值

InsecureSkipTLSVerify 在与该服务器通信时禁用 TLS 证书验证。强烈不建议这样做。您应该改用 CABundle。

service

对象

ServiceReference 包含对 Service.legacy.k8s.io 的引用

version

字符串

Version 是此服务器托管的 API 版本。例如，“v1”

versionPriority

整数

VersionPriority 控制其组内此 API 版本的排序。必须大于零。主要排序基于 VersionPriority，从高到低排序（20 在 10 之前）。由于它位于组内，因此数字可以很小，可能在 10 年代。如果版本优先级相等，则版本字符串将用于计算组内的顺序。如果版本字符串是“kube-like”，它将排在非“kube-like”版本字符串之上，这些字符串按字典顺序排序。“Kube-like”版本以“v”开头，后跟一个数字（主版本），然后可以选择字符串“alpha”或“beta”以及另一个数字（次版本）。这些首先按 GA > beta > alpha 排序（其中 GA 是没有 beta 或 alpha 等后缀的版本），然后通过比较主版本，然后比较次版本来排序。版本排序示例列表：v10、v2、v1、v11beta2、v10beta3、v3beta1、v12alpha1、v11alpha2、foo1、foo10。

.spec.service

描述

ServiceReference 包含对 Service.legacy.k8s.io 的引用

类型

对象

属性 类型 描述

name

字符串

Name 是服务的名称

namespace

字符串

Namespace 是服务的命名空间

port

整数

如果指定，则为托管 Webhook 的服务的端口。默认为 443，以确保向后兼容性。port 应为有效的端口号（1-65535，含）。

.status

描述

APIServiceStatus 包含关于 API 服务器的派生信息

类型

对象

属性 类型 描述

conditions

数组

apiService 的当前服务状态。

conditions[]

对象

APIServiceCondition 描述特定时间点 APIService 的状态

.status.conditions

描述

apiService 的当前服务状态。

类型

数组

.status.conditions[]

描述

APIServiceCondition 描述特定时间点 APIService 的状态

类型

对象

必需

  • type

  • status

属性 类型 描述

lastTransitionTime

时间

上次条件从一种状态转换到另一种状态。

消息

字符串

指示上次转换详细信息的人类可读消息。

原因

字符串

条件上次转换的唯一、单个单词、驼峰命名法原因。

status

字符串

状态是条件的状态。可以是 True、False、Unknown。

type

字符串

类型是条件的类型。

API 端点

提供以下 API 端点

  • /apis/apiregistration.k8s.io/v1/apiservices

    • DELETE：删除 APIService 集合

    • GET：列出或监视 APIService 对象

    • POST：创建 APIService

  • /apis/apiregistration.k8s.io/v1/watch/apiservices

    • GET：监视 APIService 列表的单个更改。已弃用：请改用列表操作中的“watch”参数。

  • /apis/apiregistration.k8s.io/v1/apiservices/{name}

    • DELETE：删除 APIService

    • GET：读取指定的 APIService

    • PATCH：部分更新指定的 APIService

    • PUT：替换指定的 APIService

  • /apis/apiregistration.k8s.io/v1/watch/apiservices/{name}

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

  • /apis/apiregistration.k8s.io/v1/apiservices/{name}/status

    • GET：读取指定的 APIService 的状态

    • PATCH：部分更新指定的 APIService 的状态

    • PUT：替换指定的 APIService 的状态

/apis/apiregistration.k8s.io/v1/apiservices

HTTP 方法

DELETE

描述

删除 APIService 集合

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

dryRun

字符串

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

200 - OK

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

列出或监视 APIService 对象

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

200 - OK

APIServiceList 模式

401 - 未授权

空
HTTP 方法

POST

描述

创建 APIService

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

dryRun

字符串

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

fieldValidation

字符串

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

body

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

200 - OK

APIService 模式

201 - 已创建

APIService 模式

202 - 已接受

APIService 模式

401 - 未授权

空

/apis/apiregistration.k8s.io/v1/watch/apiservices

HTTP 方法

GET

描述

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

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

200 - OK

WatchEvent 模式

401 - 未授权

空

/apis/apiregistration.k8s.io/v1/apiservices/{name}

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

name

字符串

APIService 的名称
HTTP 方法

DELETE

描述

删除 APIService

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

dryRun

字符串

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

200 - OK

Status 模式

202 - 已接受

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

读取指定的 APIService

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

200 - OK

APIService 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定的 APIService

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

dryRun

字符串

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

fieldValidation

字符串

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

200 - OK

APIService 模式

201 - 已创建

APIService 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定的 APIService

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

dryRun

字符串

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

fieldValidation

字符串

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

body

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

200 - OK

APIService 模式

201 - 已创建

APIService 模式

401 - 未授权

空

/apis/apiregistration.k8s.io/v1/watch/apiservices/{name}

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

name

字符串

APIService 的名称
HTTP 方法

GET

描述

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

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

200 - OK

WatchEvent 模式

401 - 未授权

空

/apis/apiregistration.k8s.io/v1/apiservices/{name}/status

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

name

字符串

APIService 的名称
HTTP 方法

GET

描述

读取指定的 APIService 的状态

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

200 - OK

APIService 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定的 APIService 的状态

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

dryRun

字符串

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

fieldValidation

字符串

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

200 - OK

APIService 模式

201 - 已创建

APIService 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定的 APIService 的状态

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

dryRun

字符串

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

fieldValidation

字符串

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

body

APIService 模式
表 25. HTTP 响应
HTTP 代码 响应体

200 - OK

APIService 模式

201 - 已创建

APIService 模式

401 - 未授权

空