Schedule and quota APIs
Reference guide for schedule and quota APIs
Abstract
Chapter 1. Schedule and quota APIs
1.1. AppliedClusterResourceQuota [quota.openshift.io/v1]
- Description
AppliedClusterResourceQuota mirrors ClusterResourceQuota at a project scope, for projection into a project. It allows a project-admin to know which ClusterResourceQuotas are applied to his project and their associated usage.
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
- Type
-
object
1.2. ClusterResourceQuota [quota.openshift.io/v1]
- Description
- ClusterResourceQuota mirrors ResourceQuota at a cluster scope. This object is easily convertible to synthetic ResourceQuota object to allow quota evaluation re-use. Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
- Type
-
object
1.3. FlowSchema [flowcontrol.apiserver.k8s.io/v1]
- Description
- FlowSchema defines the schema of a group of flows. Note that a flow is made up of a set of inbound API requests with similar attributes and is identified by a pair of strings: the name of the FlowSchema and a "flow distinguisher".
- Type
-
object
1.4. LimitRange [v1]
- Description
- LimitRange sets resource usage limits for each kind of resource in a Namespace.
- Type
-
object
1.5. PriorityClass [scheduling.k8s.io/v1]
- Description
- PriorityClass defines mapping from a priority class name to the priority integer value. The value can be any valid integer.
- Type
-
object
1.6. PriorityLevelConfiguration [flowcontrol.apiserver.k8s.io/v1]
- Description
- PriorityLevelConfiguration represents the configuration of a priority level.
- Type
-
object
1.7. ResourceQuota [v1]
- Description
- ResourceQuota sets aggregate quota restrictions enforced per namespace
- Type
-
object
Chapter 2. AppliedClusterResourceQuota [quota.openshift.io/v1]
- Description
AppliedClusterResourceQuota mirrors ClusterResourceQuota at a project scope, for projection into a project. It allows a project-admin to know which ClusterResourceQuotas are applied to his project and their associated usage.
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
- Type
-
object
- Required
-
metadata
-
spec
-
2.1. Specification
Property | Type | Description |
---|---|---|
|
| 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 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 is the standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
| ClusterResourceQuotaSpec defines the desired quota restrictions |
|
| ClusterResourceQuotaStatus defines the actual enforced quota and its current usage |
2.1.1. .spec
- Description
- ClusterResourceQuotaSpec defines the desired quota restrictions
- Type
-
object
- Required
-
selector
-
quota
-
Property | Type | Description |
---|---|---|
| Quota defines the desired quota | |
|
| ClusterResourceQuotaSelector is used to select projects. At least one of LabelSelector or AnnotationSelector must present. If only one is present, it is the only selection criteria. If both are specified, the project must match both restrictions. |
2.1.2. .spec.selector
- Description
- ClusterResourceQuotaSelector is used to select projects. At least one of LabelSelector or AnnotationSelector must present. If only one is present, it is the only selection criteria. If both are specified, the project must match both restrictions.
- Type
-
object
Property | Type | Description |
---|---|---|
|
| AnnotationSelector is used to select projects by annotation. |
| LabelSelector is used to select projects by label. |
2.1.3. .status
- Description
- ClusterResourceQuotaStatus defines the actual enforced quota and its current usage
- Type
-
object
- Required
-
total
-
Property | Type | Description |
---|---|---|
|
| Namespaces slices the usage by project. This division allows for quick resolution of deletion reconciliation inside of a single project without requiring a recalculation across all projects. This can be used to pull the deltas for a given project. |
|
| ResourceQuotaStatusByNamespace gives status for a particular project |
| Total defines the actual enforced quota and its current usage across all projects |
2.1.4. .status.namespaces
- Description
- Namespaces slices the usage by project. This division allows for quick resolution of deletion reconciliation inside of a single project without requiring a recalculation across all projects. This can be used to pull the deltas for a given project.
- Type
-
array
2.1.5. .status.namespaces[]
- Description
- ResourceQuotaStatusByNamespace gives status for a particular project
- Type
-
object
- Required
-
namespace
-
status
-
Property | Type | Description |
---|---|---|
|
| Namespace the project this status applies to |
| Status indicates how many resources have been consumed by this project |
2.2. API endpoints
The following API endpoints are available:
/apis/quota.openshift.io/v1/appliedclusterresourcequotas
-
GET
: list objects of kind AppliedClusterResourceQuota
-
/apis/quota.openshift.io/v1/namespaces/{namespace}/appliedclusterresourcequotas
-
GET
: list objects of kind AppliedClusterResourceQuota
-
/apis/quota.openshift.io/v1/namespaces/{namespace}/appliedclusterresourcequotas/{name}
-
GET
: read the specified AppliedClusterResourceQuota
-
2.2.1. /apis/quota.openshift.io/v1/appliedclusterresourcequotas
- HTTP method
-
GET
- Description
- list objects of kind AppliedClusterResourceQuota
HTTP code | Reponse body |
---|---|
200 - OK | |
401 - Unauthorized | Empty |
2.2.2. /apis/quota.openshift.io/v1/namespaces/{namespace}/appliedclusterresourcequotas
- HTTP method
-
GET
- Description
- list objects of kind AppliedClusterResourceQuota
HTTP code | Reponse body |
---|---|
200 - OK | |
401 - Unauthorized | Empty |
2.2.3. /apis/quota.openshift.io/v1/namespaces/{namespace}/appliedclusterresourcequotas/{name}
Parameter | Type | Description |
---|---|---|
|
| name of the AppliedClusterResourceQuota |
- HTTP method
-
GET
- Description
- read the specified AppliedClusterResourceQuota
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
Chapter 3. ClusterResourceQuota [quota.openshift.io/v1]
- Description
- ClusterResourceQuota mirrors ResourceQuota at a cluster scope. This object is easily convertible to synthetic ResourceQuota object to allow quota evaluation re-use. Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
- Type
-
object
- Required
-
metadata
-
spec
-
3.1. Specification
Property | Type | Description |
---|---|---|
|
| 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 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 |
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
| Spec defines the desired quota |
|
| Status defines the actual enforced quota and its current usage |
3.1.1. .spec
- Description
- Spec defines the desired quota
- Type
-
object
- Required
-
quota
-
selector
-
Property | Type | Description |
---|---|---|
|
| Quota defines the desired quota |
|
| Selector is the selector used to match projects. It should only select active projects on the scale of dozens (though it can select many more less active projects). These projects will contend on object creation through this resource. |
3.1.2. .spec.quota
- Description
- Quota defines the desired quota
- Type
-
object
Property | Type | Description |
---|---|---|
|
| hard is the set of desired hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ |
|
| scopeSelector is also a collection of filters like scopes that must match each object tracked by a quota but expressed using ScopeSelectorOperator in combination with possible values. For a resource to match, both scopes AND scopeSelector (if specified in spec), must be matched. |
|
| A collection of filters that must match each object tracked by a quota. If not specified, the quota matches all objects. |
3.1.3. .spec.quota.scopeSelector
- Description
- scopeSelector is also a collection of filters like scopes that must match each object tracked by a quota but expressed using ScopeSelectorOperator in combination with possible values. For a resource to match, both scopes AND scopeSelector (if specified in spec), must be matched.
- Type
-
object
Property | Type | Description |
---|---|---|
|
| A list of scope selector requirements by scope of the resources. |
|
| A scoped-resource selector requirement is a selector that contains values, a scope name, and an operator that relates the scope name and values. |
3.1.4. .spec.quota.scopeSelector.matchExpressions
- Description
- A list of scope selector requirements by scope of the resources.
- Type
-
array
3.1.5. .spec.quota.scopeSelector.matchExpressions[]
- Description
- A scoped-resource selector requirement is a selector that contains values, a scope name, and an operator that relates the scope name and values.
- Type
-
object
- Required
-
operator
-
scopeName
-
Property | Type | Description |
---|---|---|
|
| Represents a scope’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. |
|
| The name of the scope that the selector applies to. |
|
| An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
3.1.6. .spec.selector
- Description
- Selector is the selector used to match projects. It should only select active projects on the scale of dozens (though it can select many more less active projects). These projects will contend on object creation through this resource.
- Type
-
object
Property | Type | Description |
---|---|---|
|
| AnnotationSelector is used to select projects by annotation. |
| `` | LabelSelector is used to select projects by label. |
3.1.7. .status
- Description
- Status defines the actual enforced quota and its current usage
- Type
-
object
- Required
-
total
-
Property | Type | Description |
---|---|---|
| `` | Namespaces slices the usage by project. This division allows for quick resolution of deletion reconciliation inside of a single project without requiring a recalculation across all projects. This can be used to pull the deltas for a given project. |
|
| Total defines the actual enforced quota and its current usage across all projects |
3.1.8. .status.total
- Description
- Total defines the actual enforced quota and its current usage across all projects
- Type
-
object
Property | Type | Description |
---|---|---|
|
| Hard is the set of enforced hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ |
|
| Used is the current observed total usage of the resource in the namespace. |
3.2. API endpoints
The following API endpoints are available:
/apis/quota.openshift.io/v1/clusterresourcequotas
-
DELETE
: delete collection of ClusterResourceQuota -
GET
: list objects of kind ClusterResourceQuota -
POST
: create a ClusterResourceQuota
-
/apis/quota.openshift.io/v1/watch/clusterresourcequotas
-
GET
: watch individual changes to a list of ClusterResourceQuota. deprecated: use the 'watch' parameter with a list operation instead.
-
/apis/quota.openshift.io/v1/clusterresourcequotas/{name}
-
DELETE
: delete a ClusterResourceQuota -
GET
: read the specified ClusterResourceQuota -
PATCH
: partially update the specified ClusterResourceQuota -
PUT
: replace the specified ClusterResourceQuota
-
/apis/quota.openshift.io/v1/watch/clusterresourcequotas/{name}
-
GET
: watch changes to an object of kind ClusterResourceQuota. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
-
/apis/quota.openshift.io/v1/clusterresourcequotas/{name}/status
-
GET
: read status of the specified ClusterResourceQuota -
PATCH
: partially update status of the specified ClusterResourceQuota -
PUT
: replace status of the specified ClusterResourceQuota
-
3.2.1. /apis/quota.openshift.io/v1/clusterresourcequotas
- HTTP method
-
DELETE
- Description
- delete collection of ClusterResourceQuota
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
- HTTP method
-
GET
- Description
- list objects of kind ClusterResourceQuota
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
- HTTP method
-
POST
- Description
- create a ClusterResourceQuota
Parameter | Type | Description |
---|---|---|
|
| 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 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. |
Parameter | Type | Description |
---|---|---|
|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | Empty |
3.2.2. /apis/quota.openshift.io/v1/watch/clusterresourcequotas
- HTTP method
-
GET
- Description
- watch individual changes to a list of ClusterResourceQuota. deprecated: use the 'watch' parameter with a list operation instead.
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
3.2.3. /apis/quota.openshift.io/v1/clusterresourcequotas/{name}
Parameter | Type | Description |
---|---|---|
|
| name of the ClusterResourceQuota |
- HTTP method
-
DELETE
- Description
- delete a ClusterResourceQuota
Parameter | Type | Description |
---|---|---|
|
| 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 code | Reponse body |
---|---|
200 - OK |
|
202 - Accepted |
|
401 - Unauthorized | Empty |
- HTTP method
-
GET
- Description
- read the specified ClusterResourceQuota
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
- HTTP method
-
PATCH
- Description
- partially update the specified ClusterResourceQuota
Parameter | Type | Description |
---|---|---|
|
| 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 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 code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
- HTTP method
-
PUT
- Description
- replace the specified ClusterResourceQuota
Parameter | Type | Description |
---|---|---|
|
| 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 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. |
Parameter | Type | Description |
---|---|---|
|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | Empty |
3.2.4. /apis/quota.openshift.io/v1/watch/clusterresourcequotas/{name}
Parameter | Type | Description |
---|---|---|
|
| name of the ClusterResourceQuota |
- HTTP method
-
GET
- Description
- watch changes to an object of kind ClusterResourceQuota. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
3.2.5. /apis/quota.openshift.io/v1/clusterresourcequotas/{name}/status
Parameter | Type | Description |
---|---|---|
|
| name of the ClusterResourceQuota |
- HTTP method
-
GET
- Description
- read status of the specified ClusterResourceQuota
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
- HTTP method
-
PATCH
- Description
- partially update status of the specified ClusterResourceQuota
Parameter | Type | Description |
---|---|---|
|
| 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 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 code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
- HTTP method
-
PUT
- Description
- replace status of the specified ClusterResourceQuota
Parameter | Type | Description |
---|---|---|
|
| 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 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. |
Parameter | Type | Description |
---|---|---|
|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | Empty |
Chapter 4. FlowSchema [flowcontrol.apiserver.k8s.io/v1]
- Description
- FlowSchema defines the schema of a group of flows. Note that a flow is made up of a set of inbound API requests with similar attributes and is identified by a pair of strings: the name of the FlowSchema and a "flow distinguisher".
- Type
-
object
4.1. Specification
Property | Type | Description |
---|---|---|
|
| 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 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 |
|
| |
|
| FlowSchemaSpec describes how the FlowSchema’s specification looks like. |
|
| FlowSchemaStatus represents the current state of a FlowSchema. |
4.1.1. .spec
- Description
- FlowSchemaSpec describes how the FlowSchema’s specification looks like.
- Type
-
object
- Required
-
priorityLevelConfiguration
-
Property | Type | Description |
---|---|---|
|
| FlowDistinguisherMethod specifies the method of a flow distinguisher. |
|
|
|
|
| PriorityLevelConfigurationReference contains information that points to the "request-priority" being used. |
|
|
|
|
| PolicyRulesWithSubjects prescribes a test that applies to a request to an apiserver. The test considers the subject making the request, the verb being requested, and the resource to be acted upon. This PolicyRulesWithSubjects matches a request if and only if both (a) at least one member of subjects matches the request and (b) at least one member of resourceRules or nonResourceRules matches the request. |
4.1.2. .spec.distinguisherMethod
- Description
- FlowDistinguisherMethod specifies the method of a flow distinguisher.
- Type
-
object
- Required
-
type
-
Property | Type | Description |
---|---|---|
|
|
|
4.1.3. .spec.priorityLevelConfiguration
- Description
- PriorityLevelConfigurationReference contains information that points to the "request-priority" being used.
- Type
-
object
- Required
-
name
-
Property | Type | Description |
---|---|---|
|
|
|
4.1.4. .spec.rules
- Description
-
rules
describes which requests will match this flow schema. This FlowSchema matches a request if and only if at least one member of rules matches the request. if it is an empty slice, there will be no requests matching the FlowSchema. - Type
-
array
4.1.5. .spec.rules[]
- Description
- PolicyRulesWithSubjects prescribes a test that applies to a request to an apiserver. The test considers the subject making the request, the verb being requested, and the resource to be acted upon. This PolicyRulesWithSubjects matches a request if and only if both (a) at least one member of subjects matches the request and (b) at least one member of resourceRules or nonResourceRules matches the request.
- Type
-
object
- Required
-
subjects
-
Property | Type | Description |
---|---|---|
|
|
|
|
| NonResourcePolicyRule is a predicate that matches non-resource requests according to their verb and the target non-resource URL. A NonResourcePolicyRule matches a request if and only if both (a) at least one member of verbs matches the request and (b) at least one member of nonResourceURLs matches the request. |
|
|
|
|
|
ResourcePolicyRule is a predicate that matches some resource requests, testing the request’s verb and the target resource. A ResourcePolicyRule matches a resource request if and only if: (a) at least one member of verbs matches the request, (b) at least one member of apiGroups matches the request, (c) at least one member of resources matches the request, and (d) either (d1) the request does not specify a namespace (i.e., |
|
| subjects is the list of normal user, serviceaccount, or group that this rule cares about. There must be at least one member in this slice. A slice that includes both the system:authenticated and system:unauthenticated user groups matches every request. Required. |
|
| Subject matches the originator of a request, as identified by the request authentication system. There are three ways of matching an originator; by user, group, or service account. |
4.1.6. .spec.rules[].nonResourceRules
- Description
-
nonResourceRules
is a list of NonResourcePolicyRules that identify matching requests according to their verb and the target non-resource URL. - Type
-
array
4.1.7. .spec.rules[].nonResourceRules[]
- Description
- NonResourcePolicyRule is a predicate that matches non-resource requests according to their verb and the target non-resource URL. A NonResourcePolicyRule matches a request if and only if both (a) at least one member of verbs matches the request and (b) at least one member of nonResourceURLs matches the request.
- Type
-
object
- Required
-
verbs
-
nonResourceURLs
-
Property | Type | Description |
---|---|---|
|
|
|
|
|
|
4.1.8. .spec.rules[].resourceRules
- Description
-
resourceRules
is a slice of ResourcePolicyRules that identify matching requests according to their verb and the target resource. At least one ofresourceRules
andnonResourceRules
has to be non-empty. - Type
-
array
4.1.9. .spec.rules[].resourceRules[]
- Description
-
ResourcePolicyRule is a predicate that matches some resource requests, testing the request’s verb and the target resource. A ResourcePolicyRule matches a resource request if and only if: (a) at least one member of verbs matches the request, (b) at least one member of apiGroups matches the request, (c) at least one member of resources matches the request, and (d) either (d1) the request does not specify a namespace (i.e.,
Namespace==""
) and clusterScope is true or (d2) the request specifies a namespace and least one member of namespaces matches the request’s namespace. - Type
-
object
- Required
-
verbs
-
apiGroups
-
resources
-
Property | Type | Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
4.1.10. .spec.rules[].subjects
- Description
- subjects is the list of normal user, serviceaccount, or group that this rule cares about. There must be at least one member in this slice. A slice that includes both the system:authenticated and system:unauthenticated user groups matches every request. Required.
- Type
-
array
4.1.11. .spec.rules[].subjects[]
- Description
- Subject matches the originator of a request, as identified by the request authentication system. There are three ways of matching an originator; by user, group, or service account.
- Type
-
object
- Required
-
kind
-
Property | Type | Description |
---|---|---|
|
| GroupSubject holds detailed information for group-kind subject. |
|
|
|
|
| ServiceAccountSubject holds detailed information for service-account-kind subject. |
|
| UserSubject holds detailed information for user-kind subject. |
4.1.12. .spec.rules[].subjects[].group
- Description
- GroupSubject holds detailed information for group-kind subject.
- Type
-
object
- Required
-
name
-
Property | Type | Description |
---|---|---|
|
| name is the user group that matches, or "*" to match all user groups. See https://github.com/kubernetes/apiserver/blob/master/pkg/authentication/user/user.go for some well-known group names. Required. |
4.1.13. .spec.rules[].subjects[].serviceAccount
- Description
- ServiceAccountSubject holds detailed information for service-account-kind subject.
- Type
-
object
- Required
-
namespace
-
name
-
Property | Type | Description |
---|---|---|
|
|
|
|
|
|
4.1.14. .spec.rules[].subjects[].user
- Description
- UserSubject holds detailed information for user-kind subject.
- Type
-
object
- Required
-
name
-
Property | Type | Description |
---|---|---|
|
|
|
4.1.15. .status
- Description
- FlowSchemaStatus represents the current state of a FlowSchema.
- Type
-
object
Property | Type | Description |
---|---|---|
|
|
|
|
| FlowSchemaCondition describes conditions for a FlowSchema. |
4.1.16. .status.conditions
- Description
-
conditions
is a list of the current states of FlowSchema. - Type
-
array
4.1.17. .status.conditions[]
- Description
- FlowSchemaCondition describes conditions for a FlowSchema.
- Type
-
object
Property | Type | Description |
---|---|---|
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
4.2. API endpoints
The following API endpoints are available:
/apis/flowcontrol.apiserver.k8s.io/v1/flowschemas
-
DELETE
: delete collection of FlowSchema -
GET
: list or watch objects of kind FlowSchema -
POST
: create a FlowSchema
-
/apis/flowcontrol.apiserver.k8s.io/v1/watch/flowschemas
-
GET
: watch individual changes to a list of FlowSchema. deprecated: use the 'watch' parameter with a list operation instead.
-
/apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name}
-
DELETE
: delete a FlowSchema -
GET
: read the specified FlowSchema -
PATCH
: partially update the specified FlowSchema -
PUT
: replace the specified FlowSchema
-
/apis/flowcontrol.apiserver.k8s.io/v1/watch/flowschemas/{name}
-
GET
: watch changes to an object of kind FlowSchema. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
-
/apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name}/status
-
GET
: read status of the specified FlowSchema -
PATCH
: partially update status of the specified FlowSchema -
PUT
: replace status of the specified FlowSchema
-
4.2.1. /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas
- HTTP method
-
DELETE
- Description
- delete collection of FlowSchema
Parameter | Type | Description |
---|---|---|
|
| 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 code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
- HTTP method
-
GET
- Description
- list or watch objects of kind FlowSchema
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
- HTTP method
-
POST
- Description
- create a FlowSchema
Parameter | Type | Description |
---|---|---|
|
| 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 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. |
Parameter | Type | Description |
---|---|---|
|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | Empty |
4.2.2. /apis/flowcontrol.apiserver.k8s.io/v1/watch/flowschemas
- HTTP method
-
GET
- Description
- watch individual changes to a list of FlowSchema. deprecated: use the 'watch' parameter with a list operation instead.
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
4.2.3. /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name}
Parameter | Type | Description |
---|---|---|
|
| name of the FlowSchema |
- HTTP method
-
DELETE
- Description
- delete a FlowSchema
Parameter | Type | Description |
---|---|---|
|
| 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 code | Reponse body |
---|---|
200 - OK |
|
202 - Accepted |
|
401 - Unauthorized | Empty |
- HTTP method
-
GET
- Description
- read the specified FlowSchema
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
- HTTP method
-
PATCH
- Description
- partially update the specified FlowSchema
Parameter | Type | Description |
---|---|---|
|
| 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 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 code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | Empty |
- HTTP method
-
PUT
- Description
- replace the specified FlowSchema
Parameter | Type | Description |
---|---|---|
|
| 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 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. |
Parameter | Type | Description |
---|---|---|
|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | Empty |
4.2.4. /apis/flowcontrol.apiserver.k8s.io/v1/watch/flowschemas/{name}
Parameter | Type | Description |
---|---|---|
|
| name of the FlowSchema |
- HTTP method
-
GET
- Description
- watch changes to an object of kind FlowSchema. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
4.2.5. /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name}/status
Parameter | Type | Description |
---|---|---|
|
| name of the FlowSchema |
- HTTP method
-
GET
- Description
- read status of the specified FlowSchema
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
- HTTP method
-
PATCH
- Description
- partially update status of the specified FlowSchema
Parameter | Type | Description |
---|---|---|
|
| 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 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 code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | Empty |
- HTTP method
-
PUT
- Description
- replace status of the specified FlowSchema
Parameter | Type | Description |
---|---|---|
|
| 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 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. |
Parameter | Type | Description |
---|---|---|
|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | Empty |
Chapter 5. LimitRange [v1]
- Description
- LimitRange sets resource usage limits for each kind of resource in a Namespace.
- Type
-
object
5.1. Specification
Property | Type | Description |
---|---|---|
|
| 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 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 |
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
| LimitRangeSpec defines a min/max usage limit for resources that match on kind. |
5.1.1. .spec
- Description
- LimitRangeSpec defines a min/max usage limit for resources that match on kind.
- Type
-
object
- Required
-
limits
-
Property | Type | Description |
---|---|---|
|
| Limits is the list of LimitRangeItem objects that are enforced. |
|
| LimitRangeItem defines a min/max usage limit for any resource that matches on kind. |
5.1.2. .spec.limits
- Description
- Limits is the list of LimitRangeItem objects that are enforced.
- Type
-
array
5.1.3. .spec.limits[]
- Description
- LimitRangeItem defines a min/max usage limit for any resource that matches on kind.
- Type
-
object
- Required
-
type
-
Property | Type | Description |
---|---|---|
| Default resource requirement limit value by resource name if resource limit is omitted. | |
| DefaultRequest is the default resource requirement request value by resource name if resource request is omitted. | |
| Max usage constraints on this kind by resource name. | |
| MaxLimitRequestRatio if specified, the named resource must have a request and limit that are both non-zero where limit divided by request is less than or equal to the enumerated value; this represents the max burst for the named resource. | |
| Min usage constraints on this kind by resource name. | |
|
| Type of resource that this limit applies to. |
5.2. API endpoints
The following API endpoints are available:
/api/v1/limitranges
-
GET
: list or watch objects of kind LimitRange
-
/api/v1/watch/limitranges
-
GET
: watch individual changes to a list of LimitRange. deprecated: use the 'watch' parameter with a list operation instead.
-
/api/v1/namespaces/{namespace}/limitranges
-
DELETE
: delete collection of LimitRange -
GET
: list or watch objects of kind LimitRange -
POST
: create a LimitRange
-
/api/v1/watch/namespaces/{namespace}/limitranges
-
GET
: watch individual changes to a list of LimitRange. deprecated: use the 'watch' parameter with a list operation instead.
-
/api/v1/namespaces/{namespace}/limitranges/{name}
-
DELETE
: delete a LimitRange -
GET
: read the specified LimitRange -
PATCH
: partially update the specified LimitRange -
PUT
: replace the specified LimitRange
-
/api/v1/watch/namespaces/{namespace}/limitranges/{name}
-
GET
: watch changes to an object of kind LimitRange. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
-
5.2.1. /api/v1/limitranges
- HTTP method
-
GET
- Description
- list or watch objects of kind LimitRange
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
5.2.2. /api/v1/watch/limitranges
- HTTP method
-
GET
- Description
- watch individual changes to a list of LimitRange. deprecated: use the 'watch' parameter with a list operation instead.
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
5.2.3. /api/v1/namespaces/{namespace}/limitranges
- HTTP method
-
DELETE
- Description
- delete collection of LimitRange
Parameter | Type | Description |
---|---|---|
|
| 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 code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
- HTTP method
-
GET
- Description
- list or watch objects of kind LimitRange
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
- HTTP method
-
POST
- Description
- create a LimitRange
Parameter | Type | Description |
---|---|---|
|
| 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 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. |
Parameter | Type | Description |
---|---|---|
|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | Empty |
5.2.4. /api/v1/watch/namespaces/{namespace}/limitranges
- HTTP method
-
GET
- Description
- watch individual changes to a list of LimitRange. deprecated: use the 'watch' parameter with a list operation instead.
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
5.2.5. /api/v1/namespaces/{namespace}/limitranges/{name}
Parameter | Type | Description |
---|---|---|
|
| name of the LimitRange |
- HTTP method
-
DELETE
- Description
- delete a LimitRange
Parameter | Type | Description |
---|---|---|
|
| 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 code | Reponse body |
---|---|
200 - OK |
|
202 - Accepted |
|
401 - Unauthorized | Empty |
- HTTP method
-
GET
- Description
- read the specified LimitRange
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
- HTTP method
-
PATCH
- Description
- partially update the specified LimitRange
Parameter | Type | Description |
---|---|---|
|
| 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 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 code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | Empty |
- HTTP method
-
PUT
- Description
- replace the specified LimitRange
Parameter | Type | Description |
---|---|---|
|
| 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 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. |
Parameter | Type | Description |
---|---|---|
|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | Empty |
5.2.6. /api/v1/watch/namespaces/{namespace}/limitranges/{name}
Parameter | Type | Description |
---|---|---|
|
| name of the LimitRange |
- HTTP method
-
GET
- Description
- watch changes to an object of kind LimitRange. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
Chapter 6. PriorityClass [scheduling.k8s.io/v1]
- Description
- PriorityClass defines mapping from a priority class name to the priority integer value. The value can be any valid integer.
- Type
-
object
- Required
-
value
-
6.1. Specification
Property | Type | Description |
---|---|---|
|
| 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 |
|
| description is an arbitrary string that usually provides guidelines on when this priority class should be used. |
|
|
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 |
|
| 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 |
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
| preemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset.
Possible enum values: - |
|
| value represents the integer 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. |
6.2. API endpoints
The following API endpoints are available:
/apis/scheduling.k8s.io/v1/priorityclasses
-
DELETE
: delete collection of PriorityClass -
GET
: list or watch objects of kind PriorityClass -
POST
: create a PriorityClass
-
/apis/scheduling.k8s.io/v1/watch/priorityclasses
-
GET
: watch individual changes to a list of PriorityClass. deprecated: use the 'watch' parameter with a list operation instead.
-
/apis/scheduling.k8s.io/v1/priorityclasses/{name}
-
DELETE
: delete a PriorityClass -
GET
: read the specified PriorityClass -
PATCH
: partially update the specified PriorityClass -
PUT
: replace the specified PriorityClass
-
/apis/scheduling.k8s.io/v1/watch/priorityclasses/{name}
-
GET
: watch changes to an object of kind PriorityClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
-
6.2.1. /apis/scheduling.k8s.io/v1/priorityclasses
- HTTP method
-
DELETE
- Description
- delete collection of PriorityClass
Parameter | Type | Description |
---|---|---|
|
| 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 code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
- HTTP method
-
GET
- Description
- list or watch objects of kind PriorityClass
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
- HTTP method
-
POST
- Description
- create a PriorityClass
Parameter | Type | Description |
---|---|---|
|
| 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 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. |
Parameter | Type | Description |
---|---|---|
|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | Empty |
6.2.2. /apis/scheduling.k8s.io/v1/watch/priorityclasses
- HTTP method
-
GET
- Description
- watch individual changes to a list of PriorityClass. deprecated: use the 'watch' parameter with a list operation instead.
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
6.2.3. /apis/scheduling.k8s.io/v1/priorityclasses/{name}
Parameter | Type | Description |
---|---|---|
|
| name of the PriorityClass |
- HTTP method
-
DELETE
- Description
- delete a PriorityClass
Parameter | Type | Description |
---|---|---|
|
| 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 code | Reponse body |
---|---|
200 - OK |
|
202 - Accepted |
|
401 - Unauthorized | Empty |
- HTTP method
-
GET
- Description
- read the specified PriorityClass
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
- HTTP method
-
PATCH
- Description
- partially update the specified PriorityClass
Parameter | Type | Description |
---|---|---|
|
| 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 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 code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | Empty |
- HTTP method
-
PUT
- Description
- replace the specified PriorityClass
Parameter | Type | Description |
---|---|---|
|
| 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 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. |
Parameter | Type | Description |
---|---|---|
|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | Empty |
6.2.4. /apis/scheduling.k8s.io/v1/watch/priorityclasses/{name}
Parameter | Type | Description |
---|---|---|
|
| name of the PriorityClass |
- HTTP method
-
GET
- Description
- watch changes to an object of kind PriorityClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
Chapter 7. PriorityLevelConfiguration [flowcontrol.apiserver.k8s.io/v1]
- Description
- PriorityLevelConfiguration represents the configuration of a priority level.
- Type
-
object
7.1. Specification
Property | Type | Description |
---|---|---|
|
| 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 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 |
|
| |
|
| PriorityLevelConfigurationSpec specifies the configuration of a priority level. |
|
| PriorityLevelConfigurationStatus represents the current state of a "request-priority". |
7.1.1. .spec
- Description
- PriorityLevelConfigurationSpec specifies the configuration of a priority level.
- Type
-
object
- Required
-
type
-
Property | Type | Description |
---|---|---|
|
|
ExemptPriorityLevelConfiguration describes the configurable aspects of the handling of exempt requests. In the mandatory exempt configuration object the values in the fields here can be modified by authorized users, unlike the rest of the |
|
| LimitedPriorityLevelConfiguration specifies how to handle requests that are subject to limits. It addresses two issues: - How are requests for this priority level limited? - What should be done with requests that exceed the limit? |
|
|
|
7.1.2. .spec.exempt
- Description
-
ExemptPriorityLevelConfiguration describes the configurable aspects of the handling of exempt requests. In the mandatory exempt configuration object the values in the fields here can be modified by authorized users, unlike the rest of the
spec
. - Type
-
object
Property | Type | Description |
---|---|---|
|
|
LendableCL(i) = round( NominalCL(i) * lendablePercent(i)/100.0 ) |
|
|
NominalCL(i) = ceil( ServerCL * NCS(i) / sum_ncs ) sum_ncs = sum[priority level k] NCS(k) Bigger numbers mean a larger nominal concurrency limit, at the expense of every other priority level. This field has a default value of zero. |
7.1.3. .spec.limited
- Description
- LimitedPriorityLevelConfiguration specifies how to handle requests that are subject to limits. It addresses two issues: - How are requests for this priority level limited? - What should be done with requests that exceed the limit?
- Type
-
object
Property | Type | Description |
---|---|---|
|
|
BorrowingCL(i) = round( NominalCL(i) * borrowingLimitPercent(i)/100.0 )
The value of this field can be more than 100, implying that this priority level can borrow a number of seats that is greater than its own nominal concurrency limit (NominalCL). When this field is left |
|
|
LendableCL(i) = round( NominalCL(i) * lendablePercent(i)/100.0 ) |
|
| LimitResponse defines how to handle requests that can not be executed right now. |
|
|
NominalCL(i) = ceil( ServerCL * NCS(i) / sum_ncs ) sum_ncs = sum[priority level k] NCS(k) Bigger numbers mean a larger nominal concurrency limit, at the expense of every other priority level. If not specified, this field defaults to a value of 30. Setting this field to zero supports the construction of a "jail" for this priority level that is used to hold some request(s) |
7.1.4. .spec.limited.limitResponse
- Description
- LimitResponse defines how to handle requests that can not be executed right now.
- Type
-
object
- Required
-
type
-
Property | Type | Description |
---|---|---|
|
| QueuingConfiguration holds the configuration parameters for queuing |
|
|
|
7.1.5. .spec.limited.limitResponse.queuing
- Description
- QueuingConfiguration holds the configuration parameters for queuing
- Type
-
object
Property | Type | Description |
---|---|---|
|
|
|
|
|
|
|
|
|
7.1.6. .status
- Description
- PriorityLevelConfigurationStatus represents the current state of a "request-priority".
- Type
-
object
Property | Type | Description |
---|---|---|
|
|
|
|
| PriorityLevelConfigurationCondition defines the condition of priority level. |
7.1.7. .status.conditions
- Description
-
conditions
is the current state of "request-priority". - Type
-
array
7.1.8. .status.conditions[]
- Description
- PriorityLevelConfigurationCondition defines the condition of priority level.
- Type
-
object
Property | Type | Description |
---|---|---|
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
7.2. API endpoints
The following API endpoints are available:
/apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations
-
DELETE
: delete collection of PriorityLevelConfiguration -
GET
: list or watch objects of kind PriorityLevelConfiguration -
POST
: create a PriorityLevelConfiguration
-
/apis/flowcontrol.apiserver.k8s.io/v1/watch/prioritylevelconfigurations
-
GET
: watch individual changes to a list of PriorityLevelConfiguration. deprecated: use the 'watch' parameter with a list operation instead.
-
/apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name}
-
DELETE
: delete a PriorityLevelConfiguration -
GET
: read the specified PriorityLevelConfiguration -
PATCH
: partially update the specified PriorityLevelConfiguration -
PUT
: replace the specified PriorityLevelConfiguration
-
/apis/flowcontrol.apiserver.k8s.io/v1/watch/prioritylevelconfigurations/{name}
-
GET
: watch changes to an object of kind PriorityLevelConfiguration. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
-
/apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name}/status
-
GET
: read status of the specified PriorityLevelConfiguration -
PATCH
: partially update status of the specified PriorityLevelConfiguration -
PUT
: replace status of the specified PriorityLevelConfiguration
-
7.2.1. /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations
- HTTP method
-
DELETE
- Description
- delete collection of PriorityLevelConfiguration
Parameter | Type | Description |
---|---|---|
|
| 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 code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
- HTTP method
-
GET
- Description
- list or watch objects of kind PriorityLevelConfiguration
HTTP code | Reponse body |
---|---|
200 - OK | |
401 - Unauthorized | Empty |
- HTTP method
-
POST
- Description
- create a PriorityLevelConfiguration
Parameter | Type | Description |
---|---|---|
|
| 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 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. |
Parameter | Type | Description |
---|---|---|
|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | Empty |
7.2.2. /apis/flowcontrol.apiserver.k8s.io/v1/watch/prioritylevelconfigurations
- HTTP method
-
GET
- Description
- watch individual changes to a list of PriorityLevelConfiguration. deprecated: use the 'watch' parameter with a list operation instead.
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
7.2.3. /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name}
Parameter | Type | Description |
---|---|---|
|
| name of the PriorityLevelConfiguration |
- HTTP method
-
DELETE
- Description
- delete a PriorityLevelConfiguration
Parameter | Type | Description |
---|---|---|
|
| 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 code | Reponse body |
---|---|
200 - OK |
|
202 - Accepted |
|
401 - Unauthorized | Empty |
- HTTP method
-
GET
- Description
- read the specified PriorityLevelConfiguration
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
- HTTP method
-
PATCH
- Description
- partially update the specified PriorityLevelConfiguration
Parameter | Type | Description |
---|---|---|
|
| 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 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 code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | Empty |
- HTTP method
-
PUT
- Description
- replace the specified PriorityLevelConfiguration
Parameter | Type | Description |
---|---|---|
|
| 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 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. |
Parameter | Type | Description |
---|---|---|
|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | Empty |
7.2.4. /apis/flowcontrol.apiserver.k8s.io/v1/watch/prioritylevelconfigurations/{name}
Parameter | Type | Description |
---|---|---|
|
| name of the PriorityLevelConfiguration |
- HTTP method
-
GET
- Description
- watch changes to an object of kind PriorityLevelConfiguration. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
7.2.5. /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name}/status
Parameter | Type | Description |
---|---|---|
|
| name of the PriorityLevelConfiguration |
- HTTP method
-
GET
- Description
- read status of the specified PriorityLevelConfiguration
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
- HTTP method
-
PATCH
- Description
- partially update status of the specified PriorityLevelConfiguration
Parameter | Type | Description |
---|---|---|
|
| 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 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 code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | Empty |
- HTTP method
-
PUT
- Description
- replace status of the specified PriorityLevelConfiguration
Parameter | Type | Description |
---|---|---|
|
| 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 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. |
Parameter | Type | Description |
---|---|---|
|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | Empty |
Chapter 8. ResourceQuota [v1]
- Description
- ResourceQuota sets aggregate quota restrictions enforced per namespace
- Type
-
object
8.1. Specification
Property | Type | Description |
---|---|---|
|
| 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 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 |
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
| ResourceQuotaSpec defines the desired hard limits to enforce for Quota. |
|
| ResourceQuotaStatus defines the enforced hard limits and observed use. |
8.1.1. .spec
- Description
- ResourceQuotaSpec defines the desired hard limits to enforce for Quota.
- Type
-
object
Property | Type | Description |
---|---|---|
| hard is the set of desired hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ | |
|
| A scope selector represents the AND of the selectors represented by the scoped-resource selector requirements. |
|
| A collection of filters that must match each object tracked by a quota. If not specified, the quota matches all objects. |
8.1.2. .spec.scopeSelector
- Description
- A scope selector represents the AND of the selectors represented by the scoped-resource selector requirements.
- Type
-
object
Property | Type | Description |
---|---|---|
|
| A list of scope selector requirements by scope of the resources. |
|
| A scoped-resource selector requirement is a selector that contains values, a scope name, and an operator that relates the scope name and values. |
8.1.3. .spec.scopeSelector.matchExpressions
- Description
- A list of scope selector requirements by scope of the resources.
- Type
-
array
8.1.4. .spec.scopeSelector.matchExpressions[]
- Description
- A scoped-resource selector requirement is a selector that contains values, a scope name, and an operator that relates the scope name and values.
- Type
-
object
- Required
-
scopeName
-
operator
-
Property | Type | Description |
---|---|---|
|
| Represents a scope’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist.
Possible enum values: - |
|
| The name of the scope that the selector applies to.
Possible enum values: - |
|
| An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
8.1.5. .status
- Description
- ResourceQuotaStatus defines the enforced hard limits and observed use.
- Type
-
object
Property | Type | Description |
---|---|---|
| Hard is the set of enforced hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ | |
| Used is the current observed total usage of the resource in the namespace. |
8.2. API endpoints
The following API endpoints are available:
/api/v1/resourcequotas
-
GET
: list or watch objects of kind ResourceQuota
-
/api/v1/watch/resourcequotas
-
GET
: watch individual changes to a list of ResourceQuota. deprecated: use the 'watch' parameter with a list operation instead.
-
/api/v1/namespaces/{namespace}/resourcequotas
-
DELETE
: delete collection of ResourceQuota -
GET
: list or watch objects of kind ResourceQuota -
POST
: create a ResourceQuota
-
/api/v1/watch/namespaces/{namespace}/resourcequotas
-
GET
: watch individual changes to a list of ResourceQuota. deprecated: use the 'watch' parameter with a list operation instead.
-
/api/v1/namespaces/{namespace}/resourcequotas/{name}
-
DELETE
: delete a ResourceQuota -
GET
: read the specified ResourceQuota -
PATCH
: partially update the specified ResourceQuota -
PUT
: replace the specified ResourceQuota
-
/api/v1/watch/namespaces/{namespace}/resourcequotas/{name}
-
GET
: watch changes to an object of kind ResourceQuota. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
-
/api/v1/namespaces/{namespace}/resourcequotas/{name}/status
-
GET
: read status of the specified ResourceQuota -
PATCH
: partially update status of the specified ResourceQuota -
PUT
: replace status of the specified ResourceQuota
-
8.2.1. /api/v1/resourcequotas
- HTTP method
-
GET
- Description
- list or watch objects of kind ResourceQuota
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
8.2.2. /api/v1/watch/resourcequotas
- HTTP method
-
GET
- Description
- watch individual changes to a list of ResourceQuota. deprecated: use the 'watch' parameter with a list operation instead.
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
8.2.3. /api/v1/namespaces/{namespace}/resourcequotas
- HTTP method
-
DELETE
- Description
- delete collection of ResourceQuota
Parameter | Type | Description |
---|---|---|
|
| 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 code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
- HTTP method
-
GET
- Description
- list or watch objects of kind ResourceQuota
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
- HTTP method
-
POST
- Description
- create a ResourceQuota
Parameter | Type | Description |
---|---|---|
|
| 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 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. |
Parameter | Type | Description |
---|---|---|
|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | Empty |
8.2.4. /api/v1/watch/namespaces/{namespace}/resourcequotas
- HTTP method
-
GET
- Description
- watch individual changes to a list of ResourceQuota. deprecated: use the 'watch' parameter with a list operation instead.
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
8.2.5. /api/v1/namespaces/{namespace}/resourcequotas/{name}
Parameter | Type | Description |
---|---|---|
|
| name of the ResourceQuota |
- HTTP method
-
DELETE
- Description
- delete a ResourceQuota
Parameter | Type | Description |
---|---|---|
|
| 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 code | Reponse body |
---|---|
200 - OK |
|
202 - Accepted |
|
401 - Unauthorized | Empty |
- HTTP method
-
GET
- Description
- read the specified ResourceQuota
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
- HTTP method
-
PATCH
- Description
- partially update the specified ResourceQuota
Parameter | Type | Description |
---|---|---|
|
| 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 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 code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | Empty |
- HTTP method
-
PUT
- Description
- replace the specified ResourceQuota
Parameter | Type | Description |
---|---|---|
|
| 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 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. |
Parameter | Type | Description |
---|---|---|
|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | Empty |
8.2.6. /api/v1/watch/namespaces/{namespace}/resourcequotas/{name}
Parameter | Type | Description |
---|---|---|
|
| name of the ResourceQuota |
- HTTP method
-
GET
- Description
- watch changes to an object of kind ResourceQuota. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
8.2.7. /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
Parameter | Type | Description |
---|---|---|
|
| name of the ResourceQuota |
- HTTP method
-
GET
- Description
- read status of the specified ResourceQuota
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
- HTTP method
-
PATCH
- Description
- partially update status of the specified ResourceQuota
Parameter | Type | Description |
---|---|---|
|
| 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 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 code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | Empty |
- HTTP method
-
PUT
- Description
- replace status of the specified ResourceQuota
Parameter | Type | Description |
---|---|---|
|
| 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 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. |
Parameter | Type | Description |
---|---|---|
|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | Empty |
Legal Notice
Copyright © 2024 Red Hat, Inc.
OpenShift documentation is licensed under the Apache License 2.0 (https://www.apache.org/licenses/LICENSE-2.0).
Modified versions must remove all Red Hat trademarks.
Portions adapted from https://github.com/kubernetes-incubator/service-catalog/ with modifications by Red Hat.
Red Hat, Red Hat Enterprise Linux, the Red Hat logo, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation’s permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.