ResourceQuota
apiVersion: v1
import "k8s.io/api/core/v1"
ResourceQuota
ResourceQuota sets aggregate quota restrictions enforced per namespace
- apiVersion: v1 
- kind: ResourceQuota 
- metadata (ObjectMeta) - Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata 
- spec (ResourceQuotaSpec) - Spec defines the desired quota. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status 
- status (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]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) - Atomic: will be replaced during a merge - 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) - Atomic: will be replaced during a merge - 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) - Atomic: will be replaced during a merge - 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]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]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 (ListMeta) - Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds 
- items ([]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 
- pretty (in query): string 
Response
200 (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 
- pretty (in query): string 
Response
200 (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 
- allowWatchBookmarks (in query): boolean 
- continue (in query): string 
- fieldSelector (in query): string 
- labelSelector (in query): string 
- limit (in query): integer 
- pretty (in query): string 
- resourceVersion (in query): string 
- resourceVersionMatch (in query): string 
- sendInitialEvents (in query): boolean 
- timeoutSeconds (in query): integer 
- watch (in query): boolean 
Response
200 (ResourceQuotaList): OK
401: Unauthorized
list list or watch objects of kind ResourceQuota
HTTP Request
GET /api/v1/resourcequotas
Parameters
- allowWatchBookmarks (in query): boolean 
- continue (in query): string 
- fieldSelector (in query): string 
- labelSelector (in query): string 
- limit (in query): integer 
- pretty (in query): string 
- resourceVersion (in query): string 
- resourceVersionMatch (in query): string 
- sendInitialEvents (in query): boolean 
- timeoutSeconds (in query): integer 
- watch (in query): boolean 
Response
200 (ResourceQuotaList): OK
401: Unauthorized
create create a ResourceQuota
HTTP Request
POST /api/v1/namespaces/{namespace}/resourcequotas
Parameters
- namespace (in path): string, required 
- body: ResourceQuota, required 
- dryRun (in query): string 
- fieldManager (in query): string 
- fieldValidation (in query): string 
- pretty (in query): string 
Response
200 (ResourceQuota): OK
201 (ResourceQuota): Created
202 (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 
- body: ResourceQuota, required 
- dryRun (in query): string 
- fieldManager (in query): string 
- fieldValidation (in query): string 
- pretty (in query): string 
Response
200 (ResourceQuota): OK
201 (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 
- body: ResourceQuota, required 
- dryRun (in query): string 
- fieldManager (in query): string 
- fieldValidation (in query): string 
- pretty (in query): string 
Response
200 (ResourceQuota): OK
201 (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 
- body: Patch, required 
- dryRun (in query): string 
- fieldManager (in query): string 
- fieldValidation (in query): string 
- force (in query): boolean 
- pretty (in query): string 
Response
200 (ResourceQuota): OK
201 (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 
- body: Patch, required 
- dryRun (in query): string 
- fieldManager (in query): string 
- fieldValidation (in query): string 
- force (in query): boolean 
- pretty (in query): string 
Response
200 (ResourceQuota): OK
201 (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 
- body: DeleteOptions 
- dryRun (in query): string 
- gracePeriodSeconds (in query): integer 
- pretty (in query): string 
- propagationPolicy (in query): string 
Response
200 (ResourceQuota): OK
202 (ResourceQuota): Accepted
401: Unauthorized
deletecollection delete collection of ResourceQuota
HTTP Request
DELETE /api/v1/namespaces/{namespace}/resourcequotas
Parameters
- namespace (in path): string, required 
- body: DeleteOptions 
- continue (in query): string 
- dryRun (in query): string 
- fieldSelector (in query): string 
- gracePeriodSeconds (in query): integer 
- labelSelector (in query): string 
- limit (in query): integer 
- pretty (in query): string 
- propagationPolicy (in query): string 
- resourceVersion (in query): string 
- resourceVersionMatch (in query): string 
- sendInitialEvents (in query): boolean 
- timeoutSeconds (in query): integer 
Response
200 (Status): OK
401: Unauthorized
This page is automatically generated.
If you plan to report an issue with this page, mention that the page is auto-generated in your issue description. The fix may need to happen elsewhere in the Kubernetes project.