apiVersion: coordination.k8s.io/v1
import "k8s.io/api/coordination/v1"
Lease defines a lease concept.
apiVersion: coordination.k8s.io/v1
kind: Lease
metadata (ObjectMeta)
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec (LeaseSpec)
Specification of the Lease. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
LeaseSpec is a specification of a Lease.
acquireTime (MicroTime)
acquireTime is a time when the current lease was acquired.
MicroTime is version of Time with microsecond level precision.
holderIdentity (string)
holderIdentity contains the identity of the holder of a current lease.
leaseDurationSeconds (int32)
leaseDurationSeconds is a duration that candidates for a lease need to wait to force acquire it. This is measure against time of last observed RenewTime.
leaseTransitions (int32)
leaseTransitions is the number of transitions of a lease between holders.
renewTime (MicroTime)
renewTime is a time when the current holder of a lease has last updated the lease.
MicroTime is version of Time with microsecond level precision.
LeaseList is a list of Lease objects.
apiVersion: coordination.k8s.io/v1
kind: LeaseList
metadata (ListMeta)
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
items ([]Lease), required
Items is a list of schema objects.
get read the specified LeaseGET /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name}
name (in path): string, required
name of the Lease
namespace (in path): string, required
pretty (in query): string
200 (Lease): OK
401: Unauthorized
list list or watch objects of kind LeaseGET /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases
namespace (in path): string, required
allowWatchBookmarks (in query): boolean
continue (in query): string
fieldSelector (in query): string
labelSelector (in query): string
limit (in query): integer
pretty (in query): string
resourceVersion (in query): string
resourceVersionMatch (in query): string
timeoutSeconds (in query): integer
watch (in query): boolean
200 (LeaseList): OK
401: Unauthorized
list list or watch objects of kind LeaseGET /apis/coordination.k8s.io/v1/leases
allowWatchBookmarks (in query): boolean
continue (in query): string
fieldSelector (in query): string
labelSelector (in query): string
limit (in query): integer
pretty (in query): string
resourceVersion (in query): string
resourceVersionMatch (in query): string
timeoutSeconds (in query): integer
watch (in query): boolean
200 (LeaseList): OK
401: Unauthorized
create create a LeasePOST /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases
namespace (in path): string, required
body: Lease, required
dryRun (in query): string
fieldManager (in query): string
fieldValidation (in query): string
pretty (in query): string
200 (Lease): OK
201 (Lease): Created
202 (Lease): Accepted
401: Unauthorized
update replace the specified LeasePUT /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name}
name (in path): string, required
name of the Lease
namespace (in path): string, required
body: Lease, required
dryRun (in query): string
fieldManager (in query): string
fieldValidation (in query): string
pretty (in query): string
200 (Lease): OK
201 (Lease): Created
401: Unauthorized
patch partially update the specified LeasePATCH /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name}
name (in path): string, required
name of the Lease
namespace (in path): string, required
body: Patch, required
dryRun (in query): string
fieldManager (in query): string
fieldValidation (in query): string
force (in query): boolean
pretty (in query): string
200 (Lease): OK
201 (Lease): Created
401: Unauthorized
delete delete a LeaseDELETE /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name}
name (in path): string, required
name of the Lease
namespace (in path): string, required
body: DeleteOptions
dryRun (in query): string
gracePeriodSeconds (in query): integer
pretty (in query): string
propagationPolicy (in query): string
200 (Status): OK
202 (Status): Accepted
401: Unauthorized
deletecollection delete collection of LeaseDELETE /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases
namespace (in path): string, required
body: DeleteOptions
continue (in query): string
dryRun (in query): string
fieldSelector (in query): string
gracePeriodSeconds (in query): integer
labelSelector (in query): string
limit (in query): integer
pretty (in query): string
propagationPolicy (in query): string
resourceVersion (in query): string
resourceVersionMatch (in query): string
timeoutSeconds (in query): integer
200 (Status): OK
401: Unauthorized
© 2022 The Kubernetes Authors
Documentation Distributed under CC BY 4.0.
https://kubernetes.io/docs/reference/kubernetes-api/cluster-resources/lease-v1/