clickhouse_maintenances

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

Overview

Name	clickhouse_maintenances
Type	Resource
Id	ovh.public_cloud_analytics.clickhouse_maintenances

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string (uuid)	Unique identifier of the maintenance window
applied_at	string (date-time)	Date and time at which the maintenance was applied. Null when not yet applied. (wire: appliedAt)
checksum	string	Hash of the resource used for concurrency control
description	string	Human-readable description of the maintenance operations to be performed
scheduled_at	string (date-time)	Date and time at which the maintenance window is scheduled to start (wire: scheduledAt)
status	string	Current status of the maintenance window (APPLIED, APPLYING, ERROR, SCHEDULED)

list

A scheduled maintenance window for a managed database service

Name	Datatype	Description
id	string (uuid)	Unique identifier of the maintenance window
applied_at	string (date-time)	Date and time at which the maintenance was applied. Null when not yet applied. (wire: appliedAt)
checksum	string	Hash of the resource used for concurrency control
description	string	Human-readable description of the maintenance operations to be performed
scheduled_at	string (date-time)	Date and time at which the maintenance window is scheduled to start (wire: scheduledAt)
status	string	Current status of the maintenance window (APPLIED, APPLYING, ERROR, SCHEDULED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	maintenance_id, service_id, project_id		Returns the operations planned by a maintenance, its schedule and its status. (Beta version)
list	select	service_id, project_id	x_pagination_cursor, x_pagination_size	Returns the maintenances of the service, with their schedule and status. (Beta version)
create	insert	service_id, project_id		Applies a scheduled maintenance immediately, instead of waiting for its scheduled time. (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"}})
maintenance_id	string (uuid)	Maintenance ID (wire: maintenanceId)
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 operations planned by a maintenance, its schedule and its status. (Beta version)

SELECT
id,
applied_at,
checksum,
description,
scheduled_at,
status
FROM ovh.public_cloud_analytics.clickhouse_maintenances
WHERE maintenance_id = '{{ maintenance_id }}' -- required
AND service_id = '{{ service_id }}' -- required
AND project_id = '{{ project_id }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

Returns the maintenances of the service, with their schedule and status. (Beta version)

SELECT
id,
applied_at,
checksum,
description,
scheduled_at,
status
FROM ovh.public_cloud_analytics.clickhouse_maintenances
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 }}'
;

INSERT examples

create

Applies a scheduled maintenance immediately, instead of waiting for its scheduled time. (Beta version)

INSERT INTO ovh.public_cloud_analytics.clickhouse_maintenances (
service_id,
project_id
)
SELECT 
'{{ service_id }}',
'{{ project_id }}'
RETURNING
id,
applied_at,
checksum,
description,
scheduled_at,
status
;

Manifest

# Description fields are for documentation purposes
- name: clickhouse_maintenances
props:
  - name: service_id
    value: "{{ service_id }}"
    description: Required parameter for the clickhouse_maintenances resource.
  - name: project_id
    value: "{{ project_id }}"
    description: Required parameter for the clickhouse_maintenances resource.