names

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

Overview

Name	names
Type	Resource
Id	ovh.domain_v2.names

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string	Unique identifier of the resource. Here, the domain name itself is used as an identifier.
checksum	string	Computed hash used to control concurrent modification requests. Here, it represents the current target specification value.
current_state	object	Current state of the domain name (wire: currentState)
current_tasks	array	Ongoing asynchronous tasks related to the domain name resource (wire: currentTasks)
iam	object	IAM resource metadata
resource_status	string	Reflects the readiness of the domain name resource. A new target specification request will be accepted only in READY, UPDATING or ERROR status. (CREATING, CREATION_PLANNED, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING) (wire: resourceStatus)
target_spec	object	Latest target specification of the domain name resource (wire: targetSpec)

list

A domain name resource

Name	Datatype	Description
id	string	Unique identifier of the resource. Here, the domain name itself is used as an identifier.
checksum	string	Computed hash used to control concurrent modification requests. Here, it represents the current target specification value.
current_state	object	Current state of the domain name (wire: currentState)
current_tasks	array	Ongoing asynchronous tasks related to the domain name resource (wire: currentTasks)
iam	object	IAM resource metadata
resource_status	string	Reflects the readiness of the domain name resource. A new target specification request will be accepted only in READY, UPDATING or ERROR status. (CREATING, CREATION_PLANNED, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING) (wire: resourceStatus)
target_spec	object	Latest target specification of the domain name resource (wire: targetSpec)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	domain_name		Get a domain name resource (Beta version)
list	select		x_pagination_cursor, x_pagination_size, additional_states, contact_administrator, contact_billing, contact_owner, contact_technical, iam_tags, main_state, search_value, suspension_state	List all domain name resources (Beta version)
update	update	domain_name, target_spec		Update an existing domain name by modifying various configurations through the targetSpec (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
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_name	string	Domain name (wire: domainName)
additional_states	array	Filter the results having all these additional states (wire: additionalStates)
contact_administrator	array	Filter the results by administrator contact id (wire: contactAdministrator)
contact_billing	array	Filter the results by billing contact id (wire: contactBilling)
contact_owner	array	Filter the results by owner contact id (wire: contactOwner)
contact_technical	array	Filter the results by technical contact id (wire: contactTechnical)
iam_tags	object	Filter resources on IAM tags (wire: iamTags)
main_state	array	Filter the results having all these main states (wire: mainState)
search_value	string	Filter the results with the search value on resource id (wire: searchValue)
suspension_state	array	Filter the results having all these suspension states (wire: suspensionState)
x_pagination_cursor	string	Pagination cursor (wire: X-Pagination-Cursor)
x_pagination_size	integer	Pagination size (wire: X-Pagination-Size)

SELECT examples

get

Get a domain name resource (Beta version)

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

list

List all domain name resources (Beta version)

SELECT
id,
checksum,
current_state,
current_tasks,
iam,
resource_status,
target_spec
FROM ovh.domain_v2.names
WHERE x_pagination_cursor = '{{ x_pagination_cursor }}'
AND x_pagination_size = '{{ x_pagination_size }}'
AND additional_states = '{{ additional_states }}'
AND contact_administrator = '{{ contact_administrator }}'
AND contact_billing = '{{ contact_billing }}'
AND contact_owner = '{{ contact_owner }}'
AND contact_technical = '{{ contact_technical }}'
AND iam_tags = '{{ iam_tags }}'
AND main_state = '{{ main_state }}'
AND search_value = '{{ search_value }}'
AND suspension_state = '{{ suspension_state }}'
;

UPDATE examples

update

Update an existing domain name by modifying various configurations through the targetSpec (Beta version)

UPDATE ovh.domain_v2.names
SET 
checksum = '{{ checksum }}',
target_spec = '{{ target_spec }}'
WHERE 
domain_name = '{{ domain_name }}' --required
AND target_spec = '{{ target_spec }}' --required
RETURNING
id,
checksum,
current_state,
current_tasks,
resource_status,
target_spec;