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 |
