openstack/barbican
Code Issues Proposed changes
b833108d5d
barbican/doc/source/api/reference/quotas.rst
jfwood b84434b845 Make 'url' references uppercase for consistency 
There are a few places in our documentation where we use lowercase
'url'. This CR changes those to 'URL' for consistency.

Change-Id: I509fd82f1a44bfbc819866a45aaffafb0192bc36
2016-08-16 16:31:56 -05:00

20 KiB
Raw Blame History

Quotas API - Reference

GET /v1/quotas

Get the effective quotas for the project of the requester. The project id of the requester is derived from the authentication token provided in the X-Auth-Token header.

Request/Response:

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
    }
  }

Response Attributes

Name Type Description
quotas dict Contains a dictionary with quota information
secrets integer Contains the effective quota value of the current project for the secret resource.
orders integer Contains the effective quota value of the current project for the orders resource.
containers integer Contains the effective quota value of the current project for the containers resource.
consumers integer Contains the effective quota value of the current project for the consumers resource.
cas integer Contains the effective quota value of the current project for the CAs resource.

Effective quota values are interpreted as follows:

Value Description

-1

 A negative value indicates the resource is unconstrained by a quota.

0

 A zero value indicates that the resource is disabled.
int A positive value indicates the maximum number of that resource that can be created for the current project.

HTTP Status Codes

Code Description
200 Successful Request
401 Invalid X-Auth-Token or the token doesn't have permissions to this resource

GET /v1/project-quotas

Gets a list of configured project quota records. Paging is supported using the optional parameters offset and limit.

Request/Response:

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,
  }

Parameters

Name Type Description
offset integer The starting index within the total list of the project quotas that you would like to receive.
limit integer The maximum number of records to return.

Response Attributes

Name Type Description
project-id string The UUID of a project with configured quota information.
project-quotas dict Contains a dictionary with project quota information.
secrets integer Contains the effective quota value of the current project for the secret resource.
orders integer Contains the effective quota value of the current project for the orders resource.
containers integer Contains the effective quota value of the current project for the containers resource.
consumers integer Contains the effective quota value of the current project for the consumers resource.
cas integer Contains the effective quota value of the current project for the CAs resource.
total integer The total number of configured project quotas records.
next string A HATEOAS URL to retrieve the next set of quotas based on the offset and limit parameters. This attribute is only available when the total number of secrets is greater than offset and limit parameter combined.
previous string A HATEOAS URL to retrieve the previous set of quotas based on the offset and limit parameters. This attribute is only available when the request offset is greater than 0.

Configured project quota values are interpreted as follows:

Value Description

-1

 A negative value indicates the resource is unconstrained by a quota.

0

 A zero value indicates that the resource is disabled.
int A positive value indicates the maximum number of that resource that can be created for the current project.
null A null value indicates that the default quota value for the resource will be used as the quota for this resource in the current project.

HTTP Status Codes

Code Description
200 Successful Request
401 Invalid X-Auth-Token or the token doesn't have permissions to this resource

GET /v1/project-quotas/{uuid}

Retrieves a project's configured project quota information.

Request/Response:

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
    }
  }

Response Attributes

Name Type Description
project-quotas dict Contains a dictionary with project quota information.
secrets integer Contains the configured quota value of the requested project for the secret resource.
orders integer Contains the configured quota value of the requested project for the orders resource.
containers integer Contains the configured quota value of the requested project for the containers resource.
consumers integer Contains the configured quota value of the requested project for the consumers resource.
cas integer Contains the configured quota value of the requested project for the CAs resource.

HTTP Status Codes

Code Description
200 Successful request
401 Invalid X-Auth-Token or the token doesn't have permissions to this resource
404 Not Found. The requested project does not have any configured quotas.

PUT /v1/project-quotas/{uuid}

Create or update the configured project quotas for the project with the specified UUID.

Request/Response:

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

Request Attributes

Attribute Name Type Description
project-quotas dict A dictionary with project quota information.
secrets integer The value to set for this project's secret quota.
orders integer The value to set for this project's order quota.
containers integer The value to set for this project's container quota.
consumers integer The value to set for this project's consumer quota.
cas integer The value to set for this project's CA quota.

Configured project quota values are specified as follows:

Value Description

-1

 A negative value indicates the resource is unconstrained by a quota.

0

 A zero value indicates that the resource is disabled.
int A positive value indicates the maximum number of that resource that can be created for the specified project.
If a value is not given for a resource, this indicates that the default quota should be used for that resource for the specified project.

HTTP Status Codes

Code Description
204 Successful request
400 Bad Request
401 Invalid X-Auth-Token or the token doesn't have permissions to this resource

DELETE /v1/project-quotas/{uuid}

Delete the project quotas configuration for the project with the requested UUID. When the project quota configuration is deleted, then the default quotas will be used for the specified project.

Request/Response:

Request:

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


Response:

  204 No Content

HTTP Status Codes

Code Description
204 Successful request
401 Invalid X-Auth-Token or the token doesn't have permissions to this resource
404 Not Found