Workload Quotas

get
List Quota Types
https://$(tvm_address):8780/v1/$(tenant_id)/projects_quota_types
Lists all available Quota Types
Request
Response
Request
Path Parameters
tvm_address
required
string
IP or FQDN of TrilioVault service
tenant_id
required
string
ID of Tenant/Project
Headers
X-Auth-Project-Id
required
string
Project to authenticate against
X-Auth-Token
required
string
Authentication token to use
Accept
required
string
application/json
User-Agent
optional
string
python-workloadmgrclient
Response
200: OK
Provides the list of available Quota Types
HTTP/1.1 200 OK
Server: nginx/1.16.1
Date: Wed, 18 Nov 2020 15:40:56 GMT
Content-Type: application/json
Content-Length: 1625
Connection: keep-alive
X-Compute-Request-Id: req-2ad95c02-54c6-4908-887b-c16c5e2f20fe
​
{
   "quota_types":[
      {
         "created_at":"2020-10-19T10:05:52.000000",
         "updated_at":"2020-10-19T10:07:32.000000",
         "deleted_at":null,
         "deleted":false,
         "version":"4.0.115",
         "id":"1c5d4290-2e08-11ea-889c-7440bb00b67d",
         "display_name":"Workloads",
         "display_description":"Total number of workload creation allowed per project",
         "status":"available"
      },
      {
         "created_at":"2020-10-19T10:05:52.000000",
         "updated_at":"2020-10-19T10:07:32.000000",
         "deleted_at":null,
         "deleted":false,
         "version":"4.0.115",
         "id":"b7273a06-2e08-11ea-889c-7440bb00b67d",
         "display_name":"Snapshots",
         "display_description":"Total number of snapshot creation allowed per project",
         "status":"available"
      },
      {
         "created_at":"2020-10-19T10:05:52.000000",
         "updated_at":"2020-10-19T10:07:32.000000",
         "deleted_at":null,
         "deleted":false,
         "version":"4.0.115",
         "id":"be323f58-2e08-11ea-889c-7440bb00b67d",
         "display_name":"VMs",
         "display_description":"Total number of VMs allowed per project",
         "status":"available"
      },
      {
         "created_at":"2020-10-19T10:05:52.000000",
         "updated_at":"2020-10-19T10:07:32.000000",
         "deleted_at":null,
         "deleted":false,
         "version":"4.0.115",
         "id":"c61324d0-2e08-11ea-889c-7440bb00b67d",
         "display_name":"Volumes",
         "display_description":"Total number of volume attachments allowed per project",
         "status":"available"
      },
      {
         "created_at":"2020-10-19T10:05:52.000000",
         "updated_at":"2020-10-19T10:07:32.000000",
         "deleted_at":null,
         "deleted":false,
         "version":"4.0.115",
         "id":"f02dd7a6-2e08-11ea-889c-7440bb00b67d",
         "display_name":"Storage",
         "display_description":"Total storage (in Bytes) allowed per project",
         "status":"available"
      }
   ]
}
get
Show Quota Type
https://$(tvm_address):8780/v1/$(tenant_id)/projects_quota_types/<quota_type_id>
Requests the details of a Quota Type
Request
Response
Request
Path Parameters
tvm_address
required
string
IP or FQDN of TrilioVault service
tenant_id
required
string
ID of Tenant/Project to work in
quota_type_id
required
string
ID of the Quota Type to show
Headers
X-Auth-Project-Id
required
string
Project to authenticate against
X-Auth-Token
required
string
Authentication token to use
Accept
required
string
application/json
User-Agent
optional
string
python-workloadmgrclient
Response
200: OK
Returns details for the Quota Type
HTTP/1.1 200 OK
Server: nginx/1.16.1
Date: Wed, 18 Nov 2020 15:44:43 GMT
Content-Type: application/json
Content-Length: 342
Connection: keep-alive
X-Compute-Request-Id: req-5bf629fe-ffa2-4c90-b704-5178ba2ab09b
​
{
   "quota_type":{
      "created_at":"2020-10-19T10:05:52.000000",
      "updated_at":"2020-10-19T10:07:32.000000",
      "deleted_at":null,
      "deleted":false,
      "version":"4.0.115",
      "id":"1c5d4290-2e08-11ea-889c-7440bb00b67d",
      "display_name":"Workloads",
      "display_description":"Total number of workload creation allowed per project",
      "status":"available"
   }
}
post
Create allowed Quota
https://$(tvm_address):8780/v1/$(tenant_id)/project_allowed_quotas/<project_id>
Creates an allowed Quota with the given parameters
Request
Response
Request
Path Parameters
tvm_address
optional
string
IP or FQDN of TrilioVault service
tenant_id
required
string
ID of the Tenant/Project to work in 
project_id
required
string
ID of the Tenant/Project to create the allowed Quota in
Headers
X-Auth-Project-Id
required
string
Project to authenticate against
X-Auth-Token
required
string
Authentication token to use
Content-Type
required
string
application/json
Accept
required
string
application/json
User-Agent
optional
string
python-workloadmgrclient
Response
200: OK
Allowed Quota has been created
HTTP/1.1 200 OK
Server: nginx/1.16.1
Date: Wed, 18 Nov 2020 15:51:51 GMT
Content-Type: application/json
Content-Length: 24
Connection: keep-alive
X-Compute-Request-Id: req-08c8cdb6-b249-4650-91fb-79a6f7497927
​
{
   "allowed_quotas":[
      {
         
      }
   ]
}
Body Format
{
   "allowed_quotas":[
      {
         "project_id":"<project_id>",
         "quota_type_id":"<quota_type_id>",
         "allowed_value":"<integer>",
         "high_watermark":"<Integer>"
      }
   ]
}
get
List allowed Quota
https://$(tvm_address):8780/v1/$(tenant_id)/project_allowed_quotas/<project_id>
Lists all allowed Quotas for a given project.
Request
Response
Request
Path Parameters
tvm_address
optional
string
IP or FQDN of TrilioVault service
tenant_id
required
string
ID of the Tenant/Project to work in 
project_id
required
string
ID of the Tenant/Project to list allowed Quotas from
Headers
X-Auth-Project-Id
required
string
Project to authenticate against
X-Auth-Token
required
string
Authentication token to use
Accept
required
string
application/json
User-Agent
optional
string
python-workloadmgrclient
Response
200: OK
Returns list of allowed quotas for a given project
HTTP/1.1 200 OK
Server: nginx/1.16.1
Date: Wed, 18 Nov 2020 16:01:39 GMT
Content-Type: application/json
Content-Length: 766
Connection: keep-alive
X-Compute-Request-Id: req-e570ce15-de0d-48ac-a9e8-60af429aebc0
​
{
   "allowed_quotas":[
      {
         "id":"262b117d-e406-4209-8964-004b19a8d422",
         "project_id":"c76b3355a164498aa95ddbc960adc238",
         "quota_type_id":"1c5d4290-2e08-11ea-889c-7440bb00b67d",
         "allowed_value":5,
         "high_watermark":4,
         "version":"4.0.115",
         "quota_type_name":"Workloads"
      },
      {
         "id":"68e7203d-8a38-4776-ba58-051e6d289ee0",
         "project_id":"c76b3355a164498aa95ddbc960adc238",
         "quota_type_id":"f02dd7a6-2e08-11ea-889c-7440bb00b67d",
         "allowed_value":-1,
         "high_watermark":-1,
         "version":"4.0.115",
         "quota_type_name":"Storage"
      },
      {
         "id":"ed67765b-aea8-4898-bb1c-7c01ecb897d2",
         "project_id":"c76b3355a164498aa95ddbc960adc238",
         "quota_type_id":"be323f58-2e08-11ea-889c-7440bb00b67d",
         "allowed_value":50,
         "high_watermark":25,
         "version":"4.0.115",
         "quota_type_name":"VMs"
      }
   ]
}
get
Show allowed Quota
https://$(tvm_address):8780/v1/$(tenant_id)/project_allowed_quota/<allowed_quota_id>
Shows details for a given allowed Quota
Request
Response
Request
Path Parameters
tvm_address
optional
string
IP or FQDN of TrilioVault service
tenant_id
required
string
ID of the Tenant/Project to work in 
<allowed_quota_id>
required
string
ID of the allowed Quota to show
Headers
X-Auth-Project-Id
required
string
Project to authenticate against
X-Auth-Token
required
string
Authentication token to use
Accept
required
string
application/json
User-Agent
optional
string
python-workloadmgrclient
Response
200: OK
HTTP/1.1 200 OK
Server: nginx/1.16.1
Date: Wed, 18 Nov 2020 16:15:07 GMT
Content-Type: application/json
Content-Length: 268
Connection: keep-alive
X-Compute-Request-Id: req-d87a57cd-c14c-44dd-931e-363158376cb7
​
{
   "allowed_quotas":{
      "id":"262b117d-e406-4209-8964-004b19a8d422",
      "project_id":"c76b3355a164498aa95ddbc960adc238",
      "quota_type_id":"1c5d4290-2e08-11ea-889c-7440bb00b67d",
      "allowed_value":5,
      "high_watermark":4,
      "version":"4.0.115",
      "quota_type_name":"Workloads"
   }
}
put
Update allowed Quota
https://$(tvm_address):8780/v1/$(tenant_id)/update_allowed_quota/<allowed_quota_id>
Updates an allowed Quota with the given parameters
Request
Response
Request
Path Parameters
tvm_address
optional
string
IP or FQDN of TrilioVault service
tenant_id
required
string
ID of the Tenant/Project to work in 
<allowed_quota_id>
required
string
ID of the allowed Quota to update
Headers
X-Auth-Project-Id
required
string
Project to authenticate against
X-Auth-Token
required
string
Authentication token to use
Content-Type
required
string
application/json
Accept
required
string
application/json
User-Agent
optional
string
python-workloadmgrclient
Response
202: Accepted
Quota Update has been done
HTTP/1.1 202 Accepted
Server: nginx/1.16.1
Date: Wed, 18 Nov 2020 16:24:04 GMT
Content-Type: application/json
Content-Length: 24
Connection: keep-alive
X-Compute-Request-Id: req-a4c02ee5-b86e-4808-92ba-c363b287f1a2
​
{"allowed_quotas": [{}]}
Body Format
{
   "allowed_quotas":{
      "project_id":"c76b3355a164498aa95ddbc960adc238",
      "allowed_value":"20000",
      "high_watermark":"18000"
   }
}
delete
Delete allowed Quota
https://$(tvm_address):8780/v1/$(tenant_id)/project_allowed_quotas/<allowed_quota_id>
Deletes a given allowed Quota
Request
Response
Request
Path Parameters
tvm_address
optional
string
IP or FQDN of TrilioVault service
tenant_id
required
string
ID of the Tenant/Project to work in 
<allowed_quota_id>
required
string
ID of the allowed Quota to delete
Headers
X-Auth-Project-Id
required
string
Project to authenticate against
X-Auth-Token
required
string
Authentication token to use
Accept
required
string
application/json
User-Agent
optional
string
python-workloadmgrclient
Response
202: Accepted
Allowed quota gots deleted
HTTP/1.1 202 Accepted
Server: nginx/1.16.1
Date: Wed, 18 Nov 2020 16:33:09 GMT
Content-Type: text/html; charset=UTF-8
Content-Length: 0
Connection: keep-alive