PodNetworkConnectivityCheck [controlplane.operator.openshift.io/v1alpha1] - 网络 API | API 参考 | OpenShift Container Platform 4.17

描述

PodNetworkConnectivityCheck 兼容性级别 4：不提供兼容性，API 随时可能因任何原因发生更改。这些功能不应被需要长期支持的应用程序使用。

类型

对象

必需

spec

规格

属性类型描述

属性	类型	描述
`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`	`对象`	Spec 定义连接检查的源和目标
`status`	`对象`	Status 包含连接检查的观察状态

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

对象

Spec 定义连接检查的源和目标

status

对象

Status 包含连接检查的观察状态

.spec

描述

Spec 定义连接检查的源和目标

类型

对象

必需

sourcePod
targetEndpoint

属性类型描述

属性	类型	描述
`sourcePod`	`字符串`	SourcePod 指定将检查其条件的 Pod。
`targetEndpoint`	`字符串`	要检查的EndpointAddress。形式为 host:port 的 TCP 地址。请注意，如果 host 是 DNS 名称，则如果无法解析 DNS 名称，则检查将失败。指定 host 的 IP 地址以绕过 DNS 名称查找。
`tlsClientCert`	`对象`	如果指定了TLSClientCert，则引用 kubernetes.io/tls 类型密钥，其中包含 'tls.crt' 和 'tls.key' 条目，其中包含可选的 TLS 客户端证书和密钥，用于检查需要客户端证书的端点，以便在不导致端点进程中出现过度日志记录的情况下优雅地执行扫描。密钥必须存在于与此资源相同的命名空间中。

sourcePod

字符串

SourcePod 指定将检查其条件的 Pod。

targetEndpoint

字符串

要检查的EndpointAddress。形式为 host:port 的 TCP 地址。请注意，如果 host 是 DNS 名称，则如果无法解析 DNS 名称，则检查将失败。指定 host 的 IP 地址以绕过 DNS 名称查找。

tlsClientCert

对象

如果指定了TLSClientCert，则引用 kubernetes.io/tls 类型密钥，其中包含 'tls.crt' 和 'tls.key' 条目，其中包含可选的 TLS 客户端证书和密钥，用于检查需要客户端证书的端点，以便在不导致端点进程中出现过度日志记录的情况下优雅地执行扫描。密钥必须存在于与此资源相同的命名空间中。

.spec.tlsClientCert

描述

类型

对象

必需

name

属性类型描述

属性	类型	描述
`name`	`字符串`	name 是引用的密钥的 metadata.name。

name

字符串

name 是引用的密钥的 metadata.name。

.status

描述: Status 包含连接检查的观察状态
类型: 对象

属性类型描述

属性	类型	描述
`conditions`	`数组`	Conditions 总结了检查的状态
`conditions[]`	`对象`	PodNetworkConnectivityCheckCondition 表示 Pod 网络连接的整体状态。
`failures`	`数组`	Failures 包含不成功检查操作的日志。
`failures[]`	`对象`	LogEntry 记录事件。
`outages`	`数组`	Outages 包含中断时间段的日志。
`outages[]`	`对象`	OutageEntry 记录中断的时间段。
`successes`	`数组`	Successes 包含成功检查操作的日志。
`successes[]`	`对象`	LogEntry 记录事件。

conditions

数组

Conditions 总结了检查的状态

conditions[]

对象

PodNetworkConnectivityCheckCondition 表示 Pod 网络连接的整体状态。

failures

数组

Failures 包含不成功检查操作的日志。

failures[]

对象

LogEntry 记录事件。

outages

数组

Outages 包含中断时间段的日志。

outages[]

对象

OutageEntry 记录中断的时间段。

successes

数组

Successes 包含成功检查操作的日志。

successes[]

对象

LogEntry 记录事件。

.status.conditions

描述: Conditions 总结了检查的状态
类型: 数组

.status.conditions[]

描述

