eligible_services
Creates, updates, deletes, gets or lists an eligible_services resource.
Overview​
| Name | eligible_services |
| Type | Resource |
| Id | ovh.vrack.eligible_services |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
created_at | string | Creation date of the call (wire: createdAt) |
errors | array | List of services where an error has been encountered |
result | object | Eligible services for this vRack |
status | string | Status of the call |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | service_name | service_family | Returns, by service family, the services that can be attached to the vRack. The eligibility check runs asynchronously: the route can be called several times until all the eligible services are returned.<br /><br />While the status is set to pending the results are partial.<br /><br />Once the status is set to done, all the eligible services have been found.<br /><br />In the eventuality of errors getting specific service types, the errors will be listed in the errors field. |
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 | The internal name of your vrack (wire: serviceName) |
service_family | string | serviceFamily allows to filter on a specific service family (wire: serviceFamily) |
SELECT examples​
- get
Returns, by service family, the services that can be attached to the vRack. The eligibility check runs asynchronously: the route can be called several times until all the eligible services are returned.<br /><br />While the status is set to pending the results are partial.<br /><br />Once the status is set to done, all the eligible services have been found.<br /><br />In the eventuality of errors getting specific service types, the errors will be listed in the errors field.
SELECT
created_at,
errors,
result,
status
FROM ovh.vrack.eligible_services
WHERE service_name = '{{ service_name }}' -- required
AND service_family = '{{ service_family }}'
;