Search

Chapter 9. Lease [coordination.k8s.io/v1]

download PDF
Description
Lease defines a lease concept.
Type
object

9.1. Specification

PropertyTypeDescription

apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

LeaseSpec is a specification of a Lease.

9.1.1. .spec

Description
LeaseSpec is a specification of a Lease.
Type
object
PropertyTypeDescription

acquireTime

MicroTime

acquireTime is a time when the current lease was acquired.

holderIdentity

string

holderIdentity contains the identity of the holder of a current lease.

leaseDurationSeconds

integer

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

integer

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.

9.2. API endpoints

The following API endpoints are available:

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

    • GET: list or watch objects of kind Lease
  • /apis/coordination.k8s.io/v1/watch/leases

    • GET: watch individual changes to a list of Lease. deprecated: use the 'watch' parameter with a list operation instead.
  • /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases

    • DELETE: delete collection of Lease
    • GET: list or watch objects of kind Lease
    • POST: create a Lease
  • /apis/coordination.k8s.io/v1/watch/namespaces/{namespace}/leases

    • GET: watch individual changes to a list of Lease. deprecated: use the 'watch' parameter with a list operation instead.
  • /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name}

    • DELETE: delete a Lease
    • GET: read the specified Lease
    • PATCH: partially update the specified Lease
    • PUT: replace the specified Lease
  • /apis/coordination.k8s.io/v1/watch/namespaces/{namespace}/leases/{name}

    • GET: watch changes to an object of kind Lease. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

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

HTTP method
GET
Description
list or watch objects of kind Lease
Table 9.1. HTTP responses
HTTP codeReponse body

200 - OK

LeaseList schema

401 - Unauthorized

Empty

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

HTTP method
GET
Description
watch individual changes to a list of Lease. deprecated: use the 'watch' parameter with a list operation instead.
Table 9.2. HTTP responses
HTTP codeReponse body

200 - OK

WatchEvent schema

401 - Unauthorized

Empty

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

HTTP method
DELETE
Description
delete collection of Lease
Table 9.3. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Table 9.4. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
list or watch objects of kind Lease
Table 9.5. HTTP responses
HTTP codeReponse body

200 - OK

LeaseList schema

401 - Unauthorized

Empty

HTTP method
POST
Description
create a Lease
Table 9.6. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 9.7. Body parameters
ParameterTypeDescription

body

Lease schema

 
Table 9.8. HTTP responses
HTTP codeReponse body

200 - OK

Lease schema

201 - Created

Lease schema

202 - Accepted

Lease schema

401 - Unauthorized

Empty

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

HTTP method
GET
Description
watch individual changes to a list of Lease. deprecated: use the 'watch' parameter with a list operation instead.
Table 9.9. HTTP responses
HTTP codeReponse body

200 - OK

WatchEvent schema

401 - Unauthorized

Empty

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

Table 9.10. Global path parameters
ParameterTypeDescription

name

string

name of the Lease

HTTP method
DELETE
Description
delete a Lease
Table 9.11. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Table 9.12. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
read the specified Lease
Table 9.13. HTTP responses
HTTP codeReponse body

200 - OK

Lease schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update the specified Lease
Table 9.14. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 9.15. HTTP responses
HTTP codeReponse body

200 - OK

Lease schema

201 - Created

Lease schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace the specified Lease
Table 9.16. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 9.17. Body parameters
ParameterTypeDescription

body

Lease schema

 
Table 9.18. HTTP responses
HTTP codeReponse body

200 - OK

Lease schema

201 - Created

Lease schema

401 - Unauthorized

Empty

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

Table 9.19. Global path parameters
ParameterTypeDescription

name

string

name of the Lease

HTTP method
GET
Description
watch changes to an object of kind Lease. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
Table 9.20. HTTP responses
HTTP codeReponse body

200 - OK

WatchEvent schema

401 - Unauthorized

Empty

Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.