housings
Creates, updates, deletes, gets or lists a housings resource.
Overview​
| Name | housings |
| Type | Resource |
| Id | ovh.dedicated_housing.housings |
Fields​
The following fields are returned by SELECT queries:
- get
- list
successful operation
| Name | Datatype | Description |
|---|---|---|
name | string | The name you give to the bay |
datacenter | string | Housing bay datacenter (gsw, pdc1) |
iam | object | IAM resource metadata |
network | array | Housing bay network |
options | object | Housing bay options |
rack | string | The bay's description |
security_code | string | Bay Security code (wire: securityCode) |
Housing bay
| Name | Datatype | Description |
|---|---|---|
name | string | The name you give to the bay |
datacenter | string | Housing bay datacenter (gsw, pdc1) |
iam | object | IAM resource metadata |
network | array | Housing bay network |
options | object | Housing bay options |
rack | string | The bay's description |
security_code | string | Bay Security code (wire: securityCode) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | service_name | Get this object properties | |
list | select | iam_tags, x_pagination_mode | List available services |
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 Housing bay (wire: serviceName) |
iam_tags | object | Filter resources on IAM tags (wire: iamTags) |
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 this object properties
SELECT
name,
datacenter,
iam,
network,
options,
rack,
security_code
FROM ovh.dedicated_housing.housings
WHERE service_name = '{{ service_name }}' -- required
;
List available services
SELECT
name,
datacenter,
iam,
network,
options,
rack,
security_code
FROM ovh.dedicated_housing.housings
WHERE iam_tags = '{{ iam_tags }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;