tags

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

Overview

Name	tags
Type	Resource
Id	ovh.dedicated_cloud.tags

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
name	string	Name of the tag
description	string	Description of the tag
state	string	State of the tag (disabled, disabling, enabled, enabling, error, unknown, updating)
value	string	Value of the tag
version	string	Version of the tag

list

Tag

Name	Datatype	Description
name	string	Name of the tag
description	string	Description of the tag
state	string	State of the tag (disabled, disabling, enabled, enabling, error, unknown, updating)
value	string	Value of the tag
version	string	Version of the tag

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	name, service_name		Get a tag
list	select	service_name	x_pagination_mode	List tags

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 of the tag
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 tag

SELECT
name,
description,
state,
value,
version
FROM ovh.dedicated_cloud.tags
WHERE name = '{{ name }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List tags

SELECT
name,
description,
state,
value,
version
FROM ovh.dedicated_cloud.tags
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;