opensearch_nodes

Creates, updates, deletes, gets or lists an opensearch_nodes resource.

Overview

Name	opensearch_nodes
Type	Resource
Id	ovh.cloud_database.opensearch_nodes

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string (uuid)	Node ID
name	string	Name of the node
created_at	string (date-time)	Date of the creation of the node (wire: createdAt)
flavor	string	Flavor of the node
port	integer	Connection port for the node
region	string	Region of the node
role	string	Role of the node (ANALYTICS, STANDARD)
status	string	Current status of the node (CREATING, DELETING, DRAINED, ERROR, LOCKED, LOCKED_PENDING, LOCKED_UPDATING, PENDING, READY, SHELVED, TO_DRAIN, UPDATING)

list

Cloud databases cluster node definition

Name	Datatype	Description
id	string (uuid)	Node ID
name	string	Name of the node
created_at	string (date-time)	Date of the creation of the node (wire: createdAt)
flavor	string	Flavor of the node
port	integer	Connection port for the node
region	string	Region of the node
role	string	Role of the node (ANALYTICS, STANDARD)
status	string	Current status of the node (CREATING, DELETING, DRAINED, ERROR, LOCKED, LOCKED_PENDING, LOCKED_UPDATING, PENDING, READY, SHELVED, TO_DRAIN, UPDATING)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	cluster_id, node_id, service_name		Get opensearch nodes
list	select	cluster_id, service_name	x_pagination_mode	List nodes of the opensearch

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)
node_id	string (uuid)	Node ID (wire: nodeId)
service_name	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
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

Get opensearch nodes

SELECT
id,
name,
created_at,
flavor,
port,
region,
role,
status
FROM ovh.cloud_database.opensearch_nodes
WHERE cluster_id = '{{ cluster_id }}' -- required
AND node_id = '{{ node_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

List nodes of the opensearch

SELECT
id,
name,
created_at,
flavor,
port,
region,
role,
status
FROM ovh.cloud_database.opensearch_nodes
WHERE cluster_id = '{{ cluster_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
AND x_pagination_mode = '{{ x_pagination_mode }}'
;