statuses
Creates, updates, deletes, gets or lists a statuses resource.
Overview​
| Name | statuses |
| Type | Resource |
| Id | ovh.vps.statuses |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
dns | object | Port and state of a service on an IP |
http | object | Port and state of a service on an IP |
https | object | Port and state of a service on an IP |
ping | string | Possible states of a service (ping, port) (down, up) |
smtp | object | Port and state of a service on an IP |
ssh | object | Port and state of a service on an IP |
tools | string | Possible states of a service (ping, port) (down, up) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | service_name | 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) |
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"}}) |
service_name | string | Service name (wire: serviceName) |
SELECT examples​
- get
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
;