resources

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

Overview

Name	resources
Type	Resource
Id	ovh.webhosting.resources

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string	Unique identifier of the resource. Here, the service name 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 hosting plan (wire: currentState)
current_tasks	array	Ongoing asynchronous tasks related to the hosting plan (wire: currentTasks)
iam	object	IAM resource metadata
resource_status	string	Webhosting resource readiness in the system (CREATING, CREATION_PLANNED, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING) (wire: resourceStatus)

list

Webhosting Web

Name	Datatype	Description
id	string	Unique identifier of the resource. Here, the service name 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 hosting plan (wire: currentState)
current_tasks	array	Ongoing asynchronous tasks related to the hosting plan (wire: currentTasks)
iam	object	IAM resource metadata
resource_status	string	Webhosting resource readiness in the system (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	name		Returns the web hosting, identified by its service name, with its current state and running tasks. (Beta version)
list	select		x_pagination_cursor, x_pagination_size, iam_tags	Returns the web hostings of the account. (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"}})
name	string	Name
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

Returns the web hosting, identified by its service name, with its current state and running tasks. (Beta version)

SELECT
id,
checksum,
current_state,
current_tasks,
iam,
resource_status
FROM ovh.webhosting.resources
WHERE name = '{{ name }}' -- required
;

list

Returns the web hostings of the account. (Beta version)

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