vips

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

Overview

Name	vips
Type	Resource
Id	ovh.vip.vips

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
service_name	string	Name of the VIP offer (wire: serviceName)
iam	object	IAM resource metadata
universe	array	VIP universes of this service

list

Vip Service

Name	Datatype	Description
service_name	string	Name of the VIP offer (wire: serviceName)
iam	object	IAM resource metadata
universe	array	VIP universes of this service

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_name		Get this object properties
list	select		iam_tags, x_pagination_mode	List available services

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"}})
service_name	string	The internal name of your VIP support offer (wire: serviceName)
iam_tags	object	Filter resources on IAM tags (wire: iamTags)
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 this object properties

SELECT
service_name,
iam,
universe
FROM ovh.vip.vips
WHERE service_name = '{{ service_name }}' -- required
;

list

List available services

SELECT
service_name,
iam,
universe
FROM ovh.vip.vips
WHERE iam_tags = '{{ iam_tags }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;