reference_regions

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

Overview

Name	reference_regions
Type	Resource
Id	ovh.public_cloud.reference_regions

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
name	string	Region identifier, for example GRA1
datacenter_name	string	Datacenter display name (wire: datacenterName)
activated	boolean	Whether the region is activated on the project. When false, the region exists but has not yet been activated for the project.
availability_zones	array	Availability zones in this region (wire: availabilityZones)
continent	string	Continent code
country	string	Country code
object_storage	object	Object storage capabilities of the region. Null when the region offers no object storage. (wire: objectStorage)
services	array	Available services. Includes objectStorage when S3™ object storage is available in the region, that is the region has a non-null objectStorage block whose bareContainerOnly is false.
status	string	Region status (DISABLED, ENABLED, MAINTENANCE)
type	string	Region type. Null when the catalog reports an unrecognized type. (LOCAL-ZONE, REGION-1-AZ, REGION-3-AZ)

list

A Public Cloud region (read-only reference data)

Name	Datatype	Description
name	string	Region identifier, for example GRA1
datacenter_name	string	Datacenter display name (wire: datacenterName)
activated	boolean	Whether the region is activated on the project. When false, the region exists but has not yet been activated for the project.
availability_zones	array	Availability zones in this region (wire: availabilityZones)
continent	string	Continent code
country	string	Country code
object_storage	object	Object storage capabilities of the region. Null when the region offers no object storage. (wire: objectStorage)
services	array	Available services. Includes objectStorage when S3™ object storage is available in the region, that is the region has a non-null objectStorage block whose bareContainerOnly is false.
status	string	Region status (DISABLED, ENABLED, MAINTENANCE)
type	string	Region type. Null when the catalog reports an unrecognized type. (LOCAL-ZONE, REGION-1-AZ, REGION-3-AZ)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	name, project_id		Returns one region: its availability zones, location, status and available services, including its object storage capabilities. (Beta version)
list	select	project_id	x_pagination_cursor, x_pagination_size	Returns the regions with their type, status, location and available services. (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
project_id	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
x_pagination_cursor	string	Pagination cursor (wire: X-Pagination-Cursor)
x_pagination_size	integer	Pagination size (wire: X-Pagination-Size)

SELECT examples

get

Returns one region: its availability zones, location, status and available services, including its object storage capabilities. (Beta version)

SELECT
name,
datacenter_name,
activated,
availability_zones,
continent,
country,
object_storage,
services,
status,
type
FROM ovh.public_cloud.reference_regions
WHERE name = '{{ name }}' -- required
AND project_id = '{{ project_id }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

Returns the regions with their type, status, location and available services. (Beta version)

SELECT
name,
datacenter_name,
activated,
availability_zones,
continent,
country,
object_storage,
services,
status,
type
FROM ovh.public_cloud.reference_regions
WHERE project_id = '{{ project_id }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
AND x_pagination_cursor = '{{ x_pagination_cursor }}'
AND x_pagination_size = '{{ x_pagination_size }}'
;