robots
Creates, updates, deletes, gets or lists a robots resource.
Overview​
| Name | robots |
| Type | Resource |
| Id | ovh.dedicated_cloud.robots |
Fields​
The following fields are returned by SELECT queries:
- get
- list
successful operation
| Name | Datatype | Description |
|---|---|---|
name | string | The name of this robot |
criticity | string | The criticity of this robot |
description | string | Description of this robot |
enabled | boolean | Is this robot enabled |
type | string | The type of this robot |
Robot
| Name | Datatype | Description |
|---|---|---|
name | string | The name of this robot |
criticity | string | The criticity of this robot |
description | string | Description of this robot |
enabled | boolean | Is this robot enabled |
type | string | The type of this robot |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | name, service_name | Get a robot | |
list | select | service_name | x_pagination_mode | List robots |
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"}}) |
name | string | The name of this robot |
service_name | string | Domain of the service (wire: serviceName) |
x_pagination_mode | string | Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode) |
SELECT examples​
- get
- list
Get a robot
SELECT
name,
criticity,
description,
enabled,
type
FROM ovh.dedicated_cloud.robots
WHERE name = '{{ name }}' -- required
AND service_name = '{{ service_name }}' -- required
;
List robots
SELECT
name,
criticity,
description,
enabled,
type
FROM ovh.dedicated_cloud.robots
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;