Skip to main content

quotas

Creates, updates, deletes, gets or lists a quotas resource.

Overview​

Namequotas
TypeResource
Idovh.ip_loadbalancing.quotas

Fields​

The following fields are returned by SELECT queries:

successful operation

NameDatatypeDescription
alertintegerQuota alert value in bytes. When reached, we will send you an alert. Default : included quota with your offer
includedintegerIncluded quota value with your offer, in bytes
last_update_datestring (date-time)The last time your quota was updated from your Load Balancer instance (wire: lastUpdateDate)
reset_datestring (date-time)The last time your quota was resetted (billed) (wire: resetDate)
totalintegerTotal used quota value in bytes
zonestringZone of your quota

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectservice_name, zoneGet a zone quota
listselectservice_namex_pagination_modeList quotas per zone
updateupdateservice_name, zoneUpdate 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.

NameDatatypeDescription
api_hoststringThe 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_namestringThe internal name of your IP load balancing (wire: serviceName)
zonestringZone of your quota
x_pagination_modestringSent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples​

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
;

UPDATE examples​

Update a zone quota

UPDATE ovh.ip_loadbalancing.quotas
SET
alert = {{ alert }}
WHERE
service_name = '{{ service_name }}' --required
AND zone = '{{ zone }}' --required;