---
api_metadata:
apiVersion: "coordination.k8s.io/v1"
import: "k8s.io/api/coordination/v1"
kind: "Lease"
content_type: "api_reference"
description: "Lease 定义了租约的概念。"
title: "Lease"
weight: 5
---
`apiVersion: coordination.k8s.io/v1`
`import "k8s.io/api/coordination/v1"`
## Lease {#Lease}
Lease 定义了租约的概念。
- **apiVersion**: coordination.k8s.io/v1
- **kind**: Lease
- **metadata** (}}">ObjectMeta)
更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (}}">LeaseSpec)
spec 包含 Lease 的规约。更多信息：
https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
## LeaseSpec {#LeaseSpec}
LeaseSpec 是一个 Lease 的规约。
- **acquireTime** (MicroTime)
acquireTime 是当前租约被获取的时间。
**MicroTime 是微秒级精确时间的版本。**
- **holderIdentity** (string)
holderIdentity 包含当前租约持有人的身份。
- **leaseDurationSeconds** (int32)
leaseDurationSeconds 是租约候选人需要等待强制获取租约的持续时间。这是相对于上次观察到的 renewTime 的度量。
- **leaseTransitions** (int32)
leaseTransitions 是租约持有人之间的转换次数。
- **renewTime** (MicroTime)
renewTime 是当前租约持有人上次更新租约的时间。
**MicroTime 是具有微秒级精度的时间版本。**
## LeaseList {#LeaseList}
LeaseList 是 Lease 对象的列表。
- **apiVersion**: coordination.k8s.io/v1
- **kind**: LeaseList
- **metadata** (}}">ListMeta)
标准的列表元数据。更多信息：
https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **items** ([]}}">Lease), required
items 是架构对象的列表。
## 操作 {#operations}
### `get` 读取指定的 Lease
#### HTTP 请求
GET /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name}
#### 参数
- **name** (**路径参数**): string, 必需
Lease 名称。
- **namespace** (**路径参数**): string, 必需
}}">namespace
- **pretty** (**查询参数**): string
}}">pretty
#### 响应
200 (}}">Lease): OK
401: Unauthorized
### `list` 列出或监视 Lease 类对象
#### HTTP 请求
GET /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases
#### 参数
- **namespace** (**路径参数**): string, 必需
}}">namespace
- **allowWatchBookmarks** (**查询参数**): boolean
}}">allowWatchBookmarks
- **continue** (**查询参数**): string
}}">continue
- **fieldSelector** (**查询参数**): string
}}">fieldSelector
- **labelSelector** (**查询参数**): string
}}">labelSelector
- **limit** (**查询参数**): integer
}}">limit
- **pretty** (**查询参数**): string
}}">pretty
- **resourceVersion** (**查询参数**): string
}}">resourceVersion
- **resourceVersionMatch** (**查询参数**): string
}}">resourceVersionMatch
- **sendInitialEvents** (**查询参数**): boolean
}}">sendInitialEvents
- **timeoutSeconds** (**查询参数**): integer
}}">timeoutSeconds
- **watch** (**查询参数**): boolean
}}">watch
#### 响应
200 (}}">LeaseList): OK
401: Unauthorized
### `list` 列出或监视 Lease 类对象
#### HTTP 请求
GET /apis/coordination.k8s.io/v1/leases
#### 参数
- **allowWatchBookmarks** (**查询参数**): boolean
}}">allowWatchBookmarks
- **continue** (**查询参数**): string
}}">continue
- **fieldSelector** (**查询参数**): string
}}">fieldSelector
- **labelSelector** (**查询参数**): string
}}">labelSelector
- **limit** (**查询参数**): integer
}}">limit
- **pretty** (**查询参数**): string
}}">pretty
- **resourceVersion** (**查询参数**): string
}}">resourceVersion
- **resourceVersionMatch** (**查询参数**): string
}}">resourceVersionMatch
- **sendInitialEvents** (**查询参数**): boolean
}}">sendInitialEvents
- **timeoutSeconds** (**查询参数**): integer
}}">timeoutSeconds
- **watch** (**查询参数**): boolean
}}">watch
#### 响应
200 (}}">LeaseList): OK
401: Unauthorized
### `create` 创建 Lease
#### HTTP 请求
POST /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases
#### 参数
- **namespace** (**路径参数**): string, 必需
}}">namespace
- **body**: }}">Lease, 必需
- **dryRun** (**查询参数**): string
}}">dryRun
- **fieldManager** (**查询参数**): string
}}">fieldManager
- **fieldValidation** (**查询参数**): string
}}">fieldValidation
- **pretty** (**查询参数**): string
}}">pretty
#### 响应
200 (}}">Lease): OK
201 (}}">Lease): Created
202 (}}">Lease): Accepted
401: Unauthorized
### `update` 替换指定的 Lease
#### HTTP 请求
PUT /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name}
#### 参数
- **name** (**路径参数**): string, 必需
Lease 的名称。
- **namespace** (**路径参数**): string, 必需
}}">namespace
- **body**: }}">Lease, 必需
- **dryRun** (**查询参数**): string
}}">dryRun
- **fieldManager** (**查询参数**): string
}}">fieldManager
- **fieldValidation** (**查询参数**): string
}}">fieldValidation
- **pretty** (**查询参数**): string
}}">pretty
#### 响应
200 (}}">Lease): OK
201 (}}">Lease): Created
401: Unauthorized
### `patch` 部分更新指定的 Lease
#### HTTP 请求
PATCH /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name}
#### 参数
- **name** (**路径参数**): string, 必需
Lease 的名称。
- **namespace** (**路径参数**): string, 必需
}}">namespace
- **body**: }}">Patch, 必需
- **dryRun** (**查询参数**): string
}}">dryRun
- **fieldManager** (**查询参数**): string
}}">fieldManager
- **fieldValidation** (**查询参数**): string
}}">fieldValidation
- **force** (**查询参数**): boolean
}}">force
- **pretty** (**查询参数**): string
}}">pretty
#### 响应
200 (}}">Lease): OK
201 (}}">Lease): Created
401: Unauthorized
### `delete` 删除一个 Lease
#### HTTP 请求
DELETE /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name}
#### 参数
- **name** (**路径参数**): string, 必需
Lease 的名称。
- **namespace** (**路径参数**): string, 必需
}}">namespace
- **body**: }}">DeleteOptions
- **dryRun** (**查询参数**): string
}}">dryRun
- **gracePeriodSeconds** (**查询参数**): integer
}}">gracePeriodSeconds
- **pretty** (**查询参数**): string
}}">pretty
- **propagationPolicy** (**查询参数**): string
}}">propagationPolicy
#### 响应
200 (}}">Status): OK
202 (}}">Status): Accepted
401: Unauthorized
### `deletecollection` 删除 Lease 收款
#### HTTP 请求
DELETE /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases
#### 参数
- **namespace** (**路径参数**): string, 必需
}}">namespace
- **body**: }}">DeleteOptions
- **continue** (**查询参数**): string
}}">continue
- **dryRun** (**查询参数**): string
}}">dryRun
- **fieldSelector** (**查询参数**): string
}}">fieldSelector
- **gracePeriodSeconds** (**查询参数**): integer
}}">gracePeriodSeconds
- **labelSelector** (**查询参数**): string
}}">labelSelector
- **limit** (**查询参数**): integer
}}">limit
- **pretty** (**查询参数**): string
}}">pretty
- **propagationPolicy** (**查询参数**): string
}}">propagationPolicy
- **resourceVersion** (**查询参数**): string
}}">resourceVersion
- **resourceVersionMatch** (**查询参数**): string
}}">resourceVersionMatch
- **sendInitialEvents** (**查询参数**): boolean
}}">sendInitialEvents
- **timeoutSeconds** (**查询参数**): integer
}}">timeoutSeconds
#### 响应
200 (}}">Status): OK
401: Unauthorized