12.8. Machine [machine.openshift.io/v1beta1]


描述
机器是机器 API 的 Schema
类型
对象

12.8.1. 规格

Expand
属性类型描述

apiVersion

字符串

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

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta_v2

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

spec

对象

MachineSpec 定义所需的 Machine 状态

status

对象

MachineStatus 定义到的机器的状态

12.8.1.1. .spec

描述
MachineSpec 定义所需的 Machine 状态
类型
对象
Expand
属性类型描述

metadata

对象

ObjectMeta 将自动填充创建的节点。使用它来指明在创建节点时应使用哪些标签、注解、名称前缀等。

providerID

字符串

providerID 是供应商提供的机器的标识 ID。此字段必须与与这个机器对应的节点对象中看到的供应商 ID 匹配。cluster-api 的更高级别消费者需要此字段。用例示例是集群自动扩展,并将 cluster-api 作为 provider。自动缩放器中的清理逻辑将机器与节点进行比较,以查找供应商上无法注册为 Kubernetes 节点的机器。使用 cluster-api 作为自动扩展的通用树外供应商,自动扩展需要此字段才能使用机器列表的供应商视图。从 k8s apiserver 查询另一个节点列表,然后进行一个比较来查找未注册的机器并标记为删除。此字段将由操作者设置,并由像自动扩展等更高级别的实体使用,这些实体将与 cluster-api 作为通用提供程序进行交流。

providerSpec

对象

ProviderSpec 详情要在节点创建过程中使用的供应商特定配置。

污点(taint)

array

要以附加方式应用到相应节点的污点列表。此列表不会覆盖会持续由其他实体添加到节点的任何其他污点。这些污点应主动协调,例如,如果您要求机器控制器应用污点,然后手动删除机器控制器将返回污点,但没有删除机器控制器移除任何污点

taints[]

对象

此污点的节点附加到不容许 Taint 的 pod 上具有 "effect" 的节点。

12.8.1.2. .spec.metadata

描述
ObjectMeta 将自动填充创建的节点。使用它来指明在创建节点时应使用哪些标签、注解、名称前缀等。
类型
对象
Expand
属性类型描述

annotations

对象(字符串)

注解是一个无结构的键值映射,与资源存储,可通过外部工具设置来存储和检索任意元数据。它们不可查询,应在修改对象时保留。更多信息: http://kubernetes.io/docs/user-guide/annotations

generateName

字符串

generateName 是一个可选前缀,服务器使用,用于生成唯一名称,只提供 Name 字段。如果使用此字段,则返回到客户端的名称将与传递的名称不同。这个值也会与唯一的后缀结合使用。提供的值与 Name 字段具有相同的验证规则,并可能根据在服务器中使值的唯一后缀的长度截断。如果指定了此字段,且存在生成的名称,服务器将不会返回 409 - 相反,它将返回 201 Created 或 500,表示一个唯一名称无法在分配的时间内找到,客户端应重试(可选)仅在没有指定 Name 时才应用。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

labels

对象(字符串)

可用于组织和分类(范围和选择)对象的字符串键和值映射。可能与复制控制器和服务选择器匹配。更多信息: http://kubernetes.io/docs/user-guide/labels

name

字符串

名称在命名空间中必须是唯一的。在创建资源时是必需的,但有些资源可能允许客户端自动请求生成适当名称。名称主要用于创建 idempotence 和配置定义。无法更新。更多信息: http://kubernetes.io/docs/user-guide/identifiers#names

namespace

字符串

命名空间定义每个名称中的空间必须是唯一的。空命名空间等同于 "default" 命名空间,但 "default" 是规范表示。不是所有对象都需要限定到命名空间 - 这些对象的此字段值为空。必须是 DNS_LABEL。无法更新。更多信息: http://kubernetes.io/docs/user-guide/namespaces

ownerReferences

array

由此对象依赖的对象列表。如果列表中删除列表中的 ALL 对象,则会收集此对象。如果此对象由控制器管理,则此列表中的条目将指向此控制器,并将 controller 字段设置为 true。不能有多个管理控制器。

