Compute Pools
All operations require authentication.
List the Compute Pools of your lakehouseAlpha
Path parameters
Lakehouse ID
Project ID
Headers
Pagination cursor
Pagination size
Response
Hash of the target specification of the Compute Pool. Send it back on update to make sure nobody changed the Compute Pool in between.
Date the Compute Pool was created
Current state of the Compute Pool, computed by the service
Tasks in progress on the Compute Pool, and its last failed task while the Compute Pool is in ERROR. Always an array. Empty when there is none.
Unique identifier of the Compute Pool
Readiness status of the Compute Pool. A change is accepted only in READY or ERROR, except after a refused deletion (ERROR with a *_NOT_EMPTY status reason code), where only a new deletion is accepted. A deletion is also accepted in CREATING and UPDATING and replaces the change in progress.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGLast requested specification of the Compute Pool
Date of the last change to the Compute Pool
Example uses lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ managedAnalytics/ lakehouse/ {lakehouseId}/ computePool \
-H "authorization: Bearer $OVH_TOKEN"[ { "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "computeUnits": 0, "description": "string", "name": "string", "sqlEndpoint": "string", "state": "RUNNING", "statusReason": { "code": "CANCELED", "message": "string" }, "tier": "DEDICATED" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "description": "string", "idleSuspendMinutes": 0, "maxWorkers": 0, "minWorkers": 0, "name": "string", "size": "L", "tier": "DEDICATED" }, "updatedAt": "2024-01-01T12:00:00Z" }]
Get a Compute Pool of your lakehouseAlpha
Path parameters
Compute pool ID
Lakehouse ID
Project ID
Response
Hash of the target specification of the Compute Pool. Send it back on update to make sure nobody changed the Compute Pool in between.
Date the Compute Pool was created
Current state of the Compute Pool, computed by the service
Tasks in progress on the Compute Pool, and its last failed task while the Compute Pool is in ERROR. Always an array. Empty when there is none.
Unique identifier of the Compute Pool
Readiness status of the Compute Pool. A change is accepted only in READY or ERROR, except after a refused deletion (ERROR with a *_NOT_EMPTY status reason code), where only a new deletion is accepted. A deletion is also accepted in CREATING and UPDATING and replaces the change in progress.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGLast requested specification of the Compute Pool
Date of the last change to the Compute Pool
Example uses computePoolId = 00000000-0000-0000-0000-000000000000, lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ managedAnalytics/ lakehouse/ {lakehouseId}/ computePool/ {computePoolId} \
-H "authorization: Bearer $OVH_TOKEN"{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "computeUnits": 0, "description": "string", "name": "string", "sqlEndpoint": "string", "state": "RUNNING", "statusReason": { "code": "CANCELED", "message": "string" }, "tier": "DEDICATED" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "description": "string", "idleSuspendMinutes": 0, "maxWorkers": 0, "minWorkers": 0, "name": "string", "size": "L", "tier": "DEDICATED" }, "updatedAt": "2024-01-01T12:00:00Z"}
Create a Compute Pool in your lakehouseAlpha
Creates the Compute Pool asynchronously. The response is the Compute Pool in CREATING, with the creation task in currentTasks: follow it on the task routes of the Compute Pool, or read the Compute Pool until its resourceStatus is READY or ERROR.
A SHARED pool runs your queries on the regional engine. A DEDICATED pool runs them on an engine reserved for the lakehouse, sized by size, minWorkers and maxWorkers. A lakehouse has at most one DEDICATED Compute Pool. The creation is refused with a 409 while the lakehouse is being deleted.
Path parameters
Lakehouse ID
Project ID
Request body (required)
Specification of the Compute Pool to create
Response
Hash of the target specification of the Compute Pool. Send it back on update to make sure nobody changed the Compute Pool in between.
Date the Compute Pool was created
Current state of the Compute Pool, computed by the service
Tasks in progress on the Compute Pool, and its last failed task while the Compute Pool is in ERROR. Always an array. Empty when there is none.
Unique identifier of the Compute Pool
Readiness status of the Compute Pool. A change is accepted only in READY or ERROR, except after a refused deletion (ERROR with a *_NOT_EMPTY status reason code), where only a new deletion is accepted. A deletion is also accepted in CREATING and UPDATING and replaces the change in progress.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGLast requested specification of the Compute Pool
Date of the last change to the Compute Pool
Example uses lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ managedAnalytics/ lakehouse/ {lakehouseId}/ computePool \
-H "authorization: Bearer $OVH_TOKEN"{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "computeUnits": 0, "description": "string", "name": "string", "sqlEndpoint": "string", "state": "RUNNING", "statusReason": { "code": "CANCELED", "message": "string" }, "tier": "DEDICATED" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "description": "string", "idleSuspendMinutes": 0, "maxWorkers": 0, "minWorkers": 0, "name": "string", "size": "L", "tier": "DEDICATED" }, "updatedAt": "2024-01-01T12:00:00Z"}
Delete a Compute Pool of your lakehouseAlpha
Deletes the Compute Pool asynchronously. The response is the Compute Pool in DELETING, with the deletion task in currentTasks. Once the deletion completes, the Compute Pool and every route under it, its tasks included, answer 404.
A deletion is accepted in READY and ERROR, and also in CREATING and UPDATING, where it replaces the change in progress. A new deletion while one is running is refused with a 409.
Path parameters
Compute pool ID
Lakehouse ID
Project ID
Response
Hash of the target specification of the Compute Pool. Send it back on update to make sure nobody changed the Compute Pool in between.
Date the Compute Pool was created
Current state of the Compute Pool, computed by the service
Tasks in progress on the Compute Pool, and its last failed task while the Compute Pool is in ERROR. Always an array. Empty when there is none.
Unique identifier of the Compute Pool
Readiness status of the Compute Pool. A change is accepted only in READY or ERROR, except after a refused deletion (ERROR with a *_NOT_EMPTY status reason code), where only a new deletion is accepted. A deletion is also accepted in CREATING and UPDATING and replaces the change in progress.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGLast requested specification of the Compute Pool
Date of the last change to the Compute Pool
Example uses computePoolId = 00000000-0000-0000-0000-000000000000, lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ managedAnalytics/ lakehouse/ {lakehouseId}/ computePool/ {computePoolId} \
-H "authorization: Bearer $OVH_TOKEN"{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "computeUnits": 0, "description": "string", "name": "string", "sqlEndpoint": "string", "state": "RUNNING", "statusReason": { "code": "CANCELED", "message": "string" }, "tier": "DEDICATED" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "description": "string", "idleSuspendMinutes": 0, "maxWorkers": 0, "minWorkers": 0, "name": "string", "size": "L", "tier": "DEDICATED" }, "updatedAt": "2024-01-01T12:00:00Z"}
Update a Compute Pool of your lakehouseAlpha
Replaces the Compute Pool's target specification as a whole. The body carries the complete desired state of every field publicCloud.lakehouse.ComputePoolUpdateTargetSpec exposes — description, idleSuspendMinutes, maxWorkers, minWorkers, size and tier — so read the Compute Pool first and restate every value you want to keep: a field left out of targetSpec is cleared, not carried over from the stored specification. For a DEDICATED pool, a shape field left out is reset to its default: size XS, minWorkers 1, maxWorkers equal to minWorkers, idleSuspendMinutes 15.
The create-only field name cannot be changed once the Compute Pool exists. It is deliberately absent from the update model, and sending it is rejected with a 400.
When only description changes on a READY pool, the change is applied at once: the response is 200 with the pool READY. When tier or the resolved shape changes, or when the pool is in ERROR, the change is applied asynchronously: the response is 202 with the pool UPDATING and the new task in currentTasks. The update is refused with a 409 while a task of the pool is in progress or the pool is DELETING. A lakehouse has at most one DEDICATED Compute Pool.
The optional checksum guards against a lost update: when supplied it must match the Compute Pool's current checksum or the request is rejected with a 409 checksum mismatch. Omitting it skips the check and forces the write (last-write-wins).
Path parameters
Compute pool ID
Lakehouse ID
Project ID
Request body (required)
Checksum of the Compute Pool as you last read it. When set, the update is refused with a 409 checksum-mismatch conflict if the Compute Pool changed since. When omitted or empty, no check is made.
New specification of the Compute Pool. It replaces the whole current specification: an optional field you omit is reset to its default. Send only the fields of this model: a field that can only be set at creation is refused.
Response
Hash of the target specification of the Compute Pool. Send it back on update to make sure nobody changed the Compute Pool in between.
Date the Compute Pool was created
Current state of the Compute Pool, computed by the service
Tasks in progress on the Compute Pool, and its last failed task while the Compute Pool is in ERROR. Always an array. Empty when there is none.
Unique identifier of the Compute Pool
Readiness status of the Compute Pool. A change is accepted only in READY or ERROR, except after a refused deletion (ERROR with a *_NOT_EMPTY status reason code), where only a new deletion is accepted. A deletion is also accepted in CREATING and UPDATING and replaces the change in progress.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGLast requested specification of the Compute Pool
Date of the last change to the Compute Pool
Example uses computePoolId = 00000000-0000-0000-0000-000000000000, lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ managedAnalytics/ lakehouse/ {lakehouseId}/ computePool/ {computePoolId} \
-H "authorization: Bearer $OVH_TOKEN"{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "computeUnits": 0, "description": "string", "name": "string", "sqlEndpoint": "string", "state": "RUNNING", "statusReason": { "code": "CANCELED", "message": "string" }, "tier": "DEDICATED" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "description": "string", "idleSuspendMinutes": 0, "maxWorkers": 0, "minWorkers": 0, "name": "string", "size": "L", "tier": "DEDICATED" }, "updatedAt": "2024-01-01T12:00:00Z"}
List the events of a Compute Pool of your lakehouseAlpha
Path parameters
Compute pool ID
Lakehouse ID
Project ID
Query parameters
Return only the events of this task
Headers
Pagination cursor
Pagination size
Response
Creation date of the event
Nature of the event
Link to the event related resource
Description of what happened on the event
Type of the event
TARGET_SPEC_UPDATETASK_ERRORTASK_STARTTASK_SUCCESSExample uses computePoolId = 00000000-0000-0000-0000-000000000000, lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ managedAnalytics/ lakehouse/ {lakehouseId}/ computePool/ {computePoolId}/ event \
-H "authorization: Bearer $OVH_TOKEN"[ { "createdAt": "2024-01-01T12:00:00Z", "kind": "string", "link": "string", "message": "string", "type": "TARGET_SPEC_UPDATE" }]
List the tasks of a Compute Pool of your lakehouseAlpha
Path parameters
Compute pool ID
Lakehouse ID
Project ID
Headers
Pagination cursor
Pagination size
Response
Creation date of the task
Errors that occurred on the task
Ending date of the task
Unique identifier of the task
Link to the related resource
Description of the task
Progress steps of the asynchronous operation
Starting date of the task
Current global status of the task
DONEERRORPENDINGRUNNINGSCHEDULEDWAITING_USER_INPUTType of the task
Last update of the task
Example uses computePoolId = 00000000-0000-0000-0000-000000000000, lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ managedAnalytics/ lakehouse/ {lakehouseId}/ computePool/ {computePoolId}/ task \
-H "authorization: Bearer $OVH_TOKEN"[ { "createdAt": "2024-01-01T12:00:00Z", "errors": [ { "message": "string" } ], "finishedAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "link": "string", "message": "string", "progress": [ { "name": "string", "status": "DONE" } ], "startedAt": "2024-01-01T12:00:00Z", "status": "DONE", "type": "string", "updatedAt": "2024-01-01T12:00:00Z" }]
Get a task of a Compute Pool of your lakehouseAlpha
Path parameters
Compute pool ID
Lakehouse ID
Project ID
Task ID
Response
Creation date of the task
Errors that occurred on the task
Ending date of the task
Unique identifier of the task
Link to the related resource
Description of the task
Progress steps of the asynchronous operation
Starting date of the task
Current global status of the task
DONEERRORPENDINGRUNNINGSCHEDULEDWAITING_USER_INPUTType of the task
Last update of the task
Example uses computePoolId = 00000000-0000-0000-0000-000000000000, lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string, taskId = 00000000-0000-0000-0000-000000000000
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ managedAnalytics/ lakehouse/ {lakehouseId}/ computePool/ {computePoolId}/ task/ {taskId} \
-H "authorization: Bearer $OVH_TOKEN"{ "createdAt": "2024-01-01T12:00:00Z", "errors": [ { "message": "string" } ], "finishedAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "link": "string", "message": "string", "progress": [ { "name": "string", "status": "DONE" } ], "startedAt": "2024-01-01T12:00:00Z", "status": "DONE", "type": "string", "updatedAt": "2024-01-01T12:00:00Z"}
Resume a DEDICATED Compute Pool of your lakehouseAlpha
Resumes a suspended DEDICATED Compute Pool at once, without a task: the response is the pool with its new currentState.state, STARTING until its engine serves again.
The pool must be DEDICATED, READY and in a run state that allows the action: the action is refused with a 400 on a SHARED pool and with a 409 otherwise. It changes neither the target specification, nor the checksum, nor the status of the pool, and records no task.
Path parameters
Compute pool ID
Lakehouse ID
Project ID
Response
Hash of the target specification of the Compute Pool. Send it back on update to make sure nobody changed the Compute Pool in between.
Date the Compute Pool was created
Current state of the Compute Pool, computed by the service
Tasks in progress on the Compute Pool, and its last failed task while the Compute Pool is in ERROR. Always an array. Empty when there is none.
Unique identifier of the Compute Pool
Readiness status of the Compute Pool. A change is accepted only in READY or ERROR, except after a refused deletion (ERROR with a *_NOT_EMPTY status reason code), where only a new deletion is accepted. A deletion is also accepted in CREATING and UPDATING and replaces the change in progress.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGLast requested specification of the Compute Pool
Date of the last change to the Compute Pool
Example uses computePoolId = 00000000-0000-0000-0000-000000000000, lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ managedAnalytics/ lakehouse/ {lakehouseId}/ computePool/ {computePoolId}/ resume \
-H "authorization: Bearer $OVH_TOKEN"{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "computeUnits": 0, "description": "string", "name": "string", "sqlEndpoint": "string", "state": "RUNNING", "statusReason": { "code": "CANCELED", "message": "string" }, "tier": "DEDICATED" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "description": "string", "idleSuspendMinutes": 0, "maxWorkers": 0, "minWorkers": 0, "name": "string", "size": "L", "tier": "DEDICATED" }, "updatedAt": "2024-01-01T12:00:00Z"}
Suspend a DEDICATED Compute Pool of your lakehouseAlpha
Suspends a DEDICATED Compute Pool at once, without a task: the response is the pool with currentState.state SUSPENDED. A suspended pool stays READY and usable: the next query resumes it.
The pool must be DEDICATED, READY and in a run state that allows the action: the action is refused with a 400 on a SHARED pool and with a 409 otherwise. It changes neither the target specification, nor the checksum, nor the status of the pool, and records no task.
Path parameters
Compute pool ID
Lakehouse ID
Project ID
Response
Hash of the target specification of the Compute Pool. Send it back on update to make sure nobody changed the Compute Pool in between.
Date the Compute Pool was created
Current state of the Compute Pool, computed by the service
Tasks in progress on the Compute Pool, and its last failed task while the Compute Pool is in ERROR. Always an array. Empty when there is none.
Unique identifier of the Compute Pool
Readiness status of the Compute Pool. A change is accepted only in READY or ERROR, except after a refused deletion (ERROR with a *_NOT_EMPTY status reason code), where only a new deletion is accepted. A deletion is also accepted in CREATING and UPDATING and replaces the change in progress.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGLast requested specification of the Compute Pool
Date of the last change to the Compute Pool
Example uses computePoolId = 00000000-0000-0000-0000-000000000000, lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ managedAnalytics/ lakehouse/ {lakehouseId}/ computePool/ {computePoolId}/ suspend \
-H "authorization: Bearer $OVH_TOKEN"{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "computeUnits": 0, "description": "string", "name": "string", "sqlEndpoint": "string", "state": "RUNNING", "statusReason": { "code": "CANCELED", "message": "string" }, "tier": "DEDICATED" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "description": "string", "idleSuspendMinutes": 0, "maxWorkers": 0, "minWorkers": 0, "name": "string", "size": "L", "tier": "DEDICATED" }, "updatedAt": "2024-01-01T12:00:00Z"}