PodNetworkConnectivityCheckCondition 表示 Pod 网络连接的整体状态。

类型

对象

必需

status
type

属性类型描述

属性	类型	描述
`lastTransitionTime`	``	条件从一种状态转换到另一种状态的最后时间。
`message`	`字符串`	以人类可读格式指示上次转换详细信息的消息。
`reason`	`字符串`	以机器可读格式指示条件上次状态转换的原因。
`status`	`字符串`	条件的状态
`type`	`字符串`	条件的类型

lastTransitionTime

条件从一种状态转换到另一种状态的最后时间。

message

字符串

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

reason

字符串

以机器可读格式指示条件上次状态转换的原因。

status

字符串

条件的状态

type

字符串

条件的类型

.status.failures

描述: Failures 包含不成功检查操作的日志。
类型: 数组

.status.failures[]

描述

LogEntry 记录事件。

类型

对象

必需

success

属性类型描述

属性	类型	描述
`latency`	``	Latency 记录条目中提到的操作花费了多长时间。
`message`	`字符串`	以人类可读格式解释状态的消息。
`reason`	`字符串`	以机器可读格式指示状态的原因。
`success`	`布尔值`	Success 指示日志条目是否指示成功或失败。
`time`	``	检查操作的开始时间。

latency

Latency 记录条目中提到的操作花费了多长时间。

message

字符串

以人类可读格式解释状态的消息。

reason

字符串

以机器可读格式指示状态的原因。

success

布尔值

Success 指示日志条目是否指示成功或失败。

time

检查操作的开始时间。

.status.outages

描述: Outages 包含中断时间段的日志。
类型: 数组

.status.outages[]

描述: OutageEntry 记录中断的时间段。
类型: 对象

属性类型描述

属性	类型	描述
`结束`	``	检测到中断结束
`endLogs`	`数组`	EndLogs 包含与此次中断结束相关的日志条目。应包含解决中断的成功条目，以及可能在此之前的一些失败日志条目。
`endLogs[]`	`对象`	LogEntry 记录事件。
`message`	`字符串`	消息以人类可读的格式总结中断详细信息。
`开始`	``	检测到中断开始
`startLogs`	`数组`	StartLogs 包含与此次中断开始相关的日志条目。应包含原始故障以及故障模式发生变化的任何条目。
`startLogs[]`	`对象`	LogEntry 记录事件。

结束

检测到中断结束

endLogs

数组

EndLogs 包含与此次中断结束相关的日志条目。应包含解决中断的成功条目，以及可能在此之前的一些失败日志条目。

endLogs[]

对象

LogEntry 记录事件。

message

字符串

消息以人类可读的格式总结中断详细信息。

开始

检测到中断开始

startLogs

数组

StartLogs 包含与此次中断开始相关的日志条目。应包含原始故障以及故障模式发生变化的任何条目。

startLogs[]

对象

LogEntry 记录事件。

.status.outages[].endLogs

描述: EndLogs 包含与此次中断结束相关的日志条目。应包含解决中断的成功条目，以及可能在此之前的一些失败日志条目。
类型: 数组

.status.outages[].endLogs[]

描述

LogEntry 记录事件。

类型

对象

必需

success

属性类型描述

属性	类型	描述
`latency`	``	Latency 记录条目中提到的操作花费了多长时间。
`message`	`字符串`	以人类可读格式解释状态的消息。
`reason`	`字符串`	以机器可读格式指示状态的原因。
`success`	`布尔值`	Success 指示日志条目是否指示成功或失败。
`time`	``	检查操作的开始时间。

latency

Latency 记录条目中提到的操作花费了多长时间。

message

字符串

以人类可读格式解释状态的消息。

reason

字符串

以机器可读格式指示状态的原因。

success

布尔值

Success 指示日志条目是否指示成功或失败。

time

检查操作的开始时间。

.status.outages[].startLogs

