Previous Topic: get_newobj_acl Method (user Object)Next Topic: list Method (quota Object)


quota Object

Use this object to control user and group grid resource usage using quota specifications.

Method

Description

config

Define and manage warning and burst default thresholds for the grid

list

List quota entries for users and groups

info

Details quota entries for a specified user or group

put

Set quota values for a user or a group

modify

Change quota data for a user or a group

config Method (quota Object)
Description

Display or set default warning and burst thresholds for the grid.

Syntax

Get threshold values:

/api/v1/quota/config?vdc=controller-name

Set threshold values:

/api/v1/quota/config?vdc=controller-name&warn=warning-level&burst=burst-level
Arguments
vdc

Name of the target virtual data center

warn

Percentage of the grid’s resources past which consumption a warning is issued. 0 disables warnings.

Limits: 0-99

burst

Percentage of the grid’s resources past which consumption a warning is issued. 0 disables resource usage beyond quota.

Notes:

  • The warning and burst levels defined for the grid only apply to users and groups that are not assigned specific values already.
  • These values are read-only, except for grid administrators.
Transaction Type

synchronous

Request Type

GET

Examples

Display default quota thresholds for a grid:

GET http://192.168.123.200/api/v1/quota/config?vdc=mygrid

Set the default warning threshold to 70%:

GET http://192.168.123.200/api/v1/quota/config?warn=70&vdc=mygrid
Sample Output
XML:
<quota_config>
  <burst>0</burst>
  <warn>75</warn>
</quota_config>
JSON:
{
   "quota_config" : {
      "warn" : "75",
      "burst" : "0"
   } 
} 

HTTP Error Codes
404

Entity vdc mygrid not found - A VDC name was specified that is not configured in the WS_API application.

400.7

Invalid value ‘value’ specified for ‘resource’ parameter - The value assigned to the warn or burst parameter is out of range.