opensearch_indices

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

Overview

Name	opensearch_indices
Type	Resource
Id	ovh.public_cloud_analytics.opensearch_indices

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string (uuid)	Unique identifier of the index
name	string	Name of the OpenSearch index
checksum	string	Hash of the resource used for concurrency control
created_at	string (date-time)	Date at which the index was created (wire: createdAt)
document_count	integer	Number of documents stored in this index (wire: documentCount)
replica_count	integer	Number of replica shards for this index (wire: replicaCount)
shard_count	integer	Number of primary shards for this index (wire: shardCount)
size	integer	Total size of the index in bytes

list

An OpenSearch index on a managed OpenSearch service

Name	Datatype	Description
id	string (uuid)	Unique identifier of the index
name	string	Name of the OpenSearch index
checksum	string	Hash of the resource used for concurrency control
created_at	string (date-time)	Date at which the index was created (wire: createdAt)
document_count	integer	Number of documents stored in this index (wire: documentCount)
replica_count	integer	Number of replica shards for this index (wire: replicaCount)
shard_count	integer	Number of primary shards for this index (wire: shardCount)
size	integer	Total size of the index in bytes

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	index_id, service_id, project_id		Returns the document count, the size in bytes and the primary and replica shard counts of the index. (Beta version)
list	select	service_id, project_id	x_pagination_cursor, x_pagination_size	Returns the indexes of the service with their document count, size and shards. (Beta version)

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"}})
index_id	string (uuid)	Index ID (wire: indexId)
project_id	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
service_id	string (uuid)	Service ID (wire: serviceId)
x_pagination_cursor	string	Pagination cursor (wire: X-Pagination-Cursor)
x_pagination_size	integer	Pagination size (wire: X-Pagination-Size)

SELECT examples

get

Returns the document count, the size in bytes and the primary and replica shard counts of the index. (Beta version)

SELECT
id,
name,
checksum,
created_at,
document_count,
replica_count,
shard_count,
size
FROM ovh.public_cloud_analytics.opensearch_indices
WHERE index_id = '{{ index_id }}' -- required
AND service_id = '{{ service_id }}' -- required
AND project_id = '{{ project_id }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

Returns the indexes of the service with their document count, size and shards. (Beta version)

SELECT
id,
name,
checksum,
created_at,
document_count,
replica_count,
shard_count,
size
FROM ovh.public_cloud_analytics.opensearch_indices
WHERE service_id = '{{ service_id }}' -- required
AND project_id = '{{ project_id }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
AND x_pagination_cursor = '{{ x_pagination_cursor }}'
AND x_pagination_size = '{{ x_pagination_size }}'
;