Skip to main content

mysql_prometheuses

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

Overview​

Namemysql_prometheuses
TypeResource
Idovh.cloud_database.mysql_prometheuses

Fields​

The following fields are returned by SELECT queries:

successful operation

NameDatatypeDescription
targetsarrayEndpoint target for Prometheus
usernamestringName of the Prometheus access

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectcluster_id, service_nameGet the endpoint for Mysql cluster Prometheus
credentials_resetexecclusterId, service_nameReset the password of a Prometheus

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.

NameDatatypeDescription
api_hoststringThe 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"}})
clusterIdstring (uuid)Cluster ID
cluster_idstring (uuid)Cluster ID (wire: clusterId)
service_namestringThe Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.

SELECT examples​

Get the endpoint for Mysql cluster Prometheus

SELECT
targets,
username
FROM ovh.cloud_database.mysql_prometheuses
WHERE cluster_id = '{{ cluster_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

Lifecycle Methods​

EXEC variables use wire (API) names.

Reset the password of a Prometheus

EXEC ovh.cloud_database.mysql_prometheuses.credentials_reset
@clusterId='{{ clusterId }}' --required,
@service_name='{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
;