ownerReferences[]

对象

OwnerReference 包含足够信息,供您识别自己的对象。拥有的对象必须与依赖项处于相同命名空间中,或是集群范围的,因此没有命名空间字段。

12.8.1.3. .spec.metadata.ownerReferences

描述
由此对象依赖的对象列表。如果列表中删除列表中的 ALL 对象,则会收集此对象。如果此对象由控制器管理,则此列表中的条目将指向此控制器,并将 controller 字段设置为 true。不能有多个管理控制器。
类型
array

12.8.1.4. .spec.metadata.ownerReferences[]

描述
OwnerReference 包含足够信息,供您识别自己的对象。拥有的对象必须与依赖项处于相同命名空间中,或是集群范围的,因此没有命名空间字段。
类型
对象
必填
  • apiVersion
  • kind
  • name
  • uid
Expand
属性类型描述

apiVersion

字符串

引用的 API 版本。

blockOwnerDeletion

布尔值

如果为 true,如果所有者有"foregroundDeletion"终结器,则无法从键值存储中删除所有者,直到删除了此引用。默认为false。要设置此字段,用户需要"删除"所有者的权限,否则将返回 422 (不可处理实体)。

controller

布尔值

如果为 true,则此引用指向管理控制器。

kind

字符串

引用的类型。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

name

字符串

引用的名称。更多信息: http://kubernetes.io/docs/user-guide/identifiers#names

uid

字符串

引用的 UID。更多信息: http://kubernetes.io/docs/user-guide/identifiers#uids

12.8.1.5. .spec.providerSpec

描述
ProviderSpec 详情要在节点创建过程中使用的供应商特定配置。
类型
对象
Expand
属性类型描述

value

``

value 是资源配置的内联序列化表示。建议供应商维护自己的版本化的 API 类型,这些类型应该从此字段序列化/反序列化,以转至组件配置。

12.8.1.6. .spec.taints

描述
要以附加方式应用到相应节点的污点列表。此列表不会覆盖会持续由其他实体添加到节点的任何其他污点。这些污点应主动协调,例如,如果您要求机器控制器应用污点,然后手动删除机器控制器将返回污点,但没有删除机器控制器移除任何污点
类型
array

12.8.1.7. .spec.taints[]

描述
此污点的节点附加到不容许 Taint 的 pod 上具有 "effect" 的节点。
类型
对象
必填
  • effect
  • key
Expand
属性类型描述

effect

字符串

必需。污点对不容许污点的 pod 的影响。有效效果为 NoSchedule、PreferNoSchedule 和 NoExecute。

key

字符串

必需。要应用到节点的污点键。

timeAdded

字符串

TimeAdded 代表添加污点的时间。它只适用于 NoExecute 污点。

value

字符串

与污点键对应的污点值。

12.8.1.8. .status

描述
MachineStatus 定义到的机器的状态
类型
对象
Expand
属性类型描述

addresses

array

address 是分配给机器的地址列表。从云供应商查询(如果可用)。

addresses[]

对象

NodeAddress 包含节点地址的信息。

conditions

array

条件定义机器的当前状态

conditions[]

对象

condition 定义 Machine API 资源操作状态的观察。

errorMessage

字符串

如果终端问题协调机器,并且包含适合日志记录和人消耗的更详细字符串,则会设置 errorMessage。不应该为传输错误设置此字段,控制器在一段时间内自动修复(如服务中断),而是表示机器规格或控制器配置的基本错误,需要手动干预。终端错误示例将与 spec 中的设置无效组合、控制器不支持的值,或者负责控制器本身被严重错误配置。任何在 Machine 协调过程中发生的临时错误都可以作为事件添加到 Machine 对象,或登录到控制器的输出。

errorReason

字符串