描述: StartLogs 包含与此次中断开始相关的日志条目。应包含原始故障以及故障模式发生变化的任何条目。
类型: 数组

.status.outages[].startLogs[]

描述

LogEntry 记录事件。

类型

对象

必需

success

属性类型描述

属性	类型	描述
`latency`	``	Latency 记录条目中提到的操作花费了多长时间。
`message`	`字符串`	以人类可读格式解释状态的消息。
`reason`	`字符串`	以机器可读格式指示状态的原因。
`success`	`布尔值`	Success 指示日志条目是否指示成功或失败。
`time`	``	检查操作的开始时间。

latency

Latency 记录条目中提到的操作花费了多长时间。

message

字符串

以人类可读格式解释状态的消息。

reason

字符串

以机器可读格式指示状态的原因。

success

布尔值

Success 指示日志条目是否指示成功或失败。

time

检查操作的开始时间。

.status.successes

描述: Successes 包含成功检查操作的日志。
类型: 数组

.status.successes[]

描述

LogEntry 记录事件。

类型

对象

必需

success

属性类型描述

属性	类型	描述
`latency`	``	Latency 记录条目中提到的操作花费了多长时间。
`message`	`字符串`	以人类可读格式解释状态的消息。
`reason`	`字符串`	以机器可读格式指示状态的原因。
`success`	`布尔值`	Success 指示日志条目是否指示成功或失败。
`time`	``	检查操作的开始时间。

latency

Latency 记录条目中提到的操作花费了多长时间。

message

字符串

以人类可读格式解释状态的消息。

reason

字符串

以机器可读格式指示状态的原因。

success

布尔值

Success 指示日志条目是否指示成功或失败。

time

检查操作的开始时间。

API 端点

提供以下 API 端点

/apis/controlplane.operator.openshift.io/v1alpha1/podnetworkconnectivitychecks
- GET：列出 PodNetworkConnectivityCheck 类型的对象
/apis/controlplane.operator.openshift.io/v1alpha1/namespaces/{namespace}/podnetworkconnectivitychecks
- DELETE：删除 PodNetworkConnectivityCheck 集合
- GET：列出 PodNetworkConnectivityCheck 类型的对象
- POST：创建一个 PodNetworkConnectivityCheck
/apis/controlplane.operator.openshift.io/v1alpha1/namespaces/{namespace}/podnetworkconnectivitychecks/{name}
- DELETE：删除一个 PodNetworkConnectivityCheck
- GET：读取指定的 PodNetworkConnectivityCheck
- PATCH：部分更新指定的 PodNetworkConnectivityCheck
- PUT：替换指定的 PodNetworkConnectivityCheck
/apis/controlplane.operator.openshift.io/v1alpha1/namespaces/{namespace}/podnetworkconnectivitychecks/{name}/status
- GET：读取指定的 PodNetworkConnectivityCheck 的状态
- PATCH：部分更新指定的 PodNetworkConnectivityCheck 的状态
- PUT：替换指定的 PodNetworkConnectivityCheck 的状态

/apis/controlplane.operator.openshift.io/v1alpha1/podnetworkconnectivitychecks

HTTP 方法: GET
描述: 列出 PodNetworkConnectivityCheck 类型的对象

表 1. HTTP 响应
HTTP 代码	响应体
200 - OK	`PodNetworkConnectivityCheckList` 模式
401 - 未授权	空

/apis/controlplane.operator.openshift.io/v1alpha1/namespaces/{namespace}/podnetworkconnectivitychecks

HTTP 方法: DELETE
描述: 删除 PodNetworkConnectivityCheck 集合

表 2. HTTP 响应
HTTP 代码	响应体
200 - OK	`Status` 模式
401 - 未授权	空

HTTP 方法: GET
描述: 列出 PodNetworkConnectivityCheck 类型的对象

表 3. HTTP 响应
HTTP 代码	响应体
200 - OK	`PodNetworkConnectivityCheckList` 模式
401 - 未授权	空

