alldoms

Creates, updates, deletes, gets or lists an alldoms resource.

Overview

Name	alldoms
Type	Resource
Id	ovh.domain_v2.alldoms

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string	Unique identifier of the resource. Here, the AllDom name itself is used as an identifier.
checksum	string	Computed hash used to control concurrent modification requests
current_state	object	The representation of the AllDom's current state (wire: currentState)
current_tasks	array	Ongoing asynchronous tasks related to the AllDom resource (wire: currentTasks)
iam	object	IAM resource metadata
resource_status	string	Reflects the readiness of the AllDom resource (CREATING, CREATION_PLANNED, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING) (wire: resourceStatus)

list

An AllDom resource

Name	Datatype	Description
id	string	Unique identifier of the resource. Here, the AllDom name itself is used as an identifier.
checksum	string	Computed hash used to control concurrent modification requests
current_state	object	The representation of the AllDom's current state (wire: currentState)
current_tasks	array	Ongoing asynchronous tasks related to the AllDom resource (wire: currentTasks)
iam	object	IAM resource metadata
resource_status	string	Reflects the readiness of the AllDom resource (CREATING, CREATION_PLANNED, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING) (wire: resourceStatus)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	alldom_name		Get an AllDom resource (Beta version)
list	select		x_pagination_cursor, x_pagination_size, iam_tags	List all the AllDom resources (Beta version)

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
alldom_name	string	Alldom name (wire: alldomName)
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"}})
iam_tags	object	Filter resources on IAM tags (wire: iamTags)
x_pagination_cursor	string	Pagination cursor (wire: X-Pagination-Cursor)
x_pagination_size	integer	Pagination size (wire: X-Pagination-Size)

SELECT examples

get

Get an AllDom resource (Beta version)

SELECT
id,
checksum,
current_state,
current_tasks,
iam,
resource_status
FROM ovh.domain_v2.alldoms
WHERE alldom_name = '{{ alldom_name }}' -- required
;

list

List all the AllDom resources (Beta version)

SELECT
id,
checksum,
current_state,
current_tasks,
iam,
resource_status
FROM ovh.domain_v2.alldoms
WHERE x_pagination_cursor = '{{ x_pagination_cursor }}'
AND x_pagination_size = '{{ x_pagination_size }}'
AND iam_tags = '{{ iam_tags }}'
;