domains

Creates, updates, deletes, gets or lists a domains resource.

Overview

Name	domains
Type	Resource
Id	ovh.all_dom.domains

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
domain	string	Domain name

list

Domain name of a allDom

Name	Datatype	Description
domain	string	Domain name

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	domain, service_name		Get this AllDom domain properties
list	select	service_name	domain, x_pagination_mode	List all domains attached to this allDom

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"}})
domain	string	Domain
service_name	string	Service name (wire: serviceName)
domain	string	Filter the value of domain property (like)
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

Get this AllDom domain properties

SELECT
domain
FROM ovh.all_dom.domains
WHERE domain = '{{ domain }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List all domains attached to this allDom

SELECT
domain
FROM ovh.all_dom.domains
WHERE service_name = '{{ service_name }}' -- required
AND domain = '{{ domain }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;