planned_changes
Creates, updates, deletes, gets or lists a planned_changes resource.
Overview​
| Name | planned_changes |
| Type | Resource |
| Id | ovh.dedicated_server.planned_changes |
Fields​
The following fields are returned by SELECT queries:
- get
- list
successful operation
| Name | Datatype | Description |
|---|---|---|
id | string | UUID of the change |
expected_end_date | string (date-time) | Expected end date for this change (wire: expectedEndDate) |
status | string | Status of the change (acknowledged, assess, authorize, canceled, closed, doing, done, implement, new, review, scheduled, todo) |
type | string | Operation purpose (HARDWARE_UPGRADE_ON_ACTIVE_SERVER) |
wanted_start_date | string (date-time) | Wanted start date for this change (wire: wantedStartDate) |
Planned change on the server
| Name | Datatype | Description |
|---|---|---|
id | string | UUID of the change |
expected_end_date | string (date-time) | Expected end date for this change (wire: expectedEndDate) |
status | string | Status of the change (acknowledged, assess, authorize, canceled, closed, doing, done, implement, new, review, scheduled, todo) |
type | string | Operation purpose (HARDWARE_UPGRADE_ON_ACTIVE_SERVER) |
wanted_start_date | string (date-time) | Wanted start date for this change (wire: wantedStartDate) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | change_uuid, service_name | Get a planned change. Returns a change planned on the server: its purpose, its status, its wanted start date and its expected end date. (Beta version) | |
list | select | service_name | x_pagination_mode | List planned changes. Returns the UUIDs of the changes planned on the server. Get a change by its UUID to read its purpose, status and expected dates. (Beta version) |
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"}}) |
change_uuid | string | UUID of the change (wire: changeUuid) |
service_name | string | The internal name of your dedicated server (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
- list
Get a planned change. Returns a change planned on the server: its purpose, its status, its wanted start date and its expected end date. (Beta version)
SELECT
id,
expected_end_date,
status,
type,
wanted_start_date
FROM ovh.dedicated_server.planned_changes
WHERE change_uuid = '{{ change_uuid }}' -- required
AND service_name = '{{ service_name }}' -- required
;
List planned changes. Returns the UUIDs of the changes planned on the server. Get a change by its UUID to read its purpose, status and expected dates. (Beta version)
SELECT
id,
expected_end_date,
status,
type,
wanted_start_date
FROM ovh.dedicated_server.planned_changes
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;