HTTP 方法: POST
描述: 创建一个 PodNetworkConnectivityCheck

表 4. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何从对象中静默删除的未知字段，并将忽略解码器遇到的所有重复字段，只保留最后一个。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中删除的未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会持久化任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 5. 主体参数
参数	类型	描述
`主体`	`PodNetworkConnectivityCheck` 模式

表 6. HTTP 响应
HTTP 代码	响应体
200 - OK	`PodNetworkConnectivityCheck` 模式
201 - 已创建	`PodNetworkConnectivityCheck` 模式
202 - 已接受	`PodNetworkConnectivityCheck` 模式
401 - 未授权	空

/apis/controlplane.operator.openshift.io/v1alpha1/namespaces/{namespace}/podnetworkconnectivitychecks/{name}

表 7. 全局路径参数
参数	类型	描述
`name`	`字符串`	PodNetworkConnectivityCheck 的名称

HTTP 方法: DELETE
描述: 删除一个 PodNetworkConnectivityCheck

表 8. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

表 9. HTTP 响应
HTTP 代码	响应体
200 - OK	`Status` 模式
202 - 已接受	`Status` 模式
401 - 未授权	空

HTTP 方法: GET
描述: 读取指定的 PodNetworkConnectivityCheck

表 10. HTTP 响应
HTTP 代码	响应体
200 - OK	`PodNetworkConnectivityCheck` 模式
401 - 未授权	空

HTTP 方法: PATCH
描述: 部分更新指定的 PodNetworkConnectivityCheck

表 11. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何从对象中静默删除的未知字段，并将忽略解码器遇到的所有重复字段，只保留最后一个。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中删除的未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会持久化任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 12. HTTP 响应
HTTP 代码	响应体
200 - OK	`PodNetworkConnectivityCheck` 模式
401 - 未授权	空

HTTP 方法: PUT
描述: 替换指定的 PodNetworkConnectivityCheck

表 13. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何从对象中静默删除的未知字段，并将忽略解码器遇到的所有重复字段，只保留最后一个。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中删除的未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会持久化任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 14. 主体参数
参数	类型	描述
`主体`	`PodNetworkConnectivityCheck` 模式

表 15. HTTP 响应
HTTP 代码	响应体
200 - OK	`PodNetworkConnectivityCheck` 模式
201 - 已创建	`PodNetworkConnectivityCheck` 模式
401 - 未授权	空

/apis/controlplane.operator.openshift.io/v1alpha1/namespaces/{namespace}/podnetworkconnectivitychecks/{name}/status

表 16. 全局路径参数
参数	类型	描述
`name`	`字符串`	PodNetworkConnectivityCheck 的名称

HTTP 方法: GET
描述: 读取指定的 PodNetworkConnectivityCheck 的状态

表 17. HTTP 响应
HTTP 代码	响应体
200 - OK	`PodNetworkConnectivityCheck` 模式
401 - 未授权	空

HTTP 方法: PATCH
描述: 部分更新指定的 PodNetworkConnectivityCheck 的状态

表 18. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何从对象中静默删除的未知字段，并将忽略解码器遇到的所有重复字段，只保留最后一个。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中删除的未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会持久化任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 19. HTTP 响应
HTTP 代码	响应体
200 - OK	`PodNetworkConnectivityCheck` 模式
401 - 未授权	空

HTTP 方法: PUT
描述: 替换指定的 PodNetworkConnectivityCheck 的状态

表 20. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何从对象中静默删除的未知字段，并将忽略解码器遇到的所有重复字段，只保留最后一个。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中删除的未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会持久化任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 21. 主体参数
参数	类型	描述
`主体`	`PodNetworkConnectivityCheck` 模式

表 22. HTTP 响应
HTTP 代码	响应体
200 - OK	`PodNetworkConnectivityCheck` 模式
201 - 已创建	`PodNetworkConnectivityCheck` 模式
401 - 未授权	空