19 KiB
| api_metadata | content_type | description | title | weight | auto_generated | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
api_reference | ResourceQuota sets aggregate quota restrictions enforced per namespace. | ResourceQuota | 2 | true |
apiVersion: v1
import "k8s.io/api/core/v1"
ResourceQuota
ResourceQuota sets aggregate quota restrictions enforced per namespace
-
apiVersion: v1
-
kind: ResourceQuota
-
metadata (<a href="{{< ref "../common-definitions/object-meta#ObjectMeta" >}}">ObjectMeta)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
-
spec (<a href="{{< ref "../policy-resources/resource-quota-v1#ResourceQuotaSpec" >}}">ResourceQuotaSpec)
Spec defines the desired quota. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
-
status (<a href="{{< ref "../policy-resources/resource-quota-v1#ResourceQuotaStatus" >}}">ResourceQuotaStatus)
Status defines the actual enforced quota and its current usage. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
ResourceQuotaSpec
ResourceQuotaSpec defines the desired hard limits to enforce for Quota.
-
hard (map[string]<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity)
hard is the set of desired hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/
-
scopeSelector (ScopeSelector)
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 scope selector represents the AND of the selectors represented by the scoped-resource selector requirements.
-
scopeSelector.matchExpressions ([]ScopedResourceSelectorRequirement)
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.
-
scopeSelector.matchExpressions.operator (string), required
Represents a scope's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist.
-
scopeSelector.matchExpressions.scopeName (string), required
The name of the scope that the selector applies to.
-
scopeSelector.matchExpressions.values ([]string)
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.
-
-
-
scopes ([]string)
A collection of filters that must match each object tracked by a quota. If not specified, the quota matches all objects.
ResourceQuotaStatus
ResourceQuotaStatus defines the enforced hard limits and observed use.
-
hard (map[string]<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity)
Hard is the set of enforced hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/
-
used (map[string]<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity)
Used is the current observed total usage of the resource in the namespace.
ResourceQuotaList
ResourceQuotaList is a list of ResourceQuota items.
-
apiVersion: v1
-
kind: ResourceQuotaList
-
metadata (<a href="{{< ref "../common-definitions/list-meta#ListMeta" >}}">ListMeta)
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
-
items ([]<a href="{{< ref "../policy-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota), required
Items is a list of ResourceQuota objects. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/
Operations
get read the specified ResourceQuota
HTTP Request
GET /api/v1/namespaces/{namespace}/resourcequotas/{name}
Parameters
-
name (in path): string, required
name of the ResourceQuota
-
namespace (in path): string, required
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace
-
pretty (in query): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty
Response
200 (<a href="{{< ref "../policy-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota): OK
401: Unauthorized
get read status of the specified ResourceQuota
HTTP Request
GET /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
Parameters
-
name (in path): string, required
name of the ResourceQuota
-
namespace (in path): string, required
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace
-
pretty (in query): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty
Response
200 (<a href="{{< ref "../policy-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota): OK
401: Unauthorized
list list or watch objects of kind ResourceQuota
HTTP Request
GET /api/v1/namespaces/{namespace}/resourcequotas
Parameters
-
namespace (in path): string, required
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace
-
allowWatchBookmarks (in query): boolean
<a href="{{< ref "../common-parameters/common-parameters#allowWatchBookmarks" >}}">allowWatchBookmarks
-
continue (in query): string
<a href="{{< ref "../common-parameters/common-parameters#continue" >}}">continue
-
fieldSelector (in query): string
<a href="{{< ref "../common-parameters/common-parameters#fieldSelector" >}}">fieldSelector
-
labelSelector (in query): string
<a href="{{< ref "../common-parameters/common-parameters#labelSelector" >}}">labelSelector
-
limit (in query): integer
<a href="{{< ref "../common-parameters/common-parameters#limit" >}}">limit
-
pretty (in query): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty
-
resourceVersion (in query): string
<a href="{{< ref "../common-parameters/common-parameters#resourceVersion" >}}">resourceVersion
-
resourceVersionMatch (in query): string
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch
-
timeoutSeconds (in query): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds
-
watch (in query): boolean
<a href="{{< ref "../common-parameters/common-parameters#watch" >}}">watch
Response
200 (<a href="{{< ref "../policy-resources/resource-quota-v1#ResourceQuotaList" >}}">ResourceQuotaList): OK
401: Unauthorized
list list or watch objects of kind ResourceQuota
HTTP Request
GET /api/v1/resourcequotas
Parameters
-
allowWatchBookmarks (in query): boolean
<a href="{{< ref "../common-parameters/common-parameters#allowWatchBookmarks" >}}">allowWatchBookmarks
-
continue (in query): string
<a href="{{< ref "../common-parameters/common-parameters#continue" >}}">continue
-
fieldSelector (in query): string
<a href="{{< ref "../common-parameters/common-parameters#fieldSelector" >}}">fieldSelector
-
labelSelector (in query): string
<a href="{{< ref "../common-parameters/common-parameters#labelSelector" >}}">labelSelector
-
limit (in query): integer
<a href="{{< ref "../common-parameters/common-parameters#limit" >}}">limit
-
pretty (in query): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty
-
resourceVersion (in query): string
<a href="{{< ref "../common-parameters/common-parameters#resourceVersion" >}}">resourceVersion
-
resourceVersionMatch (in query): string
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch
-
timeoutSeconds (in query): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds
-
watch (in query): boolean
<a href="{{< ref "../common-parameters/common-parameters#watch" >}}">watch
Response
200 (<a href="{{< ref "../policy-resources/resource-quota-v1#ResourceQuotaList" >}}">ResourceQuotaList): OK
401: Unauthorized
create create a ResourceQuota
HTTP Request
POST /api/v1/namespaces/{namespace}/resourcequotas
Parameters
-
namespace (in path): string, required
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace
-
body: <a href="{{< ref "../policy-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota, required
-
dryRun (in query): string
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun
-
fieldManager (in query): string
<a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager
-
fieldValidation (in query): string
<a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation
-
pretty (in query): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty
Response
200 (<a href="{{< ref "../policy-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota): OK
201 (<a href="{{< ref "../policy-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota): Created
202 (<a href="{{< ref "../policy-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota): Accepted
401: Unauthorized
update replace the specified ResourceQuota
HTTP Request
PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}
Parameters
-
name (in path): string, required
name of the ResourceQuota
-
namespace (in path): string, required
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace
-
body: <a href="{{< ref "../policy-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota, required
-
dryRun (in query): string
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun
-
fieldManager (in query): string
<a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager
-
fieldValidation (in query): string
<a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation
-
pretty (in query): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty
Response
200 (<a href="{{< ref "../policy-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota): OK
201 (<a href="{{< ref "../policy-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota): Created
401: Unauthorized
update replace status of the specified ResourceQuota
HTTP Request
PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
Parameters
-
name (in path): string, required
name of the ResourceQuota
-
namespace (in path): string, required
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace
-
body: <a href="{{< ref "../policy-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota, required
-
dryRun (in query): string
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun
-
fieldManager (in query): string
<a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager
-
fieldValidation (in query): string
<a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation
-
pretty (in query): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty
Response
200 (<a href="{{< ref "../policy-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota): OK
201 (<a href="{{< ref "../policy-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota): Created
401: Unauthorized
patch partially update the specified ResourceQuota
HTTP Request
PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}
Parameters
-
name (in path): string, required
name of the ResourceQuota
-
namespace (in path): string, required
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace
-
body: <a href="{{< ref "../common-definitions/patch#Patch" >}}">Patch, required
-
dryRun (in query): string
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun
-
fieldManager (in query): string
<a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager
-
fieldValidation (in query): string
<a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation
-
force (in query): boolean
<a href="{{< ref "../common-parameters/common-parameters#force" >}}">force
-
pretty (in query): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty
Response
200 (<a href="{{< ref "../policy-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota): OK
201 (<a href="{{< ref "../policy-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota): Created
401: Unauthorized
patch partially update status of the specified ResourceQuota
HTTP Request
PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
Parameters
-
name (in path): string, required
name of the ResourceQuota
-
namespace (in path): string, required
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace
-
body: <a href="{{< ref "../common-definitions/patch#Patch" >}}">Patch, required
-
dryRun (in query): string
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun
-
fieldManager (in query): string
<a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager
-
fieldValidation (in query): string
<a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation
-
force (in query): boolean
<a href="{{< ref "../common-parameters/common-parameters#force" >}}">force
-
pretty (in query): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty
Response
200 (<a href="{{< ref "../policy-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota): OK
201 (<a href="{{< ref "../policy-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota): Created
401: Unauthorized
delete delete a ResourceQuota
HTTP Request
DELETE /api/v1/namespaces/{namespace}/resourcequotas/{name}
Parameters
-
name (in path): string, required
name of the ResourceQuota
-
namespace (in path): string, required
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace
-
body: <a href="{{< ref "../common-definitions/delete-options#DeleteOptions" >}}">DeleteOptions
-
dryRun (in query): string
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun
-
gracePeriodSeconds (in query): integer
<a href="{{< ref "../common-parameters/common-parameters#gracePeriodSeconds" >}}">gracePeriodSeconds
-
pretty (in query): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty
-
propagationPolicy (in query): string
<a href="{{< ref "../common-parameters/common-parameters#propagationPolicy" >}}">propagationPolicy
Response
200 (<a href="{{< ref "../policy-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota): OK
202 (<a href="{{< ref "../policy-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota): Accepted
401: Unauthorized
deletecollection delete collection of ResourceQuota
HTTP Request
DELETE /api/v1/namespaces/{namespace}/resourcequotas
Parameters
-
namespace (in path): string, required
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace
-
body: <a href="{{< ref "../common-definitions/delete-options#DeleteOptions" >}}">DeleteOptions
-
continue (in query): string
<a href="{{< ref "../common-parameters/common-parameters#continue" >}}">continue
-
dryRun (in query): string
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun
-
fieldSelector (in query): string
<a href="{{< ref "../common-parameters/common-parameters#fieldSelector" >}}">fieldSelector
-
gracePeriodSeconds (in query): integer
<a href="{{< ref "../common-parameters/common-parameters#gracePeriodSeconds" >}}">gracePeriodSeconds
-
labelSelector (in query): string
<a href="{{< ref "../common-parameters/common-parameters#labelSelector" >}}">labelSelector
-
limit (in query): integer
<a href="{{< ref "../common-parameters/common-parameters#limit" >}}">limit
-
pretty (in query): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty
-
propagationPolicy (in query): string
<a href="{{< ref "../common-parameters/common-parameters#propagationPolicy" >}}">propagationPolicy
-
resourceVersion (in query): string
<a href="{{< ref "../common-parameters/common-parameters#resourceVersion" >}}">resourceVersion
-
resourceVersionMatch (in query): string
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch
-
timeoutSeconds (in query): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds
Response
200 (<a href="{{< ref "../common-definitions/status#Status" >}}">Status): OK
401: Unauthorized