orderable_bandwidths
Creates, updates, deletes, gets or lists an orderable_bandwidths resource.
Overview​
| Name | orderable_bandwidths |
| Type | Resource |
| Id | ovh.dedicated_server.orderable_bandwidths |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
orderable | boolean | Is bandwidth orderable for this server |
platinum | array | Bandwidth "platinum" orderable in mbps |
premium | array | Bandwidth "premium" orderable in mbps |
ultimate | array | Bandwidth "ultimate" orderable in mbps |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | service_name | Get orderable bandwidth. Returns whether bandwidth can be ordered for the server and the orderable premium, platinum and ultimate bandwidths in Mbps. |
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 orderable bandwidth. Returns whether bandwidth can be ordered for the server and the orderable premium, platinum and ultimate bandwidths in Mbps.
SELECT
orderable,
platinum,
premium,
ultimate
FROM ovh.dedicated_server.orderable_bandwidths
WHERE service_name = '{{ service_name }}' -- required
;