EndpointSlice [discovery.k8s.io/v1]

Description

EndpointSlice represents a set of service endpoints. Most EndpointSlices are created by the EndpointSlice controller to represent the Pods selected by Service objects. For a given service there may be multiple EndpointSlice objects which must be joined to produce the full set of endpoints; you can find all of the slices for a given service by listing EndpointSlices in the service’s namespace whose kubernetes.io/service-name label contains the service’s name.

Type

`object`

Required

• addressType
• endpoints

Specification

Property	Type	Description
addressType	string	addressType specifies the type of address carried by this EndpointSlice. All addresses in this slice must be the same type. This field is immutable after creation. The following address types are currently supported: * IPv4: Represents an IPv4 Address. * IPv6: Represents an IPv6 Address. * FQDN: Represents a Fully Qualified Domain Name. (Deprecated) The EndpointSlice controller only generates, and kube-proxy only processes, slices of addressType "IPv4" and "IPv6". No semantics are defined for the "FQDN" type. Possible enum values: - "FQDN" represents a FQDN. - "IPv4" represents an IPv4 Address. - "IPv6" represents an IPv6 Address.
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
endpoints	array	endpoints is a list of unique endpoints in this slice. Each slice may include a maximum of 1000 endpoints.
endpoints[]	object	Endpoint represents a single logical "backend" implementing a service.
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	Standard object’s metadata.
ports	array	ports specifies the list of network ports exposed by each endpoint in this slice. Each port must have a unique name. Each slice may include a maximum of 100 ports. Services always have at least 1 port, so EndpointSlices generated by the EndpointSlice controller will likewise always have at least 1 port. EndpointSlices used for other purposes may have an empty ports list.
ports[]	object	EndpointPort represents a Port used by an EndpointSlice

.endpoints

Description

endpoints is a list of unique endpoints in this slice. Each slice may include a maximum of 1000 endpoints.

Type

`array`

.endpoints[]

Description

Endpoint represents a single logical "backend" implementing a service.

Type

`object`

Required

• addresses

Property	Type	Description
addresses	array (string)	addresses of this endpoint. For EndpointSlices of addressType "IPv4" or "IPv6", the values are IP addresses in canonical form. The syntax and semantics of other addressType values are not defined. This must contain at least one address but no more than 100. EndpointSlices generated by the EndpointSlice controller will always have exactly 1 address. No semantics are defined for additional addresses beyond the first, and kube-proxy does not look at them.
conditions	object	EndpointConditions represents the current condition of an endpoint.
deprecatedTopology	object (string)	deprecatedTopology contains topology information part of the v1beta1 API. This field is deprecated, and will be removed when the v1beta1 API is removed (no sooner than kubernetes v1.24). While this field can hold values, it is not writable through the v1 API, and any attempts to write to it will be silently ignored. Topology information can be found in the zone and nodeName fields instead.
hints	object	EndpointHints provides hints describing how an endpoint should be consumed.
hostname	string	hostname of this endpoint. This field may be used by consumers of endpoints to distinguish endpoints from each other (e.g. in DNS names). Multiple endpoints which use the same hostname should be considered fungible (e.g. multiple A values in DNS). Must be lowercase and pass DNS Label (RFC 1123) validation.
nodeName	string	nodeName represents the name of the Node hosting this endpoint. This can be used to determine endpoints local to a Node.
targetRef	ObjectReference	targetRef is a reference to a Kubernetes object that represents this endpoint.
zone	string	zone is the name of the Zone this endpoint exists in.

.endpoints[].conditions

Description

EndpointConditions represents the current condition of an endpoint.

Type

`object`

Property	Type	Description
ready	boolean	ready indicates that this endpoint is ready to receive traffic, according to whatever system is managing the endpoint. A nil value should be interpreted as "true". In general, an endpoint should be marked ready if it is serving and not terminating, though this can be overridden in some cases, such as when the associated Service has set the publishNotReadyAddresses flag.
serving	boolean	serving indicates that this endpoint is able to receive traffic, according to whatever system is managing the endpoint. For endpoints backed by pods, the EndpointSlice controller will mark the endpoint as serving if the pod’s Ready condition is True. A nil value should be interpreted as "true".
terminating	boolean	terminating indicates that this endpoint is terminating. A nil value should be interpreted as "false".

.endpoints[].hints

Description

EndpointHints provides hints describing how an endpoint should be consumed.

Type

`object`

Property	Type	Description
forNodes	array	forNodes indicates the node(s) this endpoint should be consumed by when using topology aware routing. May contain a maximum of 8 entries.
forNodes[]	object	ForNode provides information about which nodes should consume this endpoint.
forZones	array	forZones indicates the zone(s) this endpoint should be consumed by when using topology aware routing. May contain a maximum of 8 entries.
forZones[]	object	ForZone provides information about which zones should consume this endpoint.

.endpoints[].hints.forNodes

Description

forNodes indicates the node(s) this endpoint should be consumed by when using topology aware routing. May contain a maximum of 8 entries.

Type

`array`

.endpoints[].hints.forNodes[]

Description

ForNode provides information about which nodes should consume this endpoint.

Type

`object`

Required

• name

Property	Type	Description
name	string	name represents the name of the node.

.endpoints[].hints.forZones

Description

forZones indicates the zone(s) this endpoint should be consumed by when using topology aware routing. May contain a maximum of 8 entries.

Type

`array`

.endpoints[].hints.forZones[]

Description

ForZone provides information about which zones should consume this endpoint.

Type

`object`

Required

• name

Property	Type	Description
name	string	name represents the name of the zone.

.ports

Description

ports specifies the list of network ports exposed by each endpoint in this slice. Each port must have a unique name. Each slice may include a maximum of 100 ports. Services always have at least 1 port, so EndpointSlices generated by the EndpointSlice controller will likewise always have at least 1 port. EndpointSlices used for other purposes may have an empty ports list.

