Skip to content

Catalogs

All operations require authentication.

15 operationsv2/publicCloud/project
View as Markdown (opens in a new tab)
Agent setup

List the catalogs of your lakehouseAlpha

GET
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog

Path parameters

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200Catalog[]successful operation
checksum
read-only
string

Hash of the target specification of the catalog. Send it back on update to make sure nobody changed the catalog in between.

createdAt
read-only
stringdate-time

Date the catalog was created

currentState
read-only
CatalogCurrentState

Current state of the catalog, computed by the service

currentTasks
read-only
CurrentTask[]

Tasks in progress on the catalog, and its last failed task while the catalog is in ERROR. Always an array. Empty when there is none.

id
read-only
stringuuid

Unique identifier of the catalog

resourceStatus
read-only
ResourceStatusEnum

Readiness status of the catalog. 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.

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
CatalogTargetSpec

Last requested specification of the catalog

updatedAt
read-only
stringdate-time

Date of the last change to the catalog

400objectError 400 response
404objectError 404 response

Example uses lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ { "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "description": "string", "name": "string", "sqlCatalog": "string", "statusReason": { "code": "CANCELED", "message": "string" }, "warehouse": "string" }, "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", "name": "string" }, "updatedAt": "2024-01-01T12:00:00Z" }]

Get a catalog of your lakehouseAlpha

GET
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}

Path parameters

catalogId
required
stringuuid

Catalog ID

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

Response

200Catalogsuccessful operation
checksum
read-only
string

Hash of the target specification of the catalog. Send it back on update to make sure nobody changed the catalog in between.

createdAt
read-only
stringdate-time

Date the catalog was created

currentState
read-only
CatalogCurrentState

Current state of the catalog, computed by the service

currentTasks
read-only
CurrentTask[]

Tasks in progress on the catalog, and its last failed task while the catalog is in ERROR. Always an array. Empty when there is none.

id
read-only
stringuuid

Unique identifier of the catalog

resourceStatus
read-only
ResourceStatusEnum

Readiness status of the catalog. 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.

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
CatalogTargetSpec

Last requested specification of the catalog

updatedAt
read-only
stringdate-time

Date of the last change to the catalog

400objectError 400 response
404objectError 404 response

Example uses catalogId = 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}/catalog/{catalogId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "description": "string", "name": "string", "sqlCatalog": "string", "statusReason": { "code": "CANCELED", "message": "string" }, "warehouse": "string" }, "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", "name": "string" }, "updatedAt": "2024-01-01T12:00:00Z"}

Create a catalog in your lakehouseAlpha

POST
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog

Creates the catalog asynchronously. The response is the catalog in CREATING, with the creation task in currentTasks: follow it on the task routes of the catalog, or read the catalog until its resourceStatus is READY or ERROR.

The creation is refused with a 409 while the lakehouse is being deleted.

Path parameters

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

Request body (required)

targetSpec
required
CatalogTargetSpec

Specification of the catalog to create

Response

200Catalogsuccessful operation
checksum
read-only
string

Hash of the target specification of the catalog. Send it back on update to make sure nobody changed the catalog in between.

createdAt
read-only
stringdate-time

Date the catalog was created

currentState
read-only
CatalogCurrentState

Current state of the catalog, computed by the service

currentTasks
read-only
CurrentTask[]

Tasks in progress on the catalog, and its last failed task while the catalog is in ERROR. Always an array. Empty when there is none.

id
read-only
stringuuid

Unique identifier of the catalog

resourceStatus
read-only
ResourceStatusEnum

Readiness status of the catalog. 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.

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
CatalogTargetSpec

Last requested specification of the catalog

updatedAt
read-only
stringdate-time

Date of the last change to the catalog

400objectError 400 response
404objectError 404 response
409objectError 409 response

Example uses lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "description": "string", "name": "string", "sqlCatalog": "string", "statusReason": { "code": "CANCELED", "message": "string" }, "warehouse": "string" }, "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", "name": "string" }, "updatedAt": "2024-01-01T12:00:00Z"}

Delete a catalog of your lakehouseAlpha

DELETE
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}

