bursts
Creates, updates, deletes, gets or lists a bursts resource.
Overview​
| Name | bursts |
| Type | Resource |
| Id | ovh.dedicated_server.bursts |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
capacity | object | Bandwidth busrt capacity |
status | string | indicates whether burstable bandwidth is currently active, allowing it to temporarily exceed the normally included bandwidth.OvhToInternet amount, within the limits indicated by the burst.capacity item. It can also be inactiveLocked when temporarily disabled due to overuse, capping it to the included non-burstable bandwidth capacity of bandwidth.OvhToInternet (active, inactive, inactiveLocked) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | service_name | Get the bandwidth burst. Returns the burst status of the server bandwidth and its burst capacity. The status is active, inactive, or inactiveLocked when burst is temporarily disabled due to overuse. | |
update | update | service_name | Update the bandwidth burst. Updates the burst status of the server bandwidth. When active, the bandwidth can temporarily exceed the included OvhToInternet amount, within the burst capacity. |
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 dedicated server (wire: serviceName) |
SELECT examples​
- get
Get the bandwidth burst. Returns the burst status of the server bandwidth and its burst capacity. The status is active, inactive, or inactiveLocked when burst is temporarily disabled due to overuse.
SELECT
capacity,
status
FROM ovh.dedicated_server.bursts
WHERE service_name = '{{ service_name }}' -- required
;
UPDATE examples​
- update
Update the bandwidth burst. Updates the burst status of the server bandwidth. When active, the bandwidth can temporarily exceed the included OvhToInternet amount, within the burst capacity.
UPDATE ovh.dedicated_server.bursts
SET
status = '{{ status }}'
WHERE
service_name = '{{ service_name }}' --required;