Skip to main content

orders

Creates, updates, deletes, gets or lists an orders resource.

Overview​

Nameorders
TypeResource
Idovh.cloud.orders

Fields​

The following fields are returned by SELECT queries:

Cloud Order

NameDatatypeDescription
order_idintegerOrder id (wire: orderId)
service_namestringService created (wire: serviceName)
datestring (date-time)Order creation date
plan_codestringOrder plan code (wire: planCode)
statusstringOrder status (delivered, delivering, unknown, unpaid)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectplan_codeGet all cloud pending orders

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.

NameDatatypeDescription
api_hoststringThe 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_namestringThe Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
plan_codestringOrder plan code (wire: planCode)

SELECT examples​

Get all cloud pending orders

SELECT
order_id,
date,
plan_code,
status
FROM ovh.cloud.orders
WHERE plan_code = '{{ plan_code }}'
;