11 KiB
| api_metadata | content_type | description | title | weight | auto_generated | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
api_reference | PriorityClass defines mapping from a priority class name to the priority integer value. | PriorityClass | 14 | true |
apiVersion: scheduling.k8s.io/v1
import "k8s.io/api/scheduling/v1"
PriorityClass
PriorityClass defines mapping from a priority class name to the priority integer value. The value can be any valid integer.
-
apiVersion: scheduling.k8s.io/v1
-
kind: PriorityClass
-
metadata (<a href="{{< ref "../common-definitions/object-meta#ObjectMeta" >}}">ObjectMeta)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
-
value (int32), required
The value of this priority class. This is the actual priority that pods receive when they have the name of this class in their pod spec.
-
description (string)
description is an arbitrary string that usually provides guidelines on when this priority class should be used.
-
globalDefault (boolean)
globalDefault specifies whether this PriorityClass should be considered as the default priority for pods that do not have any priority class. Only one PriorityClass can be marked as
globalDefault. However, if more than one PriorityClasses exists with theirglobalDefaultfield set to true, the smallest value of such global default PriorityClasses will be used as the default priority. -
preemptionPolicy (string)
PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset.
PriorityClassList
PriorityClassList is a collection of priority classes.
-
apiVersion: scheduling.k8s.io/v1
-
kind: PriorityClassList
-
metadata (<a href="{{< ref "../common-definitions/list-meta#ListMeta" >}}">ListMeta)
Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
-
items ([]<a href="{{< ref "../workload-resources/priority-class-v1#PriorityClass" >}}">PriorityClass), required
items is the list of PriorityClasses
Operations
get read the specified PriorityClass
HTTP Request
GET /apis/scheduling.k8s.io/v1/priorityclasses/{name}
Parameters
-
name (in path): string, required
name of the PriorityClass
-
pretty (in query): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty
Response
200 (<a href="{{< ref "../workload-resources/priority-class-v1#PriorityClass" >}}">PriorityClass): OK
401: Unauthorized
list list or watch objects of kind PriorityClass
HTTP Request
GET /apis/scheduling.k8s.io/v1/priorityclasses
Parameters
-
allowWatchBookmarks (in query): boolean
<a href="{{< ref "../common-parameters/common-parameters#allowWatchBookmarks" >}}">allowWatchBookmarks
-
continue (in query): string
<a href="{{< ref "../common-parameters/common-parameters#continue" >}}">continue
-
fieldSelector (in query): string
<a href="{{< ref "../common-parameters/common-parameters#fieldSelector" >}}">fieldSelector
-
labelSelector (in query): string
<a href="{{< ref "../common-parameters/common-parameters#labelSelector" >}}">labelSelector
-
limit (in query): integer
<a href="{{< ref "../common-parameters/common-parameters#limit" >}}">limit
-
pretty (in query): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty
-
resourceVersion (in query): string
<a href="{{< ref "../common-parameters/common-parameters#resourceVersion" >}}">resourceVersion
-
resourceVersionMatch (in query): string
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch
-
timeoutSeconds (in query): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds
-
watch (in query): boolean
<a href="{{< ref "../common-parameters/common-parameters#watch" >}}">watch
Response
200 (<a href="{{< ref "../workload-resources/priority-class-v1#PriorityClassList" >}}">PriorityClassList): OK
401: Unauthorized
create create a PriorityClass
HTTP Request
POST /apis/scheduling.k8s.io/v1/priorityclasses
Parameters
-
body: <a href="{{< ref "../workload-resources/priority-class-v1#PriorityClass" >}}">PriorityClass, required
-
dryRun (in query): string
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun
-
fieldManager (in query): string
<a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager
-
fieldValidation (in query): string
<a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation
-
pretty (in query): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty
Response
200 (<a href="{{< ref "../workload-resources/priority-class-v1#PriorityClass" >}}">PriorityClass): OK
201 (<a href="{{< ref "../workload-resources/priority-class-v1#PriorityClass" >}}">PriorityClass): Created
202 (<a href="{{< ref "../workload-resources/priority-class-v1#PriorityClass" >}}">PriorityClass): Accepted
401: Unauthorized
update replace the specified PriorityClass
HTTP Request
PUT /apis/scheduling.k8s.io/v1/priorityclasses/{name}
Parameters
-
name (in path): string, required
name of the PriorityClass
-
body: <a href="{{< ref "../workload-resources/priority-class-v1#PriorityClass" >}}">PriorityClass, required
-
dryRun (in query): string
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun
-
fieldManager (in query): string
<a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager
-
fieldValidation (in query): string
<a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation
-
pretty (in query): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty
Response
200 (<a href="{{< ref "../workload-resources/priority-class-v1#PriorityClass" >}}">PriorityClass): OK
201 (<a href="{{< ref "../workload-resources/priority-class-v1#PriorityClass" >}}">PriorityClass): Created
401: Unauthorized
patch partially update the specified PriorityClass
HTTP Request
PATCH /apis/scheduling.k8s.io/v1/priorityclasses/{name}
Parameters
-
name (in path): string, required
name of the PriorityClass
-
body: <a href="{{< ref "../common-definitions/patch#Patch" >}}">Patch, required
-
dryRun (in query): string
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun
-
fieldManager (in query): string
<a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager
-
fieldValidation (in query): string
<a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation
-
force (in query): boolean
<a href="{{< ref "../common-parameters/common-parameters#force" >}}">force
-
pretty (in query): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty
Response
200 (<a href="{{< ref "../workload-resources/priority-class-v1#PriorityClass" >}}">PriorityClass): OK
201 (<a href="{{< ref "../workload-resources/priority-class-v1#PriorityClass" >}}">PriorityClass): Created
401: Unauthorized
delete delete a PriorityClass
HTTP Request
DELETE /apis/scheduling.k8s.io/v1/priorityclasses/{name}
Parameters
-
name (in path): string, required
name of the PriorityClass
-
body: <a href="{{< ref "../common-definitions/delete-options#DeleteOptions" >}}">DeleteOptions
-
dryRun (in query): string
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun
-
gracePeriodSeconds (in query): integer
<a href="{{< ref "../common-parameters/common-parameters#gracePeriodSeconds" >}}">gracePeriodSeconds
-
pretty (in query): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty
-
propagationPolicy (in query): string
<a href="{{< ref "../common-parameters/common-parameters#propagationPolicy" >}}">propagationPolicy
Response
200 (<a href="{{< ref "../common-definitions/status#Status" >}}">Status): OK
202 (<a href="{{< ref "../common-definitions/status#Status" >}}">Status): Accepted
401: Unauthorized
deletecollection delete collection of PriorityClass
HTTP Request
DELETE /apis/scheduling.k8s.io/v1/priorityclasses
Parameters
-
body: <a href="{{< ref "../common-definitions/delete-options#DeleteOptions" >}}">DeleteOptions
-
continue (in query): string
<a href="{{< ref "../common-parameters/common-parameters#continue" >}}">continue
-
dryRun (in query): string
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun
-
fieldSelector (in query): string
<a href="{{< ref "../common-parameters/common-parameters#fieldSelector" >}}">fieldSelector
-
gracePeriodSeconds (in query): integer
<a href="{{< ref "../common-parameters/common-parameters#gracePeriodSeconds" >}}">gracePeriodSeconds
-
labelSelector (in query): string
<a href="{{< ref "../common-parameters/common-parameters#labelSelector" >}}">labelSelector
-
limit (in query): integer
<a href="{{< ref "../common-parameters/common-parameters#limit" >}}">limit
-
pretty (in query): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty
-
propagationPolicy (in query): string
<a href="{{< ref "../common-parameters/common-parameters#propagationPolicy" >}}">propagationPolicy
-
resourceVersion (in query): string
<a href="{{< ref "../common-parameters/common-parameters#resourceVersion" >}}">resourceVersion
-
resourceVersionMatch (in query): string
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch
-
timeoutSeconds (in query): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds
Response
200 (<a href="{{< ref "../common-definitions/status#Status" >}}">Status): OK
401: Unauthorized