clusters

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

Overview

Name	clusters
Type	Resource
Id	ovh.dbaas_logs.clusters

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
cluster_id	string (uuid)	Cluster ID (wire: clusterId)
default_retention_id	string (uuid)	Retention ID used by default when none is given on new stream (wire: defaultRetentionId)
archive_allowed_networks	array	Allowed networks for ARCHIVE flow type (wire: archiveAllowedNetworks)
certification_level	string	Certification level of the given cluster (HDS, PCI_DSS, SNC, SOC2, STANDARD, TRUSTED_ZONE) (wire: certificationLevel)
cluster_type	string	Cluster type (DEDICATED, SHARED) (wire: clusterType)
dedicated_input_pem	string	PEM for dedicated inputs (wire: dedicatedInputPEM)
direct_input_allowed_networks	array	Allowed networks for DIRECT_INPUT flow type (wire: directInputAllowedNetworks)
direct_input_pem	string	PEM for direct inputs (wire: directInputPEM)
hostname	string	Hostname
is_default	boolean	All content generated by given service will be placed on this cluster (wire: isDefault)
is_unlocked	boolean	Allow given service to perform advanced operations on cluster (wire: isUnlocked)
query_allowed_networks	array	Allowed networks for QUERY flow type (wire: queryAllowedNetworks)
region	string	Data center localization (BHS, GRA, P-19, RBX, SBG)

list

Cluster

Name	Datatype	Description
cluster_id	string (uuid)	Cluster ID (wire: clusterId)
default_retention_id	string (uuid)	Retention ID used by default when none is given on new stream (wire: defaultRetentionId)
archive_allowed_networks	array	Allowed networks for ARCHIVE flow type (wire: archiveAllowedNetworks)
certification_level	string	Certification level of the given cluster (HDS, PCI_DSS, SNC, SOC2, STANDARD, TRUSTED_ZONE) (wire: certificationLevel)
cluster_type	string	Cluster type (DEDICATED, SHARED) (wire: clusterType)
dedicated_input_pem	string	PEM for dedicated inputs (wire: dedicatedInputPEM)
direct_input_allowed_networks	array	Allowed networks for DIRECT_INPUT flow type (wire: directInputAllowedNetworks)
direct_input_pem	string	PEM for direct inputs (wire: directInputPEM)
hostname	string	Hostname
is_default	boolean	All content generated by given service will be placed on this cluster (wire: isDefault)
is_unlocked	boolean	Allow given service to perform advanced operations on cluster (wire: isUnlocked)
query_allowed_networks	array	Allowed networks for QUERY flow type (wire: queryAllowedNetworks)
region	string	Data center localization (BHS, GRA, P-19, RBX, SBG)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	cluster_id, service_name		Returns the cluster.
list	select	service_name	name_pattern, x_pagination_mode	Returns the clusters of the Logs Data Platform service.
update	update	cluster_id, service_name		Updates the cluster.

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)
service_name	string	Service name (wire: serviceName)
name_pattern	string	Filter by name (like) (wire: namePattern)
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

Returns the cluster.

SELECT
cluster_id,
default_retention_id,
archive_allowed_networks,
certification_level,
cluster_type,
dedicated_input_pem,
direct_input_allowed_networks,
direct_input_pem,
hostname,
is_default,
is_unlocked,
query_allowed_networks,
region
FROM ovh.dbaas_logs.clusters
WHERE cluster_id = '{{ cluster_id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

Returns the clusters of the Logs Data Platform service.

SELECT
cluster_id,
default_retention_id,
archive_allowed_networks,
certification_level,
cluster_type,
dedicated_input_pem,
direct_input_allowed_networks,
direct_input_pem,
hostname,
is_default,
is_unlocked,
query_allowed_networks,
region
FROM ovh.dbaas_logs.clusters
WHERE service_name = '{{ service_name }}' -- required
AND name_pattern = '{{ name_pattern }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

UPDATE examples

update

Updates the cluster.

UPDATE ovh.dbaas_logs.clusters
SET 
archive_allowed_networks = '{{ archive_allowed_networks }}',
direct_input_allowed_networks = '{{ direct_input_allowed_networks }}',
query_allowed_networks = '{{ query_allowed_networks }}'
WHERE 
cluster_id = '{{ cluster_id }}' --required
AND service_name = '{{ service_name }}' --required
RETURNING
alias_id,
dashboard_id,
encryption_key_id,
index_id,
input_id,
operation_id,
osd_id,
role_id,
stream_id,
subscription_id,
tenant_id,
token_id,
service_name,
created_at,
state,
updated_at;