Skip to main content

statuses

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

Overview​

Namestatuses
TypeResource
Idovh.vps.statuses

Fields​

The following fields are returned by SELECT queries:

successful operation

NameDatatypeDescription
dnsobjectPort and state of a service on an IP
httpobjectPort and state of a service on an IP
httpsobjectPort and state of a service on an IP
pingstringPossible states of a service (ping, port) (down, up)
smtpobjectPort and state of a service on an IP
sshobjectPort and state of a service on an IP
toolsstringPossible states of a service (ping, port) (down, up)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectservice_nameReturns the status of the DNS, HTTP, HTTPS, ping, SMTP, SSH and tools checks of the main IP of the VPS. (Deprecated, will be removed)

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"}})
service_namestringService name (wire: serviceName)

SELECT examples​

Returns the status of the DNS, HTTP, HTTPS, ping, SMTP, SSH and tools checks of the main IP of the VPS. (Deprecated, will be removed)

SELECT
dns,
http,
https,
ping,
smtp,
ssh,
tools
FROM ovh.vps.statuses
WHERE service_name = '{{ service_name }}' -- required
;