×

规范

属性 类型 描述

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

对象

status

对象

.spec

描述
类型

对象

属性 类型 描述

context

字符串

事件的任意用户提供的上下文

destination

字符串

发送事件的 Webhook URL

hostName

字符串

对 BareMetalHost 的引用

httpHeadersRef

对象

包含 HTTP 头的密钥,在发出请求时应将其传递给目标

.spec.httpHeadersRef

描述

包含 HTTP 头的密钥,在发出请求时应将其传递给目标

类型

对象

属性 类型 描述

name

字符串

name 在命名空间内是唯一的,用于引用密钥资源。

namespace

字符串

namespace 定义密钥名称必须在其中唯一的空间。

.status

描述
类型

对象

属性 类型 描述

error

字符串

subscriptionID

字符串

API 端点

提供以下 API 端点

  • /apis/metal3.io/v1alpha1/bmceventsubscriptions

    • GET:列出 BMCEventSubscription 类型的对象

  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/bmceventsubscriptions

    • DELETE:删除 BMCEventSubscription 集合

    • GET:列出 BMCEventSubscription 类型的对象

    • POST:创建一个 BMCEventSubscription

  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/bmceventsubscriptions/{name}

    • DELETE:删除一个 BMCEventSubscription

    • GET:读取指定的 BMCEventSubscription

    • PATCH:部分更新指定的 BMCEventSubscription

    • PUT:替换指定的 BMCEventSubscription

  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/bmceventsubscriptions/{name}/status

    • GET:读取指定的 BMCEventSubscription 的状态

    • PATCH:部分更新指定的 BMCEventSubscription 的状态

    • PUT:替换指定的 BMCEventSubscription 的状态

/apis/metal3.io/v1alpha1/bmceventsubscriptions

HTTP 方法

GET

描述

列出 BMCEventSubscription 类型的对象

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

200 - OK

BMCEventSubscriptionList 模式

401 - 未授权

/apis/metal3.io/v1alpha1/namespaces/{namespace}/bmceventsubscriptions

HTTP 方法

DELETE

描述

删除 BMCEventSubscription 集合

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

200 - OK

Status 模式

401 - 未授权

HTTP 方法

GET

描述

列出 BMCEventSubscription 类型的对象

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

200 - OK

BMCEventSubscriptionList 模式

401 - 未授权

HTTP 方法

POST

描述

创建 BMCEventSubscription

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

dryRun

字符串

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

fieldValidation

字符串

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

表 5. 请求体参数
参数 类型 描述

body

BMCEventSubscription 模式

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

200 - OK

BMCEventSubscription 模式

201 - 已创建

BMCEventSubscription 模式

202 - 已接受

BMCEventSubscription 模式

401 - 未授权

/apis/metal3.io/v1alpha1/namespaces/{namespace}/bmceventsubscriptions/{name}

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

name

字符串

BMCEventSubscription 的名称

HTTP 方法

DELETE

描述

删除 BMCEventSubscription

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

dryRun

字符串

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

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

200 - OK

Status 模式

202 - 已接受

Status 模式

401 - 未授权

HTTP 方法

GET

描述

读取指定的 BMCEventSubscription

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

200 - OK

BMCEventSubscription 模式

401 - 未授权

HTTP 方法

PATCH

描述

部分更新指定的 BMCEventSubscription

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

dryRun

字符串

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

fieldValidation

字符串

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

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

200 - OK

BMCEventSubscription 模式

401 - 未授权

HTTP 方法

PUT

描述

替换指定的 BMCEventSubscription

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

dryRun

字符串

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

fieldValidation

字符串

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

表 14. 请求体参数
参数 类型 描述

body

BMCEventSubscription 模式

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

200 - OK

BMCEventSubscription 模式

201 - 已创建

BMCEventSubscription 模式

401 - 未授权

/apis/metal3.io/v1alpha1/namespaces/{namespace}/bmceventsubscriptions/{name}/status

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

name

字符串

BMCEventSubscription 的名称

HTTP 方法

GET

描述

读取指定的 BMCEventSubscription 的状态

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

200 - OK

BMCEventSubscription 模式

401 - 未授权

HTTP 方法

PATCH

描述

部分更新指定的 BMCEventSubscription 的状态

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

dryRun

字符串

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

fieldValidation

字符串

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

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

200 - OK

BMCEventSubscription 模式

401 - 未授权

HTTP 方法

PUT

描述

替换指定的 BMCEventSubscription 的状态

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

dryRun

字符串

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

fieldValidation

字符串

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

表 21. 请求体参数
参数 类型 描述

body

BMCEventSubscription 模式

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

200 - OK

BMCEventSubscription 模式

201 - 已创建

BMCEventSubscription 模式

401 - 未授权