如果存在终端问题协调机器,并且包含适合机器解释的意外值,则会设置 ErrorReason。不应该为传输错误设置此字段,控制器在一段时间内自动修复(如服务中断),而是表示机器规格或控制器配置的基本错误,需要手动干预。终端错误示例将与 spec 中的设置无效组合、控制器不支持的值,或者负责控制器本身被严重错误配置。任何在 Machine 协调过程中发生的临时错误都可以作为事件添加到 Machine 对象,或登录到控制器的输出。

lastOperation

对象

lastOperation 描述了 machine-controller 执行的最后合作。此 API 应在特定计算机上执行的最新操作时作为历史记录使用。它还应传达 latest-operation 的状态,例如,如果仍然正在进行、失败或成功完成。

lastUpdated

字符串

lastUpdated 标识最后一次观察此状态的时间。

nodeRef

对象

nodeRef 将指向对应的节点(如果存在)。

phase

字符串

phase 代表机器的当前阶段。其中一个:Failed, Provisioning, Provisioned, Running, Deleting

providerStatus

``

providerStatus 详细介绍了特定于提供程序的状态。建议供应商维护自己的版本化的 API 类型,这些类型应该从此字段序列化/反序列化。

12.8.1.9. .status.addresses

描述
address 是分配给机器的地址列表。从云供应商查询(如果可用)。
类型
array

12.8.1.10. .status.addresses[]

描述
NodeAddress 包含节点地址的信息。
类型
对象
必填
  • address
  • type
Expand
属性类型描述

address

字符串

节点地址。

type

字符串

节点数类型、主机名、ExternalIP 或 InternalIP 之一。

12.8.1.11. .status.conditions

描述
条件定义机器的当前状态
类型
array

12.8.1.12. .status.conditions[]

描述
condition 定义 Machine API 资源操作状态的观察。
类型
对象
必填
  • status
  • type
Expand
属性类型描述

lastTransitionTime

字符串

条件从一个状态转换到另一个状态的时间。这应该是底层条件变化的时间。如果为未知,则使用 API 字段更改的时间是可以接受的。

message

字符串

人类可读的消息,指示有关转换的详细信息。此字段可能为空。

reason

字符串

在 CamelCase 中,条件最后一次转换的原因。特定的 API 可能会选择此字段是否被视为有保证的 API。此字段可能不是空的。

严重性

字符串

严重性提供了明确的 Reason 代码类别,因此用户或机器可以立即理解当前的情况并相应地操作。只有 Status=False 时才会设置严重性字段。

status

字符串

条件的状态,True, False, Unknown 之一。

type

字符串

CamelCase 或 foo.example.com/CamelCase 中的条件类型。许多 .condition.type 值在可用资源之间一致,但因为任意条件可能很有用(请参阅 .node.status.conditions),取消限制的能力非常重要。

12.8.1.13. .status.lastOperation

描述
lastOperation 描述了 machine-controller 执行的最后合作。此 API 应在特定计算机上执行的最新操作时作为历史记录使用。它还应传达 latest-operation 的状态,例如,如果仍然正在进行、失败或成功完成。
类型
对象
Expand
属性类型描述

description

字符串

description 是最后一次操作的人类可读描述。

lastUpdated

字符串

lastUpdated 是 LastOperation API 最后一次更新的时间戳。

state

字符串

state 是最后一次执行操作的当前状态。例如处理、失败、成功等

type

字符串

type 是最后一次执行的操作类型。例如创建、删除、更新等

12.8.1.14. .status.nodeRef

描述
nodeRef 将指向对应的节点(如果存在)。
类型
对象
Expand
属性类型描述

apiVersion

字符串

引用的 API 版本。

fieldPath

字符串

如果引用的是对象的一部分而非整个对象,则该字符串应包含有效的 JSON/Go 字段访问声明,如 desiredState.manifest.containers[2]。例如,如果对象引用是一个 pod 中的容器,它应该还以下类似: "spec.containers{name}"(其中 "name" 是指触发事件的容器的名称),如果不使用容器名称,则应类似于 "spec.containers[2]"(使用此 pod 中索引值为 2 的容器)。选择这个语法的原因是,为了有一些指向对象部分的正确定义方法。Todo: 这个设计不是最终设计的,且该字段在将来会有所改变。

