--- api_metadata: apiVersion: "v1" import: "k8s.io/api/core/v1" kind: "ResourceQuota" content_type: "api_reference" description: "ResourceQuota sets aggregate quota restrictions enforced per namespace." title: "ResourceQuota" weight: 2 auto_generated: true --- `apiVersion: v1` `import "k8s.io/api/core/v1"` ## ResourceQuota {#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} 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) 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. Possible enum values: - `"DoesNotExist"` - `"Exists"` - `"In"` - `"NotIn"` - **scopeSelector.matchExpressions.scopeName** (string), required The name of the scope that the selector applies to. Possible enum values: - `"BestEffort"` Match all pod objects that have best effort quality of service - `"CrossNamespacePodAffinity"` Match all pod objects that have cross-namespace pod (anti)affinity mentioned. This is a beta feature enabled by the PodAffinityNamespaceSelector feature flag. - `"NotBestEffort"` Match all pod objects that do not have best effort quality of service - `"NotTerminating"` Match all pod objects where spec.activeDeadlineSeconds is nil - `"PriorityClass"` Match all pod objects that have priority class mentioned - `"Terminating"` Match all pod objects where spec.activeDeadlineSeconds >=0 - **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} 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} 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 {#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 }}">namespace - **pretty** (*in query*): string }}">pretty #### 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 }}">namespace - **pretty** (*in query*): string }}">pretty #### 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 }}">namespace - **allowWatchBookmarks** (*in query*): boolean }}">allowWatchBookmarks - **continue** (*in query*): string }}">continue - **fieldSelector** (*in query*): string }}">fieldSelector - **labelSelector** (*in query*): string }}">labelSelector - **limit** (*in query*): integer }}">limit - **pretty** (*in query*): string }}">pretty - **resourceVersion** (*in query*): string }}">resourceVersion - **resourceVersionMatch** (*in query*): string }}">resourceVersionMatch - **timeoutSeconds** (*in query*): integer }}">timeoutSeconds - **watch** (*in query*): boolean }}">watch #### 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 }}">allowWatchBookmarks - **continue** (*in query*): string }}">continue - **fieldSelector** (*in query*): string }}">fieldSelector - **labelSelector** (*in query*): string }}">labelSelector - **limit** (*in query*): integer }}">limit - **pretty** (*in query*): string }}">pretty - **resourceVersion** (*in query*): string }}">resourceVersion - **resourceVersionMatch** (*in query*): string }}">resourceVersionMatch - **timeoutSeconds** (*in query*): integer }}">timeoutSeconds - **watch** (*in query*): boolean }}">watch #### Response 200 (}}">ResourceQuotaList): OK 401: Unauthorized ### `create` create a ResourceQuota #### HTTP Request POST /api/v1/namespaces/{namespace}/resourcequotas #### Parameters - **namespace** (*in path*): string, required }}">namespace - **body**: }}">ResourceQuota, required - **dryRun** (*in query*): string }}">dryRun - **fieldManager** (*in query*): string }}">fieldManager - **fieldValidation** (*in query*): string }}">fieldValidation - **pretty** (*in query*): string }}">pretty #### 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 }}">namespace - **body**: }}">ResourceQuota, required - **dryRun** (*in query*): string }}">dryRun - **fieldManager** (*in query*): string }}">fieldManager - **fieldValidation** (*in query*): string }}">fieldValidation - **pretty** (*in query*): string }}">pretty #### 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 }}">namespace - **body**: }}">ResourceQuota, required - **dryRun** (*in query*): string }}">dryRun - **fieldManager** (*in query*): string }}">fieldManager - **fieldValidation** (*in query*): string }}">fieldValidation - **pretty** (*in query*): string }}">pretty #### 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 }}">namespace - **body**: }}">Patch, required - **dryRun** (*in query*): string }}">dryRun - **fieldManager** (*in query*): string }}">fieldManager - **fieldValidation** (*in query*): string }}">fieldValidation - **force** (*in query*): boolean }}">force - **pretty** (*in query*): string }}">pretty #### 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 }}">namespace - **body**: }}">Patch, required - **dryRun** (*in query*): string }}">dryRun - **fieldManager** (*in query*): string }}">fieldManager - **fieldValidation** (*in query*): string }}">fieldValidation - **force** (*in query*): boolean }}">force - **pretty** (*in query*): string }}">pretty #### 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 }}">namespace - **body**: }}">DeleteOptions - **dryRun** (*in query*): string }}">dryRun - **gracePeriodSeconds** (*in query*): integer }}">gracePeriodSeconds - **pretty** (*in query*): string }}">pretty - **propagationPolicy** (*in query*): string }}">propagationPolicy #### 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 }}">namespace - **body**: }}">DeleteOptions - **continue** (*in query*): string }}">continue - **dryRun** (*in query*): string }}">dryRun - **fieldSelector** (*in query*): string }}">fieldSelector - **gracePeriodSeconds** (*in query*): integer }}">gracePeriodSeconds - **labelSelector** (*in query*): string }}">labelSelector - **limit** (*in query*): integer }}">limit - **pretty** (*in query*): string }}">pretty - **propagationPolicy** (*in query*): string }}">propagationPolicy - **resourceVersion** (*in query*): string }}">resourceVersion - **resourceVersionMatch** (*in query*): string }}">resourceVersionMatch - **timeoutSeconds** (*in query*): integer }}">timeoutSeconds #### Response 200 (}}">Status): OK 401: Unauthorized