Type

`array`

.ports[]

Description

EndpointPort represents a Port used by an EndpointSlice

Type

`object`

Property	Type	Description
appProtocol	string	The application protocol for this port. This is used as a hint for implementations to offer richer behavior for protocols that they understand. This field follows standard Kubernetes label syntax. Valid values are either: * Un-prefixed protocol names - reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names). * Kubernetes-defined prefixed names: * 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior- * 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455 * 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455 * Other protocols should use implementation-defined prefixed names such as mycompany.com/my-custom-protocol.
name	string	name represents the name of this port. All ports in an EndpointSlice must have a unique name. If the EndpointSlice is derived from a Kubernetes service, this corresponds to the Service.ports[].name. Name must either be an empty string or pass DNS_LABEL validation: * must be no more than 63 characters long. * must consist of lower case alphanumeric characters or '-'. * must start and end with an alphanumeric character. Default is empty string.
port	integer	port represents the port number of the endpoint. If the EndpointSlice is derived from a Kubernetes service, this must be set to the service’s target port. EndpointSlices used for other purposes may have a nil port.
protocol	string	protocol represents the IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP. Possible enum values: - "SCTP" is the SCTP protocol. - "TCP" is the TCP protocol. - "UDP" is the UDP protocol.

API endpoints

The following API endpoints are available:

• /apis/discovery.k8s.io/v1/endpointslices
  • GET: list or watch objects of kind EndpointSlice
• /apis/discovery.k8s.io/v1/watch/endpointslices
  • GET: watch individual changes to a list of EndpointSlice. deprecated: use the 'watch' parameter with a list operation instead.
• /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices
  • DELETE: delete collection of EndpointSlice
  • GET: list or watch objects of kind EndpointSlice
  • POST: create an EndpointSlice
• /apis/discovery.k8s.io/v1/watch/namespaces/{namespace}/endpointslices
  • GET: watch individual changes to a list of EndpointSlice. deprecated: use the 'watch' parameter with a list operation instead.
• /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name}
  • DELETE: delete an EndpointSlice
  • GET: read the specified EndpointSlice
  • PATCH: partially update the specified EndpointSlice
  • PUT: replace the specified EndpointSlice
• /apis/discovery.k8s.io/v1/watch/namespaces/{namespace}/endpointslices/{name}
  • GET: watch changes to an object of kind EndpointSlice. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

/apis/discovery.k8s.io/v1/endpointslices

HTTP method

`GET`

Description

list or watch objects of kind EndpointSlice

HTTP responses

HTTP code	Reponse body
200 - OK	EndpointSliceList schema
401 - Unauthorized	Empty

/apis/discovery.k8s.io/v1/watch/endpointslices

HTTP method

`GET`

Description

watch individual changes to a list of EndpointSlice. deprecated: use the 'watch' parameter with a list operation instead.

HTTP responses

HTTP code	Reponse body
200 - OK	WatchEvent schema
401 - Unauthorized	Empty

/apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices

HTTP method

`DELETE`

Description

delete collection of EndpointSlice

Query parameters

Parameter	Type	Description
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

HTTP responses

HTTP code	Reponse body
200 - OK	Status schema
401 - Unauthorized	Empty

HTTP method

`GET`

Description

list or watch objects of kind EndpointSlice

HTTP responses

HTTP code	Reponse body
200 - OK	EndpointSliceList schema
401 - Unauthorized	Empty

HTTP method

`POST`

Description

create an EndpointSlice

Query parameters

Parameter	Type	Description
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.

Body parameters

Parameter	Type	Description
body	EndpointSlice schema

HTTP responses

HTTP code	Reponse body
200 - OK	EndpointSlice schema
201 - Created	EndpointSlice schema
202 - Accepted	EndpointSlice schema
401 - Unauthorized	Empty

/apis/discovery.k8s.io/v1/watch/namespaces/{namespace}/endpointslices

HTTP method

`GET`

Description

watch individual changes to a list of EndpointSlice. deprecated: use the 'watch' parameter with a list operation instead.

HTTP responses

HTTP code	Reponse body
200 - OK	WatchEvent schema
401 - Unauthorized	Empty

/apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name}

Global path parameters

Parameter	Type	Description
name	string	name of the EndpointSlice

HTTP method

`DELETE`

Description

delete an EndpointSlice

Query parameters

Parameter	Type	Description
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

HTTP responses

HTTP code	Reponse body
200 - OK	Status schema
202 - Accepted	Status schema
401 - Unauthorized	Empty

HTTP method

`GET`

Description

read the specified EndpointSlice

HTTP responses

HTTP code	Reponse body
200 - OK	EndpointSlice schema
401 - Unauthorized	Empty

HTTP method

`PATCH`

Description

partially update the specified EndpointSlice

Query parameters

Parameter	Type	Description
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.

HTTP responses

HTTP code	Reponse body
200 - OK	EndpointSlice schema
201 - Created	EndpointSlice schema
401 - Unauthorized	Empty

HTTP method

`PUT`

Description

replace the specified EndpointSlice

Query parameters

Parameter	Type	Description
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.

Body parameters

Parameter	Type	Description
body	EndpointSlice schema

HTTP responses

HTTP code	Reponse body
200 - OK	EndpointSlice schema
201 - Created	EndpointSlice schema
401 - Unauthorized	Empty

/apis/discovery.k8s.io/v1/watch/namespaces/{namespace}/endpointslices/{name}

Global path parameters

Parameter	Type	Description
name	string	name of the EndpointSlice

HTTP method

`GET`

Description

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

HTTP responses

HTTP code	Reponse body
200 - OK	WatchEvent schema
401 - Unauthorized	Empty