platform_slots

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

Overview

Name	platform_slots
Type	Resource
Id	ovh.zimbra.platform_slots

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string (uuid)	Resource identifier in UUID representation
checksum	string	Checksum hash in MD5 representation
current_state	object	Object representing slot (wire: currentState)
current_tasks	array	An array containing tasks responses pending on resource extends AsyncResourceBase object (wire: currentTasks)
resource_status	string	Current resource status (CREATING, CREATION_PLANNED, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING) (wire: resourceStatus)

list

Response for a Zimbra Slot

Name	Datatype	Description
id	string (uuid)	Resource identifier in UUID representation
checksum	string	Checksum hash in MD5 representation
current_state	object	Object representing slot (wire: currentState)
current_tasks	array	An array containing tasks responses pending on resource extends AsyncResourceBase object (wire: currentTasks)
resource_status	string	Current resource status (CREATING, CREATION_PLANNED, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING) (wire: resourceStatus)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	platform_id, slot_id		Returns the offer and billing status of the slot, and the email account using it. accountId and email are null while no account uses the slot.
list	select	platform_id	x_pagination_cursor, x_pagination_size, account_id, billing_status, email, offer, used	Returns the account slots of the platform with their offer, billing status and linked email account. Filter them by accountId, email, offer, billingStatus or used.

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"}})
platform_id	string (uuid)	Platform ID (wire: platformId)
slot_id	string (uuid)	Slot ID (wire: slotId)
account_id	string	Filter by account identifier of the slots (wire: accountId)
billing_status	string	Filter by the billing status of the slots (wire: billingStatus)
email	string	Filter slot by an email
offer	string	Filter by offer of the slots
used	boolean	Filter by the empty account id of the slots
x_pagination_cursor	string	Pagination cursor (wire: X-Pagination-Cursor)
x_pagination_size	integer	Pagination size (wire: X-Pagination-Size)

SELECT examples

get

Returns the offer and billing status of the slot, and the email account using it. accountId and email are null while no account uses the slot.

SELECT
id,
checksum,
current_state,
current_tasks,
resource_status
FROM ovh.zimbra.platform_slots
WHERE platform_id = '{{ platform_id }}' -- required
AND slot_id = '{{ slot_id }}' -- required
;

list

Returns the account slots of the platform with their offer, billing status and linked email account. Filter them by accountId, email, offer, billingStatus or used.

SELECT
id,
checksum,
current_state,
current_tasks,
resource_status
FROM ovh.zimbra.platform_slots
WHERE platform_id = '{{ platform_id }}' -- required
AND x_pagination_cursor = '{{ x_pagination_cursor }}'
AND x_pagination_size = '{{ x_pagination_size }}'
AND account_id = '{{ account_id }}'
AND billing_status = '{{ billing_status }}'
AND email = '{{ email }}'
AND offer = '{{ offer }}'
AND used = '{{ used }}'
;