quotas
Creates, updates, deletes, gets or lists a quotas resource.
Overview​
| Name | quotas |
| Type | Resource |
| Id | ovh.ip_loadbalancing.quotas |
Fields​
The following fields are returned by SELECT queries:
- get
- list
successful operation
| Name | Datatype | Description |
|---|---|---|
alert | integer | Quota alert value in bytes. When reached, we will send you an alert. Default : included quota with your offer |
included | integer | Included quota value with your offer, in bytes |
last_update_date | string (date-time) | The last time your quota was updated from your Load Balancer instance (wire: lastUpdateDate) |
reset_date | string (date-time) | The last time your quota was resetted (billed) (wire: resetDate) |
total | integer | Total used quota value in bytes |
zone | string | Zone of your quota |
Quota informations for current billing period for this zone
| Name | Datatype | Description |
|---|---|---|
alert | integer | Quota alert value in bytes. When reached, we will send you an alert. Default : included quota with your offer |
included | integer | Included quota value with your offer, in bytes |
last_update_date | string (date-time) | The last time your quota was updated from your Load Balancer instance (wire: lastUpdateDate) |
reset_date | string (date-time) | The last time your quota was resetted (billed) (wire: resetDate) |
total | integer | Total used quota value in bytes |
zone | string | Zone of your quota |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | service_name, zone | Get a zone quota | |
list | select | service_name | x_pagination_mode | List quotas per zone |
update | update | service_name, zone | Update a zone quota |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
api_host | string | The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}}) |
service_name | string | The internal name of your IP load balancing (wire: serviceName) |
zone | string | Zone of your quota |
x_pagination_mode | string | Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode) |
SELECT examples​
- get
- list
Get a zone quota
SELECT
alert,
included,
last_update_date,
reset_date,
total,
zone
FROM ovh.ip_loadbalancing.quotas
WHERE service_name = '{{ service_name }}' -- required
AND zone = '{{ zone }}' -- required
;
List quotas per zone
SELECT
alert,
included,
last_update_date,
reset_date,
total,
zone
FROM ovh.ip_loadbalancing.quotas
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;
UPDATE examples​
- update
Update a zone quota
UPDATE ovh.ip_loadbalancing.quotas
SET
alert = {{ alert }}
WHERE
service_name = '{{ service_name }}' --required
AND zone = '{{ zone }}' --required;