diff --git a/content/zh-cn/docs/reference/kubernetes-api/policy-resources/resource-quota-v1.md b/content/zh-cn/docs/reference/kubernetes-api/policy-resources/resource-quota-v1.md new file mode 100644 index 0000000000..044e865468 --- /dev/null +++ b/content/zh-cn/docs/reference/kubernetes-api/policy-resources/resource-quota-v1.md @@ -0,0 +1,832 @@ +--- +api_metadata: + apiVersion: "v1" + import: "k8s.io/api/core/v1" + kind: "ResourceQuota" +content_type: "api_reference" +description: "ResourceQuota 设置每个命名空间强制执行的聚合配额限制。" +title: "ResourceQuota" +weight: 2 +--- + + + +`apiVersion: v1` + +`import "k8s.io/api/core/v1"` + +## ResourceQuota {#ResourceQuota} + + +ResourceQuota 设置每个命名空间强制执行的聚合配额限制。 + +
+ +- **apiVersion**: v1 + +- **kind**: ResourceQuota + +- **metadata** (}}">ObjectMeta) + + + + 标准的对象元数据。 + 更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +- **spec** (}}">ResourceQuotaSpec) + + + + spec 定义所需的配额。 + https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + +- **status** (}}">ResourceQuotaStatus) + + + + status 定义实际执行的配额及其当前使用情况。 + https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + +## ResourceQuotaSpec {#ResourceQuotaSpec} + +ResourceQuotaSpec 定义为 Quota 强制执行所需的硬限制。 + +
+ +- **hard** (map[string]}}">Quantity) + + + + hard 是每种指定资源所需的硬性限制集合。 + 更多信息: https://kubernetes.io/docs/concepts/policy/resource-quotas/ + +- **scopeSelector** (ScopeSelector) + + + + scopeSelector 也是一组过滤器的集合,和 scopes 类似, + 必须匹配配额所跟踪的每个对象,但使用 ScopeSelectorOperator 结合可能的值来表示。 + 对于要匹配的资源,必须同时匹配 scopes 和 scopeSelector(如果在 spec 中设置了的话)。 + + + + + scope 选择算符表示的是由限定范围的资源选择算符进行 **逻辑与** 计算得出的结果。 + + - **scopeSelector.matchExpressions** ([]ScopedResourceSelectorRequirement) + + + + 按资源范围划分的范围选择算符需求列表。 + + + + + 限定范围的资源选择算符需求是一种选择算符,包含值、范围名称和将二者关联起来的运算符。 + + - **scopeSelector.matchExpressions.operator** (string),必需 + + + + 表示范围与一组值之间的关系。有效的运算符为 In、NotIn、Exists、DoesNotExist。 + + - **scopeSelector.matchExpressions.scopeName** (string),必需 + + + + 选择器所适用的范围的名称。 + + - **scopeSelector.matchExpressions.values** ([]string) + + + + 字符串值数组。 + 如果操作符是 In 或 NotIn,values 数组必须是非空的。 + 如果操作符是 Exists 或 DoesNotExist,values 数组必须为空。 + 该数组将在策略性合并补丁操作期间被替换。 + +- **scopes** ([]string) + + + + 一个匹配被配额跟踪的所有对象的过滤器集合。 + 如果没有指定,则默认匹配所有对象。 + +## ResourceQuotaStatus {#ResourceQuotaStatus} + + +ResourceQuotaStatus 定义硬性限制和观测到的用量。 + +
+ +- **hard** (map[string]}}">Quantity) + + + + hard 是每种指定资源所强制实施的硬性限制集合。 + 更多信息: https://kubernetes.io/docs/concepts/policy/resource-quotas/ + +- **used** (map[string]}}">Quantity) + + + + used 是当前命名空间中所观察到的资源总用量。 + +## ResourceQuotaList {#ResourceQuotaList} + + +ResourceQuotaList 是 ResourceQuota 列表。 + +
+ +- **apiVersion**:v1 + +- **kind**:ResourceQuotaList + +- **metadata** (}}">ListMeta) + + + + 标准列表元数据。 + 更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +- **items** ([]}}">ResourceQuota),必需 + + + + items 是 ResourceQuota 对象的列表。 + 更多信息: https://kubernetes.io/docs/concepts/policy/resource-quotas/ + + +## 操作 {#Operations} + +
+ + +### `get` 读取指定的 ResourceQuota + + +#### HTTP 请求 + +GET /api/v1/namespaces/{namespace}/resourcequotas/{name} + + +#### 参数 + +- **name** (**路径参数**): string, 必需 + + ResourceQuota 的名称 + +- **namespace** (**路径参数**): string, 必需 + + }}">namespace + +- **pretty** (**查询参数**): string + + }}">pretty + + +#### 响应 + +200 (}}">ResourceQuota): OK + +401: Unauthorized + + +### `get` 读取指定的 ResourceQuota 的状态 + + +#### HTTP 请求 + +GET /api/v1/namespaces/{namespace}/resourcequotas/{name}/status + + +#### 参数 + +- **name** (**路径参数**): string, 必需 + + ResourceQuota 的名称 + +- **namespace** (**路径参数**): string, 必需 + + }}">namespace + +- **pretty** (**查询参数**): string + + }}">pretty + + +#### 响应 + +200 (}}">ResourceQuota): OK + +401: Unauthorized + + +### `list` 列出或监视 ResourceQuota 类别的对象 + + +#### HTTP 请求 + +GET /api/v1/namespaces/{namespace}/resourcequotas + + +#### 参数 + +- **namespace** (**路径参数**): string, 必需 + + }}">namespace + +- **allowWatchBookmarks** (**查询参数**): boolean + + }}">allowWatchBookmarks + +- **continue** (**查询参数**): string + + }}">continue + +- **fieldSelector** (**查询参数**): string + + }}">fieldSelector + +- **labelSelector** (**查询参数**): string + + }}">labelSelector + +- **limit** (**查询参数**): integer + + }}">limit + +- **pretty** (**查询参数**): string + + }}">pretty + +- **resourceVersion** (**查询参数**): string + + }}">resourceVersion + +- **resourceVersionMatch** (**查询参数**): string + + }}">resourceVersionMatch + +- **timeoutSeconds** (**查询参数**): integer + + }}">timeoutSeconds + +- **watch** (**查询参数**): boolean + + }}">watch + + +#### 响应 + +200 (}}">ResourceQuotaList): OK + +401: Unauthorized + + +### `list` 列出或监视 ResourceQuota 类别的对象 + + +#### HTTP 请求 + +GET /api/v1/resourcequotas + + +#### 参数 + +- **allowWatchBookmarks** (**查询参数**): boolean + + }}">allowWatchBookmarks + +- **continue** (**查询参数**): string + + }}">continue + +- **fieldSelector** (**查询参数**): string + + }}">fieldSelector + +- **labelSelector** (**查询参数**): string + + }}">labelSelector + +- **limit** (**查询参数**): integer + + }}">limit + +- **pretty** (**查询参数**): string + + }}">pretty + +- **resourceVersion** (**查询参数**): string + + }}">resourceVersion + +- **resourceVersionMatch** (**查询参数**): string + + }}">resourceVersionMatch + +- **timeoutSeconds** (**查询参数**): integer + + }}">timeoutSeconds + +- **watch** (**查询参数**): boolean + + }}">watch + + +#### 响应 + +200 (}}">ResourceQuotaList): OK + +401: Unauthorized + + +### `create` 创建一个 ResourceQuota + + +#### HTTP 请求 + +POST /api/v1/namespaces/{namespace}/resourcequotas + + +#### 参数 + +- **namespace** (**路径参数**): string, 必需 + + }}">namespace + +- **body**: }}">ResourceQuota, 必需 + +- **dryRun** (**查询参数**): string + + }}">dryRun + +- **fieldManager** (**查询参数**): string + + }}">fieldManager + +- **fieldValidation** (**查询参数**): string + + }}">fieldValidation + +- **pretty** (**查询参数**): string + + }}">pretty + + +#### 响应 + +200 (}}">ResourceQuota): OK + +201 (}}">ResourceQuota): Created + +202 (}}">ResourceQuota): Accepted + +401: Unauthorized + + +### `update` 更新指定的 ResourceQuota + + +#### HTTP 请求 + +PUT /api/v1/namespaces/{namespace}/resourcequotas/{name} + + +#### 参数 + +- **name** (**路径参数**): string, 必需 + + ResourceQuota 的名称 + +- **namespace** (**路径参数**): string, 必需 + + }}">namespace + +- **body**: }}">ResourceQuota, 必需 + +- **dryRun** (**查询参数**): string + + }}">dryRun + +- **fieldManager** (**查询参数**): string + + }}">fieldManager + +- **fieldValidation** (**查询参数**): string + + }}">fieldValidation + +- **pretty** (**查询参数**): string + + }}">pretty + + +#### 响应 + +200 (}}">ResourceQuota): OK + +201 (}}">ResourceQuota): Created + +401: Unauthorized + + +### `update` 更新指定 ResourceQuota 的状态 + + +#### HTTP 请求 + +PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}/status + + +#### 参数 + +- **name** (**路径参数**): string, 必需 + + ResourceQuota 的名称 + +- **namespace** (**路径参数**): string, 必需 + + }}">namespace + +- **body**: }}">ResourceQuota, 必需 + +- **dryRun** (**查询参数**): string + + }}">dryRun + +- **fieldManager** (**查询参数**): string + + }}">fieldManager + +- **fieldValidation** (**查询参数**): string + + }}">fieldValidation + +- **pretty** (**查询参数**): string + + }}">pretty + + +#### 响应 + +200 (}}">ResourceQuota): OK + +201 (}}">ResourceQuota): Created + +401: Unauthorized + + +### `patch` 部分更新指定的 ResourceQuota + + +#### HTTP 请求 + +PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name} + + +#### 参数 + +- **name** (**路径参数**): string, 必需 + + ResourceQuota 的名称 + +- **namespace** (**路径参数**): string, 必需 + + }}">namespace + +- **body**: }}">Patch, 必需 + +- **dryRun** (**查询参数**): string + + }}">dryRun + +- **fieldManager** (**查询参数**): string + + }}">fieldManager + +- **fieldValidation** (**查询参数**): string + + }}">fieldValidation + +- **force** (**查询参数**): boolean + + }}">force + +- **pretty** (**查询参数**): string + + }}">pretty + + +#### 响应 + +200 (}}">ResourceQuota): OK + +201 (}}">ResourceQuota): Created + +401: Unauthorized + + +### `patch` 部分更新指定 ResourceQuota 的状态 + + +#### HTTP 请求 + +PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}/status + + +#### 参数 + +- **name** (**路径参数**): string, 必需 + + ResourceQuota 的名称 + +- **namespace** (**路径参数**): string, 必需 + + }}">namespace + +- **body**: }}">Patch, 必需 + +- **dryRun** (**查询参数**): string + + }}">dryRun + +- **fieldManager** (**查询参数**): string + + }}">fieldManager + +- **fieldValidation** (**查询参数**): string + + }}">fieldValidation + +- **force** (**查询参数**): boolean + + }}">force + +- **pretty** (**查询参数**): string + + }}">pretty + + +#### 响应 + +200 (}}">ResourceQuota): OK + +201 (}}">ResourceQuota): Created + +401: Unauthorized + + +### `delete` 删除 ResourceQuota + + +#### HTTP 请求 + +DELETE /api/v1/namespaces/{namespace}/resourcequotas/{name} + + +#### 参数 + +- **name** (**路径参数**): string, 必需 + + ResourceQuota 的名称 + +- **namespace** (**路径参数**): string, 必需 + + }}">namespace + +- **body**: }}">DeleteOptions + +- **dryRun** (**查询参数**): string + + }}">dryRun + +- **gracePeriodSeconds** (**查询参数**): integer + + }}">gracePeriodSeconds + +- **pretty** (**查询参数**): string + + }}">pretty + +- **propagationPolicy** (**查询参数**): string + + }}">propagationPolicy + + +#### 响应 + +200 (}}">ResourceQuota): OK + +202 (}}">ResourceQuota): Accepted + +401: Unauthorized + + +### `deletecollection` 删除 ResourceQuota 的集合 + + +#### HTTP 请求 + +DELETE /api/v1/namespaces/{namespace}/resourcequotas + + +#### 参数 + +- **namespace** (**路径参数**): string, 必需 + + }}">namespace + +- **body**: }}">DeleteOptions + +- **continue** (**查询参数**): string + + }}">continue + +- **dryRun** (**查询参数**): string + + }}">dryRun + +- **fieldSelector** (**查询参数**): string + + }}">fieldSelector + +- **gracePeriodSeconds** (**查询参数**): integer + + }}">gracePeriodSeconds + +- **labelSelector** (**查询参数**): string + + }}">labelSelector + +- **limit** (**查询参数**): integer + + }}">limit + +- **pretty** (**查询参数**): string + + }}">pretty + +- **propagationPolicy** (**查询参数**): string + + }}">propagationPolicy + +- **resourceVersion** (**查询参数**): string + + }}">resourceVersion + +- **resourceVersionMatch** (**查询参数**): string + + }}">resourceVersionMatch + +- **timeoutSeconds** (**查询参数**): integer + + }}">timeoutSeconds + + +#### 响应 + +200 (}}">Status): OK + +401: Unauthorized +