Deletes the catalog asynchronously. The response is the catalog in DELETING, with the deletion task in currentTasks. Once the deletion completes, the catalog and every route under it, its tasks included, answer 404. Deleting a catalog also deletes its schemas, and the role assignments scoped to the catalog. A role permission that targets the catalog or one of its schemas is kept, with the targetState TARGET_DELETED, and gives nothing.

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, except a deletion with force set to true on a running deletion that keeps the data, which escalates it.

Without force, the deletion keeps the data and is refused while the catalog still holds data. The refusal shows asynchronously as the catalog in ERROR, with the status reason code CATALOG_NOT_EMPTY and the failed task in currentTasks. From that state only a new deletion is accepted, typically with force set to true. With force set to true, the tables, views and data the catalog holds are deleted too.

Path parameters

catalogId
required
stringuuid

Catalog ID

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

Query parameters

force
boolean

Also delete the tables, views and data it holds. Without it, the deletion is refused while data remains.

Response

200Catalogsuccessful operation
checksum
read-only
string

Hash of the target specification of the catalog. Send it back on update to make sure nobody changed the catalog in between.

createdAt
read-only
stringdate-time

Date the catalog was created

currentState
read-only
CatalogCurrentState

Current state of the catalog, computed by the service

currentTasks
read-only
CurrentTask[]

Tasks in progress on the catalog, and its last failed task while the catalog is in ERROR. Always an array. Empty when there is none.

id
read-only
stringuuid

Unique identifier of the catalog

resourceStatus
read-only
ResourceStatusEnum

Readiness status of the catalog. 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.

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
CatalogTargetSpec

Last requested specification of the catalog

updatedAt
read-only
stringdate-time

Date of the last change to the catalog

400objectError 400 response
404objectError 404 response
409objectError 409 response

Example uses catalogId = 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}/catalog/{catalogId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "description": "string", "name": "string", "sqlCatalog": "string", "statusReason": { "code": "CANCELED", "message": "string" }, "warehouse": "string" }, "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", "name": "string" }, "updatedAt": "2024-01-01T12:00:00Z"}

Update a catalog of your lakehouseAlpha

PUT
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}

Replaces the catalog's target specification as a whole. The body carries the complete desired state of every field publicCloud.lakehouse.CatalogUpdateTargetSpec exposes — description — so read the catalog first and restate every value you want to keep: a field left out of targetSpec is cleared, not carried over from the stored specification.

The create-only field name cannot be changed once the catalog exists. It is deliberately absent from the update model, and sending it is rejected with a 400.

On a READY catalog the change is applied at once: the response is 200 with the catalog READY. On a catalog in ERROR the change is applied asynchronously, even when the specification is unchanged, to bring the catalog out of ERROR: the response is 202 with the catalog UPDATING and the new task in currentTasks. The update is refused with a 409 while the catalog is CREATING, UPDATING or DELETING, and after a refused deletion, from which only a new deletion is accepted.

The optional checksum guards against a lost update: when supplied it must match the catalog'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

catalogId
required
stringuuid

Catalog ID

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

Request body (required)

checksum
string

Checksum of the catalog as you last read it. When set, the update is refused with a 409 checksum-mismatch conflict if the catalog changed since. When omitted or empty, no check is made.

targetSpec
required
CatalogUpdateTargetSpec

New specification of the catalog. 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

200Catalogsuccessful operation
checksum
read-only
string

Hash of the target specification of the catalog. Send it back on update to make sure nobody changed the catalog in between.

createdAt
read-only
stringdate-time

Date the catalog was created

currentState
read-only
CatalogCurrentState

Current state of the catalog, computed by the service

currentTasks
read-only
CurrentTask[]

Tasks in progress on the catalog, and its last failed task while the catalog is in ERROR. Always an array. Empty when there is none.

id
read-only
stringuuid

Unique identifier of the catalog

resourceStatus
read-only
ResourceStatusEnum

Readiness status of the catalog. 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.

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
CatalogTargetSpec

Last requested specification of the catalog

updatedAt
read-only
stringdate-time

Date of the last change to the catalog

400objectError 400 response
404objectError 404 response
409objectError 409 response

Example uses catalogId = 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}/catalog/{catalogId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "description": "string", "name": "string", "sqlCatalog": "string", "statusReason": { "code": "CANCELED", "message": "string" }, "warehouse": "string" }, "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", "name": "string" }, "updatedAt": "2024-01-01T12:00:00Z"}

