配额 API - 参考

GET /v1/quotas

获取请求者的项目的有效配额。请求者的项目 ID 从 X-Auth-Token 标头提供的身份验证令牌中派生。

请求/响应:

Request:

  GET /v1/quotas
  Headers:
    X-Auth-Token:<token>
    Accept: application/json


Response:

  HTTP/1.1 200 OK
  Content-Type: application/json

  {
    "quotas": {
      "secrets": 10,
      "orders": 20,
      "containers": 10,
      "consumers": -1,
      "cas": 5
    }
  }

响应属性

名称	类型	描述
quotas	dict	包含配额信息的字典
secrets	整数	包含当前项目针对 secret 资源的有效配额值。
orders	整数	包含当前项目针对 orders 资源的有效配额值。
containers	整数	包含当前项目针对 containers 资源的有效配额值。
consumers	整数	包含当前项目针对 consumers 资源的有效配额值。
cas	整数	包含当前项目针对 CA 资源的有效配额值。

有效配额值的解释如下

值	描述
-1	负值表示资源不受配额限制。
0	零值表示资源已禁用。
int	正值表示当前项目可以创建该资源的最大数量。

HTTP 状态码

代码	描述
200	成功请求
401	无效的 X-Auth-Token 或令牌没有访问此资源的权限

GET /v1/project-quotas

获取配置的项目配额记录列表。使用可选参数 offset 和 limit 支持分页。

请求/响应:

Request:

  GET /v1/project-quotas
  Headers:
    X-Auth-Token:<token>
    Accept: application/json

Response:

  200 OK

  Content-Type: application/json

  {
    "project_quotas": [
      {
        "project_id": "1234",
        "project_quotas": {
             "secrets": 2000,
             "orders": 0,
             "containers": -1,
             "consumers": null,
             "cas": null
         }
      },
      {
        "project_id": "5678",
        "project_quotas": {
             "secrets": 200,
             "orders": 100,
             "containers": -1,
             "consumers": null,
             "cas": null
         }
      },
    ],
    "total" : 30,
  }

参数

名称	类型	描述
offset	整数	您希望接收的项目配额总列表中的起始索引。
limit	整数	要返回的最大记录数。

响应属性

名称	类型	描述
project-id	字符串	具有配置配额信息的项目的 UUID。
project-quotas	dict	包含项目配额信息的字典。
secrets	整数	包含当前项目针对 secret 资源的有效配额值。
orders	整数	包含当前项目针对 orders 资源的有效配额值。
containers	整数	包含当前项目针对 containers 资源的有效配额值。
consumers	整数	包含当前项目针对 consumers 资源的有效配额值。
cas	整数	包含当前项目针对 CA 资源的有效配额值。
total	整数	配置的项目配额记录总数。
下一个	字符串	一个 HATEOAS URL，用于根据 offset 和 limit 参数检索下一组配额。只有在 secrets 总数大于 offset 和 limit 参数组合时，此属性才可用。
previous	字符串	一个 HATEOAS URL，用于根据 offset 和 limit 参数检索上一组配额。只有在请求 offset 大于 0 时，此属性才可用。

配置的项目配额值的解释如下

值	描述
-1	负值表示资源不受配额限制。
0	零值表示资源已禁用。
int	正值表示当前项目可以创建该资源的最大数量。
null	null 值表示将使用资源的默认配额值作为当前项目中的配额。

HTTP 状态码

代码	描述
200	成功请求
401	无效的 X-Auth-Token 或令牌没有访问此资源的权限

GET /v1/project-quotas/{uuid}

检索项目的配置项目配额信息。

请求/响应:

Request:

  GET /v1/project-quotas/{uuid}
  Headers:
    X-Auth-Token:<token>
    Accept: application/json


Response:

  200 OK

  Content-Type: application/json

  {
    "project_quotas": {
      "secrets": 10,
      "orders": 20,
      "containers": -1,
      "consumers": 10,
      "cas": 5
    }
  }

响应属性

名称	类型	描述
project-quotas	dict	包含项目配额信息的字典。
secrets	整数	包含请求项目针对 secret 资源的配置配额值。
orders	整数	包含请求项目针对 orders 资源的配置配额值。
containers	整数	包含请求项目针对 containers 资源的配置配额值。
consumers	整数	包含请求项目针对 consumers 资源的配置配额值。
cas	整数	包含请求项目针对 CA 资源的配置配额值。

HTTP 状态码

代码	描述
200	成功请求
401	无效的 X-Auth-Token 或令牌没有访问此资源的权限
404	未找到。请求的项目没有配置任何配额。

PUT /v1/project-quotas/{uuid}

创建或更新具有指定 UUID 的项目的配置项目配额。

请求/响应:

Request:

  PUT /v1/project-quotas/{uuid}
  Headers:
    X-Auth-Token:<token>
    Content-Type: application/json

  Body::

    {
      "project_quotas": {
        "secrets": 50,
        "orders": 10,
        "containers": 20
      }
    }


Response:

  204 OK

请求属性

属性名称	类型	描述
project-quotas	dict	包含项目配额信息的字典。
secrets	整数	要设置为此项目 secret 配额的值。
orders	整数	要设置为此项目 order 配额的值。
containers	整数	要设置为此项目 container 配额的值。
consumers	整数	要设置为此项目 consumer 配额的值。
cas	整数	要设置为此项目 CA 配额的值。

配置的项目配额值指定如下

值	描述
-1	负值表示资源不受配额限制。
0	零值表示资源已禁用。
int	正值表示指定项目可以创建该资源的最大数量。
	如果未为资源提供值，则表示应将默认配额用于指定项目的该资源。

HTTP 状态码

代码	描述
204	成功请求
400	错误请求
401	无效的 X-Auth-Token 或令牌没有访问此资源的权限

DELETE /v1/project-quotas/{uuid}

删除请求 UUID 对应的项目的配额配置。删除项目配额配置后，将对指定项目使用默认配额。

请求/响应:

Request:

  DELETE v1/project-quotas/{uuid}
  Headers:
    X-Auth-Token:<token>


Response:

  204 No Content

HTTP 状态码

代码	描述
204	成功请求
401	无效的 X-Auth-Token 或令牌没有访问此资源的权限
404	未找到