ResourceQuota

apiVersion: v1

import "k8s.io/api/core/v1"

ResourceQuota sets aggregate quota restrictions enforced per namespace

• apiVersion: v1

• kind: ResourceQuota

• metadata (ObjectMeta)

  Standard object’s metadata. More info:

• spec (ResourceQuotaSpec)

  Spec defines the desired quota.

• status (ResourceQuotaStatus)

  Status defines the actual enforced quota and its current usage.

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:

• 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 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:

• used (map[string]Quantity)

  Used is the current observed total usage of the resource in the namespace.

ResourceQuotaList is a list of ResourceQuota items.

• apiVersion: v1

• kind: ResourceQuotaList

• metadata ()

  Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

• items ([]), required

  Items is a list of ResourceQuota objects. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/

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

  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

Response

200 (): 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

  allowWatchBookmarks

• continue (in query): string

• fieldSelector (in query): string

  fieldSelector

• labelSelector (in query): string

• limit (in query): integer

  limit

• pretty (in query): string

• resourceVersion (in query): string

  resourceVersion

• timeoutSeconds (in query): integer

  timeoutSeconds

• watch (in query): boolean

Response

200 (): OK

401: Unauthorized

HTTP Request

GET /api/v1/resourcequotas

Parameters

• allowWatchBookmarks (in query): boolean

  allowWatchBookmarks

• continue (in query): string

• fieldSelector (in query): string

  fieldSelector

• labelSelector (in query): string

• limit (in query): integer

  limit

• pretty (in query): string

• resourceVersion (in query): string

  resourceVersion

• resourceVersionMatch (in query): string

• timeoutSeconds (in query): integer

  timeoutSeconds

• watch (in query): boolean

Response

200 (): OK

401: Unauthorized

create create a ResourceQuota

HTTP Request

POST /api/v1/namespaces/{namespace}/resourcequotas

Parameters

• namespace (in path): string, required

• dryRun (in query): string

  dryRun

• fieldManager (in query): string

• pretty (in query): string

  pretty

Response

200 (ResourceQuota): OK

201 (): 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: , required

• dryRun (in query): string

  dryRun

• fieldManager (in query): string

• pretty (in query): string

  pretty

Response

200 (ResourceQuota): OK

201 (): Created

401: Unauthorized

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: , required

• dryRun (in query): string

  dryRun

• fieldManager (in query): string

• pretty (in query): string

  pretty

Response

200 (ResourceQuota): OK

201 (): Created

401: Unauthorized

patch partially update the specified ResourceQuota

HTTP Request

PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}

Parameters

• name of the ResourceQuota

• namespace (in path): string, required

• body: Patch, required

• dryRun (in query): string

• fieldManager (in query): string

  fieldManager

• force (in query): boolean

• pretty (in query): string

  pretty

Response

200 (ResourceQuota): OK

201 (): 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

  fieldManager

• force (in query): boolean

• pretty (in query): string

  pretty

Response

200 (ResourceQuota): OK

201 (): Created

401: Unauthorized

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:

• dryRun (in query): string

  dryRun

• gracePeriodSeconds (in query): integer

• pretty (in query): string

  pretty

• propagationPolicy (in query): string

Response

200 (): 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:

• continue (in query): string

  continue

• dryRun (in query): string

• fieldSelector (in query): string

  fieldSelector

• gracePeriodSeconds (in query): integer

• labelSelector (in query): string

  labelSelector

• limit (in query): integer

• pretty (in query): string

  pretty

• propagationPolicy (in query): string

• resourceVersion (in query): string

  resourceVersion

• timeoutSeconds (in query): integer

Response

401: Unauthorized