circuits

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

Overview

Name	circuits
Type	Resource
Id	ovh.ovh_cloud_connect.circuits

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	Circuit id
name	string	Circuit name
creation_date	string (date-time)	Creation date of the circuit (wire: creationDate)
done_date	string (date-time)	Date when the circuit was terminated (wire: doneDate)
key	string	Pairing key of the circuit
last_update	string (date-time)	Last update date of the circuit (wire: lastUpdate)
operational_status	string	Operational status of the circuit (degraded, down, unknown, up) (wire: operationalStatus)
status	string	Circuit status (active, pending, pending_customer, terminated, to_check)

list

OVHcloud Connect Circuit

Name	Datatype	Description
id	integer	Circuit id
name	string	Circuit name
creation_date	string (date-time)	Creation date of the circuit (wire: creationDate)
done_date	string (date-time)	Date when the circuit was terminated (wire: doneDate)
key	string	Pairing key of the circuit
last_update	string (date-time)	Last update date of the circuit (wire: lastUpdate)
operational_status	string	Operational status of the circuit (degraded, down, unknown, up) (wire: operationalStatus)
status	string	Circuit status (active, pending, pending_customer, terminated, to_check)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id, service_name		Returns the circuit's pairing key, status and operational status.
list	select	service_name	x_pagination_mode	Returns the IDs of the circuits created from Google pairing keys.
delete	delete	id, service_name		Dissociates the pairing key and removes the circuit (async task).

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
service_name	string (uuid)	Service name (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

Returns the circuit's pairing key, status and operational status.

SELECT
id,
name,
creation_date,
done_date,
key,
last_update,
operational_status,
status
FROM ovh.ovh_cloud_connect.circuits
WHERE id = '{{ id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

Returns the IDs of the circuits created from Google pairing keys.

SELECT
id,
name,
creation_date,
done_date,
key,
last_update,
operational_status,
status
FROM ovh.ovh_cloud_connect.circuits
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

DELETE examples

delete

Dissociates the pairing key and removes the circuit (async task).

DELETE FROM ovh.ovh_cloud_connect.circuits
WHERE id = '{{ id }}' --required
AND service_name = '{{ service_name }}' --required
;