Lease

租约（Lease）定义了一个租约的概念。

apiVersion: coordination.k8s.io/v1

import "k8s.io/api/coordination/v1"

Lease

租约（Lease）定义了一个租约的概念。

LeaseSpec

LeaseSpec 是 Lease 的规范。

  • acquireTime (MicroTime)

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

    MicroTime 是具有微秒级精度的时间版本。

  • holderIdentity (string)

    holderIdentity 包含当前租约持有者的身份。如果使用协调领导者选举，则持有者身份必须等于选定的 LeaseCandidate.metadata.name 字段。

  • leaseDurationSeconds (int32)

    leaseDurationSeconds 是租约的候选者需要等待以强制获取租约的持续时间。这是根据上次观察到的 renewTime 时间来衡量的。

  • leaseTransitions (int32)

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

  • preferredHolder (string)

    PreferredHolder 向租约持有者发出信号，表明该租约有一个更优的持有者，应该放弃。只有在也设置了 Strategy 的情况下才能设置此字段。

  • renewTime (MicroTime)

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

    MicroTime 是具有微秒级精度的时间版本。

  • strategy (string)

    Strategy 指示用于协调领导者选举的领导者选择策略。如果未指定该字段，则此租约没有主动协调。（Alpha）使用此字段需要启用 CoordinatedLeaderElection 功能门。

LeaseList

LeaseList 是 Lease 对象的列表。

操作

get 读取指定的 Lease

HTTP 请求

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

参数

  • name (在路径中): string，必需

    Lease 的名称

  • namespace (在路径中): string，必需

    命名空间

  • pretty (在查询中): string

    pretty

响应

200 (Lease): OK

401: 未授权

list 列出或监视 Lease 类型的对象

HTTP 请求

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

参数

响应

200 (LeaseList): OK

401: 未授权

list 列出或监视 Lease 类型的对象

HTTP 请求

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

参数

响应

200 (LeaseList): OK

401: 未授权

create 创建一个 Lease

HTTP 请求

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

参数

响应

200 (Lease): OK

201 (Lease): 已创建

202 (Lease): 已接受

401: 未授权

update 替换指定的 Lease

HTTP 请求

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

参数

  • name (在路径中): string，必需

    Lease 的名称

  • namespace (在路径中): string，必需

    命名空间

  • body: Lease，必需

  • dryRun (在查询中): string

    dryRun

  • fieldManager (在查询中): string

    fieldManager

  • fieldValidation (在查询中): string

    fieldValidation

  • pretty (在查询中): string

    pretty

响应

200 (Lease): OK

201 (Lease): 已创建

401: 未授权

patch 部分更新指定的 Lease

HTTP 请求

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

参数

  • name (在路径中): string，必需

    Lease 的名称

  • namespace (在路径中): string，必需

    命名空间

  • body: Patch，必需

  • dryRun (在查询中): string

    dryRun

  • fieldManager (在查询中): string

    fieldManager

  • fieldValidation (在查询中): string

    fieldValidation

  • force (在查询中): boolean

    force

  • pretty (在查询中): string

    pretty

响应

200 (Lease): OK

201 (Lease): 已创建

401: 未授权

delete 删除一个 Lease

HTTP 请求

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

参数

响应

200 (Status): OK

202 (Status): 已接受

401: 未授权

deletecollection 删除 Lease 的集合

HTTP 请求

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

参数

响应

200 (Status): OK

401: 未授权

此页面是自动生成的。

如果您计划报告此页面的问题，请在您的问题描述中提及该页面是自动生成的。修复可能需要在 Kubernetes 项目的其他地方进行。

上次修改时间为 2024 年 8 月 28 日下午 6:01 PST：更新 v1.31 的生成的 API 参考 (8ba98c79c1)