orders
Creates, updates, deletes, gets or lists an orders resource.
Overview​
| Name | orders |
| Type | Resource |
| Id | ovh.cloud.orders |
Fields​
The following fields are returned by SELECT queries:
- list
Cloud Order
| Name | Datatype | Description |
|---|---|---|
order_id | integer | Order id (wire: orderId) |
service_name | string | Service created (wire: serviceName) |
date | string (date-time) | Order creation date |
plan_code | string | Order plan code (wire: planCode) |
status | string | Order status (delivered, delivering, unknown, unpaid) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | plan_code | Get 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.
| 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 Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set. |
plan_code | string | Order plan code (wire: planCode) |
SELECT examples​
- list
Get all cloud pending orders
SELECT
order_id,
date,
plan_code,
status
FROM ovh.cloud.orders
WHERE plan_code = '{{ plan_code }}'
;