kind

字符串

引用的类型。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

namespace

字符串

引用的命名空间。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceVersion

字符串

指定构成这个引用的 resourceVersion(如果存在)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

uid

字符串

引用的 UID。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

12.8.2. API 端点

可用的 API 端点如下:

  • /apis/machine.openshift.io/v1beta1/machines

    • GET: 列出 Machine 类型的对象
  • /apis/machine.openshift.io/v1beta1/namespaces/{namespace}/machines

    • DELETE :删除机器的集合
    • GET: 列出 Machine 类型的对象
    • POST :创建机器
  • /apis/machine.openshift.io/v1beta1/namespaces/{namespace}/machines/{name}

    • DELETE :删除机器
    • GET :读取指定的机器
    • PATCH :部分更新指定的机器
    • PUT :替换指定的机器
  • /apis/machine.openshift.io/v1beta1/namespaces/{namespace}/machines/{name}/status

    • GET: 指定机器的读取状态
    • PATCH :部分更新指定机器的状态
    • PUT: 替换指定机器的状态

12.8.2.1. /apis/machine.openshift.io/v1beta1/machines

Expand
表 12.180. 全局查询参数
参数类型描述

allowWatchBookmarks

布尔值

allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。

继续

字符串

从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,它必须在没有 continue 字段的情况下重启其列表。否则,客户端可能会发送另一个列表请求,并带有 410 错误收到的令牌,服务器将通过从下一个密钥开始的列表进行响应,但从最新的快照(从最后一个列表结果中不一致) - 在第一个列表请求后创建、修改或删除的对象将包含在响应中,只要其密钥在"next key"后。

当 watch 为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值启动监视,而不丢失任何修改。

fieldSelector

字符串

用于限制返回的对象列表的选择器。默认为任何内容。

labelSelector

字符串

通过标签限制返回的对象列表的选择器。默认为任何内容。

limit

整数

限制是列表调用要返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的"continue"字段设置为可用于同一初始查询的值,以检索下一个结果集。在过滤所有请求的对象时,设置限制可能会返回比请求的项目数量少(最多为零项),客户端应只使用 continue 字段的存在来确定是否有更多结果可用。服务器可以选择不支持限制参数,并将返回所有可用的结果。如果指定了限制,并且 continue 字段为空,客户端可能会假设没有更多可用的结果。如果 watch 为 true,则不支持此字段。

服务器保证在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用相同 - 也就是说,在发出第一个请求后不会创建、修改或删除对象。这有时被称为一致的快照,并确保使用限制的客户端接收一个非常大的结果较小的块可以确保它们看到所有可能的对象。如果在块列出期间更新对象,则返回第一次列表结果时存在的对象版本。

pretty

字符串

如果 'true',则输出被用户友善。

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

resourceVersionMatch

字符串

resourceVersionMatch 决定 resourceVersion 如何应用到列出调用。强烈建议您为设置了 resourceVersion 的列表调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

timeoutSeconds

整数

list/watch 调用的超时。这限制了调用的时间,无论任何活动或不活跃。

watch

布尔值

观察对描述的资源的更改,并将其作为添加、更新和删除通知流返回。指定 resourceVersion。

HTTP 方法
GET
描述
列出机器类型的对象
Expand
表 12.181. HTTP 响应
HTTP 代码响应正文

200 - OK

MachineList 模式

401 - Unauthorized

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

namespace

字符串

对象名称和身份验证范围,如团队和项目

Expand
表 12.183. 全局查询参数
参数类型描述

pretty

字符串

如果 'true',则输出被用户友善。

HTTP 方法
DELETE
描述
删除机器集合
Expand
表 12.184. 查询参数
参数类型描述

allowWatchBookmarks

布尔值

allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。

继续

字符串

