instances_states
Creates, updates, deletes, gets or lists an instances_states resource.
Overview​
| Name | instances_states |
| Type | Resource |
| Id | ovh.ip_loadbalancing.instances_states |
Fields​
The following fields are returned by SELECT queries:
- list
A structure describing the current state of an IPLB instances
| Name | Datatype | Description |
|---|---|---|
internal_id | integer | Internal ID of this IPLB instance (wire: internalId) |
last_update_date | string (date-time) | Last update date (wire: lastUpdateDate) |
state | string | Current state of this IPLB instance |
zone | string | zone of this IPLB instance |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | service_name | Get the effective state of instances (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 | The internal name of your IP load balancing (wire: serviceName) |
SELECT examples​
- list
Get the effective state of instances (Deprecated, will be removed)
SELECT
internal_id,
last_update_date,
state,
zone
FROM ovh.ip_loadbalancing.instances_states
WHERE service_name = '{{ service_name }}' -- required
;