labs

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

Overview

Name	labs
Type	Resource
Id	ovh.cloud.labs

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string	Lab ID
name	string	Lab name
status	string	Lab status (activated, activating, closed, open)

list

A public cloud lab permits to activate a feature in beta

Name	Datatype	Description
id	string	Lab ID
name	string	Lab name
status	string	Lab status (activated, activating, closed, open)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	lab_id, service_name		Get details of a public cloud lab (Beta version)
list	select	service_name		List available public cloud labs (Beta version)
create	insert	lab_id, service_name		Activate a lab on your Cloud Project (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"}})
lab_id	string	Lab ID (wire: labId)
service_name	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.

SELECT examples

get

Get details of a public cloud lab (Beta version)

SELECT
id,
name,
status
FROM ovh.cloud.labs
WHERE lab_id = '{{ lab_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

List available public cloud labs (Beta version)

SELECT
id,
name,
status
FROM ovh.cloud.labs
WHERE service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

INSERT examples

create

Activate a lab on your Cloud Project (Beta version)

INSERT INTO ovh.cloud.labs (
lab_id,
service_name
)
SELECT 
'{{ lab_id }}',
'{{ service_name }}'
RETURNING
id,
resource_id,
action,
completed_at,
created_at,
progress,
regions,
started_at,
status,
sub_operations
;

Manifest

# Description fields are for documentation purposes
- name: labs
props:
  - name: lab_id
    value: "{{ lab_id }}"
    description: Required parameter for the labs resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the labs resource.