从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,它必须在没有 continue 字段的情况下重启其列表。否则,客户端可能会发送另一个列表请求,并带有 410 错误收到的令牌,服务器将通过从下一个密钥开始的列表进行响应,但从最新的快照(从最后一个列表结果中不一致) - 在第一个列表请求后创建、修改或删除的对象将包含在响应中,只要其密钥在"next key"后。

当 watch 为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值启动监视,而不丢失任何修改。

fieldSelector

字符串

用于限制返回的对象列表的选择器。默认为任何内容。

labelSelector

字符串

通过标签限制返回的对象列表的选择器。默认为任何内容。

limit

整数

限制是列表调用要返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的"continue"字段设置为可用于同一初始查询的值,以检索下一个结果集。在过滤所有请求的对象时,设置限制可能会返回比请求的项目数量少(最多为零项),客户端应只使用 continue 字段的存在来确定是否有更多结果可用。服务器可以选择不支持限制参数,并将返回所有可用的结果。如果指定了限制,并且 continue 字段为空,客户端可能会假设没有更多可用的结果。如果 watch 为 true,则不支持此字段。

服务器保证在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用相同 - 也就是说,在发出第一个请求后不会创建、修改或删除对象。这有时被称为一致的快照,并确保使用限制的客户端接收一个非常大的结果较小的块可以确保它们看到所有可能的对象。如果在块列出期间更新对象,则返回第一次列表结果时存在的对象版本。

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

resourceVersionMatch

字符串

resourceVersionMatch 决定 resourceVersion 如何应用到列出调用。强烈建议您为设置了 resourceVersion 的列表调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

timeoutSeconds

整数

list/watch 调用的超时。这限制了调用的时间,无论任何活动或不活跃。

watch

布尔值

观察对描述的资源的更改,并将其作为添加、更新和删除通知流返回。指定 resourceVersion。

Expand
表 12.185. HTTP 响应
HTTP 代码响应正文

200 - OK

Status_v2 模式

401 - Unauthorized

HTTP 方法
GET
描述
列出机器类型的对象
Expand
表 12.186. 查询参数
参数类型描述

allowWatchBookmarks

布尔值

allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。

继续

字符串

从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,它必须在没有 continue 字段的情况下重启其列表。否则,客户端可能会发送另一个列表请求,并带有 410 错误收到的令牌,服务器将通过从下一个密钥开始的列表进行响应,但从最新的快照(从最后一个列表结果中不一致) - 在第一个列表请求后创建、修改或删除的对象将包含在响应中,只要其密钥在"next key"后。

当 watch 为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值启动监视,而不丢失任何修改。

fieldSelector

字符串

用于限制返回的对象列表的选择器。默认为任何内容。

labelSelector

字符串

通过标签限制返回的对象列表的选择器。默认为任何内容。

limit

整数

限制是列表调用要返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的"continue"字段设置为可用于同一初始查询的值,以检索下一个结果集。在过滤所有请求的对象时,设置限制可能会返回比请求的项目数量少(最多为零项),客户端应只使用 continue 字段的存在来确定是否有更多结果可用。服务器可以选择不支持限制参数,并将返回所有可用的结果。如果指定了限制,并且 continue 字段为空,客户端可能会假设没有更多可用的结果。如果 watch 为 true,则不支持此字段。

服务器保证在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用相同 - 也就是说,在发出第一个请求后不会创建、修改或删除对象。这有时被称为一致的快照,并确保使用限制的客户端接收一个非常大的结果较小的块可以确保它们看到所有可能的对象。如果在块列出期间更新对象,则返回第一次列表结果时存在的对象版本。

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

resourceVersionMatch

字符串

resourceVersionMatch 决定 resourceVersion 如何应用到列出调用。强烈建议您为设置了 resourceVersion 的列表调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

timeoutSeconds

整数

list/watch 调用的超时。这限制了调用的时间,无论任何活动或不活跃。

watch

布尔值

观察对描述的资源的更改,并将其作为添加、更新和删除通知流返回。指定 resourceVersion。

Expand
表 12.187. HTTP 响应
HTTP 代码响应正文

