Skip to main content

hds

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

Overview​

Namehds
TypeResource
Idovh.dedicated_cloud.hds

Fields​

The following fields are returned by SELECT queries:

successful operation

NameDatatypeDescription
statestringState of the option (disabled, disabling, enabled, enabling, error, migrating, unknown)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectservice_nameGet the HDS option

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_namestringDomain of the service (wire: serviceName)

SELECT examples​

Get the HDS option

SELECT
state
FROM ovh.dedicated_cloud.hds
WHERE service_name = '{{ service_name }}' -- required
;