cluster_retentions
Creates, updates, deletes, gets or lists a cluster_retentions resource.
Overview​
| Name | cluster_retentions |
| Type | Resource |
| Id | ovh.dbaas_logs.cluster_retentions |
Fields​
The following fields are returned by SELECT queries:
- get
- list
successful operation
| Name | Datatype | Description |
|---|---|---|
retention_id | string (uuid) | Retention ID (wire: retentionId) |
duration | string (duration) | Indexed duration expressed in ISO-8601 format |
is_supported | boolean | Indicates if a new stream can use it (wire: isSupported) |
retention_type | string | Retention type (LOGS_COLD_STORAGE, LOGS_INDEXING, METRICS_TENANT) (wire: retentionType) |
Cluster retention
| Name | Datatype | Description |
|---|---|---|
retention_id | string (uuid) | Retention ID (wire: retentionId) |
duration | string (duration) | Indexed duration expressed in ISO-8601 format |
is_supported | boolean | Indicates if a new stream can use it (wire: isSupported) |
retention_type | string | Retention type (LOGS_COLD_STORAGE, LOGS_INDEXING, METRICS_TENANT) (wire: retentionType) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | cluster_id, retention_id, service_name | Returns the cluster retention. | |
list | select | cluster_id, service_name | x_pagination_mode | Returns the cluster retentions of the Logs Data Platform service. |
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"}}) |
cluster_id | string (uuid) | Cluster ID (wire: clusterId) |
retention_id | string (uuid) | Retention ID (wire: retentionId) |
service_name | string | Service name (wire: serviceName) |
x_pagination_mode | string | Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode) |
SELECT examples​
- get
- list
Returns the cluster retention.
SELECT
retention_id,
duration,
is_supported,
retention_type
FROM ovh.dbaas_logs.cluster_retentions
WHERE cluster_id = '{{ cluster_id }}' -- required
AND retention_id = '{{ retention_id }}' -- required
AND service_name = '{{ service_name }}' -- required
;
Returns the cluster retentions of the Logs Data Platform service.
SELECT
retention_id,
duration,
is_supported,
retention_type
FROM ovh.dbaas_logs.cluster_retentions
WHERE cluster_id = '{{ cluster_id }}' -- required
AND service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;