200 - OK

MachineList 模式

401 - Unauthorized

HTTP 方法
POST
描述
创建机器
Expand
表 12.188. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

Expand
表 12.189. 主体参数
参数类型描述

正文(body)

Machine 模式

 
Expand
表 12.190. HTTP 响应
HTTP 代码响应正文

200 - OK

Machine 模式

201 - Created

Machine 模式

202 - Accepted

Machine 模式

401 - Unauthorized

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

name

字符串

机器的名称

namespace

字符串

对象名称和身份验证范围,如团队和项目

Expand
表 12.192. 全局查询参数
参数类型描述

pretty

字符串

如果 'true',则输出被用户友善。

HTTP 方法
DELETE
描述
删除机器
Expand
表 12.193. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

gracePeriodSeconds

整数

应该删除对象前的持续时间(以秒为单位)。值必须是非负整数。值零表示立即删除。如果这个值是 nil,则使用指定类型的默认宽限期。如果没有指定,则默认为每个对象值。零表示立即删除。

orphanDependents

布尔值

弃用:请使用 PropagationPolicy,此字段将在 1.7 中被弃用。应该依赖的对象被孤立。如果为 true/false,"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy,但不能同时设置两者。

propagationPolicy

字符串

是否以及是否执行垃圾回收。此字段或 OrphanDependents 可以设置,但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值为: 'Orphan' - 孤立依赖; 'Background' - 允许垃圾收集器在后台删除依赖的依赖关系; 'Foreground' - 一个删除前台所有依赖的级联策略。

Expand
表 12.194. 主体参数
参数类型描述

正文(body)

DeleteOptions_v2 schema

 
Expand
表 12.195. HTTP 响应
HTTP 代码响应正文

200 - OK

Status_v2 模式

202 - Accepted

Status_v2 模式

401 - Unauthorized

HTTP 方法
GET
描述
读取指定的机器
Expand
表 12.196. 查询参数
参数类型描述

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

Expand
表 12.197. HTTP 响应
HTTP 代码响应正文

200 - OK

Machine 模式

401 - Unauthorized

HTTP 方法
PATCH
描述
部分更新指定的机器
Expand
表 12.198. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

Expand
表 12.199. 主体参数
参数类型描述

正文(body)

Patch 模式

 
Expand
表 12.200. HTTP 响应
HTTP 代码响应正文

200 - OK

Machine 模式

401 - Unauthorized

HTTP 方法
PUT
描述
替换指定的机器
Expand
表 12.201. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

Expand
表 12.202. 主体参数
参数类型描述

正文(body)

Machine 模式

 
Expand
表 12.203. HTTP 响应
HTTP 代码响应正文

200 - OK

Machine 模式

201 - Created

Machine 模式

401 - Unauthorized

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

name

字符串

机器的名称

namespace

字符串

对象名称和身份验证范围,如团队和项目

Expand
表 12.205. 全局查询参数
参数类型描述

pretty

字符串

如果 'true',则输出被用户友善。

HTTP 方法
GET
描述
指定机器的读取状态
Expand
表 12.206. 查询参数
参数类型描述

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

Expand
表 12.207. HTTP 响应
HTTP 代码响应正文

200 - OK

Machine 模式

401 - Unauthorized

HTTP 方法
PATCH
描述
指定机器的部分更新状态
Expand
表 12.208. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

Expand
表 12.209. 主体参数
参数类型描述

正文(body)

Patch 模式

 
Expand
表 12.210. HTTP 响应
HTTP 代码响应正文

200 - OK

Machine 模式

401 - Unauthorized

HTTP 方法
PUT
描述
替换指定机器的状态
Expand
表 12.211. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

Expand
表 12.212. 主体参数
参数类型描述

正文(body)

Machine 模式

 
Expand
表 12.213. HTTP 响应
HTTP 代码响应正文

200 - OK

Machine 模式

201 - Created

Machine 模式

401 - Unauthorized

返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

Theme

© 2026 Red Hat