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

Lease [coordination.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

对象

LeaseSpec 是 Lease 的规范。

.spec

描述

LeaseSpec 是 Lease 的规范。

类型

对象

属性 类型 描述

acquireTime

MicroTime

acquireTime 是获取当前租约的时间。

holderIdentity

字符串

holderIdentity 包含当前租约持有者的身份。

leaseDurationSeconds

整数

leaseDurationSeconds 是租约候选者需要等待强制获取租约的持续时间。这是针对上次观察到的 renewTime 进行衡量的。

leaseTransitions

整数

leaseTransitions 是租约在持有者之间转换的次数。

renewTime

MicroTime

renewTime 是当前租约持有者上次更新租约的时间。

API 端点

提供以下 API 端点

  • /apis/coordination.k8s.io/v1/leases

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

  • /apis/coordination.k8s.io/v1/watch/leases

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

  • /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases

    • DELETE：删除 Lease 集合

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

    • POST：创建 Lease

  • /apis/coordination.k8s.io/v1/watch/namespaces/{namespace}/leases

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

  • /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name}

    • DELETE：删除 Lease

    • GET：读取指定的 Lease

    • PATCH：部分更新指定的 Lease

    • PUT：替换指定的 Lease

  • /apis/coordination.k8s.io/v1/watch/namespaces/{namespace}/leases/{name}

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

/apis/coordination.k8s.io/v1/leases

HTTP 方法

GET

描述

列出或监视 Lease 类型的对象

表 1. HTTP 响应
HTTP 代码 响应正文

200 - OK

LeaseList 模式

401 - 未授权

空

/apis/coordination.k8s.io/v1/watch/leases

HTTP 方法

GET

描述

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

表 2. HTTP 响应
HTTP 代码 响应正文

200 - OK

WatchEvent 模式

401 - 未授权

空

/apis/coordination.k8s.io/v1/namespaces/{namespace}/leases

HTTP 方法

DELETE

描述

删除 Lease 集合

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

dryRun

字符串

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

200 - OK

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

列出或监视 Lease 类型的对象

表 5. HTTP 响应
HTTP 代码 响应正文

200 - OK

LeaseList 模式

401 - 未授权

空
HTTP 方法

POST

描述

创建 Lease

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

dryRun

字符串

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

fieldValidation

字符串

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

body

Lease 模式
表 8. HTTP 响应
HTTP 代码 响应正文

200 - OK

Lease 模式

201 - 已创建

Lease 模式

202 - 已接受

Lease 模式

401 - 未授权

空

/apis/coordination.k8s.io/v1/watch/namespaces/{namespace}/leases

HTTP 方法

GET

描述

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

表 9. HTTP 响应
HTTP 代码 响应正文

200 - OK

WatchEvent 模式

401 - 未授权

空

/apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name}

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

name

字符串

Lease 的名称
HTTP 方法

DELETE

描述

删除 Lease

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

dryRun

字符串

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

200 - OK

Status 模式

202 - 已接受

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

读取指定的 Lease

表 13. HTTP 响应
HTTP 代码 响应正文

200 - OK

Lease 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定的 Lease

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

dryRun

字符串

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

fieldValidation

字符串

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

200 - OK

Lease 模式

201 - 已创建

Lease 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定的 Lease

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

dryRun

字符串

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

fieldValidation

字符串

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

body

Lease 模式
表 18. HTTP 响应
HTTP 代码 响应正文

200 - OK

Lease 模式

201 - 已创建

Lease 模式

401 - 未授权

空

/apis/coordination.k8s.io/v1/watch/namespaces/{namespace}/leases/{name}

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

name

字符串

Lease 的名称
HTTP 方法

GET

描述

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

表 20. HTTP 响应
HTTP 代码 响应正文

200 - OK

WatchEvent 模式

401 - 未授权

空