Endpoints [v1]¶

Description

Endpoints is a collection of endpoints that implement the actual service. Example:

   Name: "mysvc",
   Subsets: [
     {
       Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}],
       Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}]
     },
     {
       Addresses: [{"ip": "10.10.3.3"}],
       Ports: [{"name": "a", "port": 93}, {"name": "b", "port": 76}]
     },
  ]

Endpoints is a legacy API and does not contain information about all Service features. Use discoveryv1.EndpointSlice for complete information about Service endpoints.

Deprecated: This API is deprecated in v1.33+. Use discoveryv1.EndpointSlice.

Type

`object`

Specification¶

.subsets¶

Description

The set of all endpoints is the union of all subsets. Addresses are placed into subsets according to the IPs they share. A single address with multiple ports, some of which are ready and some of which are not (because they come from different containers) will result in the address being displayed in different subsets for the different ports. No address will appear in both Addresses and NotReadyAddresses in the same subset. Sets of addresses and ports that comprise a service.

Type

`array`

.subsets[]¶

Description

EndpointSubset is a group of addresses with a common set of ports. The expanded set of endpoints is the Cartesian product of Addresses x Ports. For example, given:

  {
    Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}],
    Ports:     [{"name": "a", "port": 8675}, {"name": "b", "port": 309}]
  }

The resulting set of endpoints can be viewed as:

  a: [ 10.10.1.1:8675, 10.10.2.2:8675 ],
  b: [ 10.10.1.1:309, 10.10.2.2:309 ]

Deprecated: This API is deprecated in v1.33+.

Type

`object`

.subsets[].addresses¶

Description

IP addresses which offer the related ports that are marked as ready. These endpoints should be considered safe for load balancers and clients to utilize.

Type

`array`

.subsets[].addresses[]¶

Description

EndpointAddress is a tuple that describes single IP address. Deprecated: This API is deprecated in v1.33+.

Type

`object`

Required

• ip

.subsets[].addresses[].targetRef¶

Description

ObjectReference contains enough information to let you inspect or modify the referred object.

Type

`object`

.subsets[].notReadyAddresses¶

Description

IP addresses which offer the related ports but are not currently marked as ready because they have not yet finished starting, have recently failed a readiness check, or have recently failed a liveness check.

Type

`array`

.subsets[].notReadyAddresses[]¶

Description

EndpointAddress is a tuple that describes single IP address. Deprecated: This API is deprecated in v1.33+.

Type

`object`

Required

• ip

.subsets[].notReadyAddresses[].targetRef¶

Description

ObjectReference contains enough information to let you inspect or modify the referred object.

Type

`object`

.subsets[].ports¶

Description

Port numbers available on the related IP addresses.

Type

`array`

.subsets[].ports[]¶

Description

EndpointPort is a tuple that describes a single port. Deprecated: This API is deprecated in v1.33+.

Type

`object`

Required

• port

API endpoints¶

The following API endpoints are available:

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

/api/v1/endpoints¶

HTTP method

`GET`

Description

list or watch objects of kind Endpoints

HTTP responses

/api/v1/watch/endpoints¶

HTTP method

`GET`

Description

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

HTTP responses

/api/v1/namespaces/{namespace}/endpoints¶

HTTP method

`DELETE`

Description

delete collection of Endpoints

Query parameters

HTTP responses

HTTP method

`GET`

Description

list or watch objects of kind Endpoints

HTTP responses

HTTP method

`POST`

Description

create Endpoints

Query parameters

Body parameters

HTTP responses

/api/v1/watch/namespaces/{namespace}/endpoints¶

HTTP method

`GET`

Description

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

HTTP responses

/api/v1/namespaces/{namespace}/endpoints/{name}¶

Global path parameters

HTTP method

`DELETE`

Description

delete Endpoints

Query parameters

HTTP responses

HTTP method

`GET`

Description

read the specified Endpoints

HTTP responses

HTTP method

`PATCH`

Description

partially update the specified Endpoints

Query parameters

HTTP responses

HTTP method

`PUT`

Description

replace the specified Endpoints

Query parameters

Body parameters

HTTP responses

/api/v1/watch/namespaces/{namespace}/endpoints/{name}¶

Global path parameters

HTTP method

`GET`

Description

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

HTTP responses