List the tasks of a catalog of your lakehouseAlpha

GET
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/task

Path parameters

catalogId
required
stringuuid

Catalog ID

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200Task[]successful operation
createdAt
read-only
stringdate-time

Creation date of the task

errors
read-only
TaskError[]

Errors that occurred on the task

finishedAt
read-only
stringdate-time

Ending date of the task

id
read-only
stringuuid

Unique identifier of the task

link
read-only
string

Link to the related resource

message
read-only
string

Description of the task

progress
read-only
TaskProgress[]

Progress steps of the asynchronous operation

startedAt
read-only
stringdate-time

Starting date of the task

status
read-only
TaskStatusEnum

Current global status of the task

ValuesDONEERRORPENDINGRUNNINGSCHEDULEDWAITING_USER_INPUT
type
read-only
string

Type of the task

updatedAt
read-only
stringdate-time

Last update of the task

400objectError 400 response
404objectError 404 response

Example uses catalogId = 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}/catalog/{catalogId}/task \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ { "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 catalog of your lakehouseAlpha

GET
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/task/{taskId}

Path parameters

catalogId
required
stringuuid

Catalog ID

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

taskId
required
stringuuid

Task ID

Response

200Tasksuccessful operation
createdAt
read-only
stringdate-time

Creation date of the task

errors
read-only
TaskError[]

Errors that occurred on the task

finishedAt
read-only
stringdate-time

Ending date of the task

id
read-only
stringuuid

Unique identifier of the task

link
read-only
string

Link to the related resource

message
read-only
string

Description of the task

progress
read-only
TaskProgress[]

Progress steps of the asynchronous operation

startedAt
read-only
stringdate-time

Starting date of the task

status
read-only
TaskStatusEnum

Current global status of the task

ValuesDONEERRORPENDINGRUNNINGSCHEDULEDWAITING_USER_INPUT
type
read-only
string

Type of the task

updatedAt
read-only
stringdate-time

Last update of the task

400objectError 400 response
404objectError 404 response

Example uses catalogId = 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}/catalog/{catalogId}/task/{taskId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "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"}

List the events of a catalog of your lakehouseAlpha

GET
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/event

Path parameters

catalogId
required
stringuuid

Catalog ID

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

Query parameters

taskId
stringuuid

Return only the events of this task

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200Event[]successful operation
createdAt
read-only
stringdate-time

Creation date of the event

kind
read-only
string

Nature of the event

link
read-only
string

Link to the event related resource

message
read-only
string

Description of what happened on the event

type
read-only
EventTypeEnum

Type of the event

ValuesTARGET_SPEC_UPDATETASK_ERRORTASK_STARTTASK_SUCCESS
400objectError 400 response
404objectError 404 response

Example uses catalogId = 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}/catalog/{catalogId}/event \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ { "createdAt": "2024-01-01T12:00:00Z", "kind": "string", "link": "string", "message": "string", "type": "TARGET_SPEC_UPDATE" }]

List the schemas of a catalog of your lakehouseAlpha

GET
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema

Path parameters

catalogId
required
stringuuid

Catalog ID

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200Schema[]successful operation
checksum
read-only
string

Hash of the target specification of the schema, which never changes after creation

createdAt
read-only
stringdate-time

Date the schema was created

currentState
read-only
SchemaCurrentState

Current state of the schema, computed by the service

currentTasks
read-only
CurrentTask[]

Tasks in progress on the schema, and its last failed task while the schema is in ERROR. Always an array. Empty when there is none.

id
read-only
stringuuid

Unique identifier of the schema

resourceStatus
read-only
ResourceStatusEnum

Readiness status of the schema. The schema cannot be changed: delete it and create it again. A deletion is accepted in READY, ERROR, CREATING and UPDATING, and replaces the change in progress.

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
SchemaTargetSpec

Last requested specification of the schema

updatedAt
read-only
stringdate-time

Date of the last change to the schema

400objectError 400 response
404objectError 404 response

