health
Creates, updates, deletes, gets or lists a health resource.
Overview​
| Name | health |
| Type | Resource |
| Id | ovh.dedicated_ceph.health |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
service_name | string | ID of cluster (wire: serviceName) |
available_bytes | integer | All available space in bytes (wire: availableBytes) |
healthy | boolean | True or False |
status | string | Status of ceph cluster |
total_bytes | integer | Total cluster space in bytes (wire: totalBytes) |
used_bytes | integer | Used cluster space in bytes (wire: usedBytes) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | service_name | Returns whether the cluster is working normally and how full it is. |
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 | Service name (wire: serviceName) |
SELECT examples​
- get
Returns whether the cluster is working normally and how full it is.
SELECT
service_name,
available_bytes,
healthy,
status,
total_bytes,
used_bytes
FROM ovh.dedicated_ceph.health
WHERE service_name = '{{ service_name }}' -- required
;