location_host_profiles

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

Overview

Name	location_host_profiles
Type	Resource
Id	ovh.dedicated_cloud.location_host_profiles

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	Id of Host profile
name	string	Name of Host profile

get_by_id

successful operation

Name	Datatype	Description
id	integer	Id of Host profile
name	string	Name of Host profile

list

Host profile

Name	Datatype	Description
id	integer	Id of Host profile
name	string	Name of Host profile

list_by_service_name

Host profile

Name	Datatype	Description
id	integer	Id of Host profile
name	string	Name of Host profile

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id, pcc_zone		Get a host profile
get_by_id	select	id, service_name		Get a host profile
list	select	pcc_zone	x_pagination_mode	List host profiles
list_by_service_name	select	service_name	x_pagination_mode	List host profiles

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"}})
id	integer	Id of Host profile
pcc_zone	string	Name of pccZone (wire: pccZone)
service_name	string	Domain of the service (wire: serviceName)
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 a host profile

SELECT
id,
name
FROM ovh.dedicated_cloud.location_host_profiles
WHERE id = '{{ id }}' -- required
AND pcc_zone = '{{ pcc_zone }}' -- required
;

get_by_id

Get a host profile

SELECT
id,
name
FROM ovh.dedicated_cloud.location_host_profiles
WHERE id = '{{ id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List host profiles

SELECT
id,
name
FROM ovh.dedicated_cloud.location_host_profiles
WHERE pcc_zone = '{{ pcc_zone }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

list_by_service_name

List host profiles

SELECT
id,
name
FROM ovh.dedicated_cloud.location_host_profiles
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;