all_doms
Creates, updates, deletes, gets or lists an all_doms resource.
Overview​
| Name | all_doms |
| Type | Resource |
| Id | ovh.all_dom.all_doms |
Fields​
The following fields are returned by SELECT queries:
- get
- list
successful operation
| Name | Datatype | Description |
|---|---|---|
name | string | Name of the allDom |
iam | object | IAM resource metadata |
offer | string | Offer of the allDom (diamond, gold, platinum) |
type | string | Type of the allDom (french, french+international, international) |
General information about a alldom service
| Name | Datatype | Description |
|---|---|---|
name | string | Name of the allDom |
iam | object | IAM resource metadata |
offer | string | Offer of the allDom (diamond, gold, platinum) |
type | string | Type of the allDom (french, french+international, international) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | service_name | Get this AllDom properties | |
list | select | iam_tags, x_pagination_mode | List available AllDom 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 | Service name (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 AllDom properties
SELECT
name,
iam,
offer,
type
FROM ovh.all_dom.all_doms
WHERE service_name = '{{ service_name }}' -- required
;
List available AllDom services
SELECT
name,
iam,
offer,
type
FROM ovh.all_dom.all_doms
WHERE iam_tags = '{{ iam_tags }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;