Example uses catalogId = 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}/catalog/{catalogId}/schema \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ { "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "name": "string", "statusReason": { "code": "CANCELED", "message": "string" } }, "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": { "name": "string" }, "updatedAt": "2024-01-01T12:00:00Z" }]

Get a schema of a catalog of your lakehouseAlpha

GET
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema/{schemaId}

Path parameters

catalogId
required
stringuuid

Catalog ID

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

schemaId
required
stringuuid

Schema ID

Response

200Schemasuccessful operation
checksum
read-only
string

Hash of the target specification of the schema, which never changes after creation

createdAt
read-only
stringdate-time

Date the schema was created

currentState
read-only
SchemaCurrentState

Current state of the schema, computed by the service

currentTasks
read-only
CurrentTask[]

Tasks in progress on the schema, and its last failed task while the schema is in ERROR. Always an array. Empty when there is none.

id
read-only
stringuuid

Unique identifier of the schema

resourceStatus
read-only
ResourceStatusEnum

Readiness status of the schema. The schema cannot be changed: delete it and create it again. A deletion is accepted in READY, ERROR, CREATING and UPDATING, and replaces the change in progress.

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
SchemaTargetSpec

Last requested specification of the schema

updatedAt
read-only
stringdate-time

Date of the last change to the schema

400objectError 400 response
404objectError 404 response

Example uses catalogId = 00000000-0000-0000-0000-000000000000, lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string, schemaId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema/{schemaId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "name": "string", "statusReason": { "code": "CANCELED", "message": "string" } }, "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": { "name": "string" }, "updatedAt": "2024-01-01T12:00:00Z"}

Create a schema in a catalog of your lakehouseAlpha

POST
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema

Creates the schema asynchronously. The response is the schema in CREATING, with the creation task in currentTasks: follow it on the task routes of the schema, or read the schema until its resourceStatus is READY or ERROR.

The creation is refused with a 409 while the lakehouse or the catalog is being deleted. A schema cannot be changed after creation.

Path parameters

catalogId
required
stringuuid

Catalog ID

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

Request body (required)

targetSpec
required
SchemaTargetSpec

Specification of the schema to create

Response

200Schemasuccessful operation
checksum
read-only
string

Hash of the target specification of the schema, which never changes after creation

createdAt
read-only
stringdate-time

Date the schema was created

currentState
read-only
SchemaCurrentState

Current state of the schema, computed by the service

currentTasks
read-only
CurrentTask[]

Tasks in progress on the schema, and its last failed task while the schema is in ERROR. Always an array. Empty when there is none.

id
read-only
stringuuid

Unique identifier of the schema

resourceStatus
read-only
ResourceStatusEnum

Readiness status of the schema. The schema cannot be changed: delete it and create it again. A deletion is accepted in READY, ERROR, CREATING and UPDATING, and replaces the change in progress.

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
SchemaTargetSpec

Last requested specification of the schema

updatedAt
read-only
stringdate-time

Date of the last change to the schema

400objectError 400 response
404objectError 404 response
409objectError 409 response

Example uses catalogId = 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}/catalog/{catalogId}/schema \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "name": "string", "statusReason": { "code": "CANCELED", "message": "string" } }, "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": { "name": "string" }, "updatedAt": "2024-01-01T12:00:00Z"}

Delete a schema of a catalog of your lakehouseAlpha

DELETE
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema/{schemaId}

Deletes the schema asynchronously. The response is the schema in DELETING, with the deletion task in currentTasks. Once the deletion completes, the schema and every route under it, its tasks included, answer 404. A role permission that targets the schema is kept, with the targetState TARGET_DELETED, and gives nothing.

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, except a deletion with force set to true on a running deletion that keeps the data, which escalates it.

Without force, the deletion keeps the data and is refused while the schema still holds data. The refusal shows asynchronously as the schema in ERROR, with the status reason code SCHEMA_NOT_EMPTY and the failed task in currentTasks. From that state only a new deletion is accepted, typically with force set to true. With force set to true, the tables, views and data the schema holds are deleted too.

Path parameters

catalogId
required
stringuuid

Catalog ID

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

schemaId
required
stringuuid

Schema ID

Query parameters

force
boolean

Also delete the tables, views and data it holds. Without it, the deletion is refused while data remains.

Response

200Schemasuccessful operation
checksum
read-only
string

Hash of the target specification of the schema, which never changes after creation

createdAt
read-only
stringdate-time

Date the schema was created

currentState
read-only
SchemaCurrentState

Current state of the schema, computed by the service

currentTasks
read-only
CurrentTask[]

