This is a cache of https://docs.okd.io/4.11/rest_api/policy_apis/eviction-policy-v1.html. It is a snapshot of the page at 2024-11-24T21:15:16.012+0000.
Eviction [policy/v1] - Policy <strong>api</strong>s | <strong>api</strong> reference | OKD 4.11
  1. Documentation
×

Eviction [policy/v1]

Description

Eviction evicts a pod from its node subject to certain policies and safety constraints. This is a subresource of Pod. A request to cause such an eviction is created by POSTing to …​/pods/<pod name>/evictions.

Type

object

Specification

Property Type Description

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

deleteOptions

DeleteOptions

DeleteOptions may be provided

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

ObjectMeta describes the pod that is being evicted.

api endpoints

The following api endpoints are available:

  • /api/v1/namespaces/{namespace}/pods/{name}/eviction

    • POST: create eviction of a Pod

/api/v1/namespaces/{namespace}/pods/{name}/eviction

Table 1. Global path parameters
Parameter Type Description

name

string

name of the Eviction

namespace

string

object name and auth scope, such as for teams and projects
Table 2. Global 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

fieldManager

string

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

pretty

string

If 'true', then the output is pretty printed.
HTTP method

POST

Description

create eviction of a Pod

Table 3. Body parameters
Parameter Type Description

body

Eviction schema
Table 4. HTTP responses
HTTP code Reponse body

200 - OK

Eviction schema

201 - Created

Eviction schema

202 - Accepted

Eviction schema

401 - Unauthorized

Empty