Tasks in progress on the schema, and its last failed task while the schema is in ERROR. Always an array. Empty when there is none.

id
read-only
stringuuid

Unique identifier of the schema

resourceStatus
read-only
ResourceStatusEnum

Readiness status of the schema. The schema cannot be changed: delete it and create it again. A deletion is accepted in READY, ERROR, CREATING and UPDATING, and replaces the change in progress.

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
SchemaTargetSpec

Last requested specification of the schema

updatedAt
read-only
stringdate-time

Date of the last change to the schema

400objectError 400 response
404objectError 404 response
409objectError 409 response

Example uses catalogId = 00000000-0000-0000-0000-000000000000, lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string, schemaId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema/{schemaId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "name": "string", "statusReason": { "code": "CANCELED", "message": "string" } }, "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": { "name": "string" }, "updatedAt": "2024-01-01T12:00:00Z"}

List the events of a schema of your lakehouseAlpha

GET
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema/{schemaId}/event

Path parameters

catalogId
required
stringuuid

Catalog ID

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

schemaId
required
stringuuid

Schema ID

Query parameters

taskId
stringuuid

Return only the events of this task

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200Event[]successful operation
createdAt
read-only
stringdate-time

Creation date of the event

kind
read-only
string

Nature of the event

link
read-only
string

Link to the event related resource

message
read-only
string

Description of what happened on the event

type
read-only
EventTypeEnum

Type of the event

ValuesTARGET_SPEC_UPDATETASK_ERRORTASK_STARTTASK_SUCCESS
400objectError 400 response
404objectError 404 response

Example uses catalogId = 00000000-0000-0000-0000-000000000000, lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string, schemaId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema/{schemaId}/event \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ { "createdAt": "2024-01-01T12:00:00Z", "kind": "string", "link": "string", "message": "string", "type": "TARGET_SPEC_UPDATE" }]

List the tasks of a schema of your lakehouseAlpha

GET
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema/{schemaId}/task

Path parameters

catalogId
required
stringuuid

Catalog ID

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

schemaId
required
stringuuid

Schema ID

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200Task[]successful operation
createdAt
read-only
stringdate-time

Creation date of the task

errors
read-only
TaskError[]

Errors that occurred on the task

finishedAt
read-only
stringdate-time

Ending date of the task

id
read-only
stringuuid

Unique identifier of the task

link
read-only
string

Link to the related resource

message
read-only
string

Description of the task

progress
read-only
TaskProgress[]

Progress steps of the asynchronous operation

startedAt
read-only
stringdate-time

Starting date of the task

status
read-only
TaskStatusEnum

Current global status of the task

ValuesDONEERRORPENDINGRUNNINGSCHEDULEDWAITING_USER_INPUT
type
read-only
string

Type of the task

updatedAt
read-only
stringdate-time

Last update of the task

400objectError 400 response
404objectError 404 response

Example uses catalogId = 00000000-0000-0000-0000-000000000000, lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string, schemaId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema/{schemaId}/task \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ { "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 schema of your lakehouseAlpha

GET
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema/{schemaId}/task/{taskId}

Path parameters

catalogId
required
stringuuid

Catalog ID

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

schemaId
required
stringuuid

Schema ID

taskId
required
stringuuid

Task ID

Response

200Tasksuccessful operation
createdAt
read-only
stringdate-time

Creation date of the task

errors
read-only
TaskError[]

Errors that occurred on the task

finishedAt
read-only
stringdate-time

Ending date of the task

id
read-only
stringuuid

Unique identifier of the task

link
read-only
string

Link to the related resource

message
read-only
string

Description of the task

progress
read-only
TaskProgress[]

Progress steps of the asynchronous operation

startedAt
read-only
stringdate-time

Starting date of the task

status
read-only
TaskStatusEnum

Current global status of the task

ValuesDONEERRORPENDINGRUNNINGSCHEDULEDWAITING_USER_INPUT
type
read-only
string

Type of the task

updatedAt
read-only
stringdate-time

Last update of the task

400objectError 400 response
404objectError 404 response

Example uses catalogId = 00000000-0000-0000-0000-000000000000, lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string, schemaId = 00000000-0000-0000-0000-000000000000, taskId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema/{schemaId}/task/{taskId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "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"}