Skip to content

Groups

All operations require authentication.

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

List the groups of your lakehouseAlpha

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

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

200Group[]successful operation
checksum
read-only
string

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

createdAt
read-only
stringdate-time

Date the group was created

currentState
read-only
GroupCurrentState

Current state of the group, computed by the service

currentTasks
read-only
CurrentTask[]

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

id
read-only
stringuuid

Unique identifier of the group

resourceStatus
read-only
ResourceStatusEnum

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

Last requested specification of the group

updatedAt
read-only
stringdate-time

Date of the last change to the group

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}/group \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ { "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "description": "string", "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": { "description": "string", "name": "string" }, "updatedAt": "2024-01-01T12:00:00Z" }]

Get a group of your lakehouseAlpha

GET
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/group/{groupId}

Path parameters

groupId
required
stringuuid

Group ID

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

Response

200Groupsuccessful operation
checksum
read-only
string

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

createdAt
read-only
stringdate-time

Date the group was created

currentState
read-only
GroupCurrentState

Current state of the group, computed by the service

currentTasks
read-only
CurrentTask[]

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

id
read-only
stringuuid

Unique identifier of the group

resourceStatus
read-only
ResourceStatusEnum

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

Last requested specification of the group

updatedAt
read-only
stringdate-time

Date of the last change to the group

400objectError 400 response
404objectError 404 response

Example uses groupId = 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}/group/{groupId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "description": "string", "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": { "description": "string", "name": "string" }, "updatedAt": "2024-01-01T12:00:00Z"}

Create a group in your lakehouseAlpha

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

Creates the group asynchronously. The response is the group in CREATING, with the creation task in currentTasks: follow it on the task routes of the group, or read the group 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
GroupTargetSpec

Specification of the group to create

Response

200Groupsuccessful operation
checksum
read-only
string

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

createdAt
read-only
stringdate-time

Date the group was created

currentState
read-only
GroupCurrentState

Current state of the group, computed by the service

currentTasks
read-only
CurrentTask[]

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

id
read-only
stringuuid

Unique identifier of the group

resourceStatus
read-only
ResourceStatusEnum

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

Last requested specification of the group

updatedAt
read-only
stringdate-time

Date of the last change to the group

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}/group \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "description": "string", "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": { "description": "string", "name": "string" }, "updatedAt": "2024-01-01T12:00:00Z"}

Delete a group of your lakehouseAlpha

DELETE
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/group/{groupId}

Deletes the group asynchronously. The response is the group in DELETING, with the deletion task in currentTasks. Once the deletion completes, the group and every route under it, its tasks included, answer 404. Deleting a group also deletes its role assignments and its members. The users themselves are kept. The deletion is refused with a 409 when it would remove the last Lakehouse Admin assignment of the lakehouse: assign the Lakehouse Admin role to another identity first.

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

groupId
required
stringuuid

Group ID

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

Response

200Groupsuccessful operation
checksum
read-only
string

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

createdAt
read-only
stringdate-time

Date the group was created

currentState
read-only
GroupCurrentState

Current state of the group, computed by the service

currentTasks
read-only
CurrentTask[]

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

id
read-only
stringuuid

Unique identifier of the group

resourceStatus
read-only
ResourceStatusEnum

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

Last requested specification of the group

updatedAt
read-only
stringdate-time

Date of the last change to the group

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

Example uses groupId = 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}/group/{groupId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "description": "string", "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": { "description": "string", "name": "string" }, "updatedAt": "2024-01-01T12:00:00Z"}

Update a group of your lakehouseAlpha

PUT
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/group/{groupId}

Replaces the group's target specification as a whole. The body carries the complete desired state of every field publicCloud.lakehouse.GroupUpdateTargetSpec exposes — description — so read the group 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 group exists. It is deliberately absent from the update model, and sending it is rejected with a 400.

On a READY group the change is applied at once: the response is 200 with the group READY. On a group in ERROR the change is applied asynchronously, even when the specification is unchanged, to bring the group out of ERROR: the response is 202 with the group UPDATING and the new task in currentTasks. The update is refused with a 409 while the group 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 group'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

groupId
required
stringuuid

Group ID

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

Request body (required)

checksum
string

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

targetSpec
required
GroupUpdateTargetSpec

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

200Groupsuccessful operation
checksum
read-only
string

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

createdAt
read-only
stringdate-time

Date the group was created

currentState
read-only
GroupCurrentState

Current state of the group, computed by the service

currentTasks
read-only
CurrentTask[]

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

id
read-only
stringuuid

Unique identifier of the group

resourceStatus
read-only
ResourceStatusEnum

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

Last requested specification of the group

updatedAt
read-only
stringdate-time

Date of the last change to the group

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

Example uses groupId = 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}/group/{groupId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "description": "string", "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": { "description": "string", "name": "string" }, "updatedAt": "2024-01-01T12:00:00Z"}

List the events of a group of your lakehouseAlpha

GET
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/group/{groupId}/event

Path parameters

groupId
required
stringuuid

Group 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 groupId = 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}/group/{groupId}/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 group of your lakehouseAlpha

GET
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/group/{groupId}/task

Path parameters

groupId
required
stringuuid

Group 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 groupId = 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}/group/{groupId}/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 group of your lakehouseAlpha

GET
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/group/{groupId}/task/{taskId}

Path parameters

groupId
required
stringuuid

Group 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 groupId = 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}/group/{groupId}/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 members of a group of your lakehouseAlpha

GET
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/group/{groupId}/member

Path parameters

groupId
required
stringuuid

Group 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

200Member[]successful operation
checksum
read-only
string

Hash of the target specification of the group member, which never changes after creation

createdAt
read-only
stringdate-time

Date the group member was created

currentState
read-only
MemberCurrentState

Current state of the group member, computed by the service

currentTasks
read-only
CurrentTask[]

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

id
read-only
stringuuid

Unique identifier of the group member

resourceStatus
read-only
ResourceStatusEnum

Readiness status of the group member. The group member 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
MemberTargetSpec

Last requested specification of the group member

updatedAt
read-only
stringdate-time

Date of the last change to the group member

400objectError 400 response
404objectError 404 response

Example uses groupId = 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}/group/{groupId}/member \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ { "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "statusReason": { "code": "CANCELED", "message": "string" }, "userId": "00000000-0000-0000-0000-000000000000" }, "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": { "userId": "00000000-0000-0000-0000-000000000000" }, "updatedAt": "2024-01-01T12:00:00Z" }]

Get a member of a group of your lakehouseAlpha

GET
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/group/{groupId}/member/{memberId}

Path parameters

groupId
required
stringuuid

Group ID

lakehouseId
required
stringuuid

Lakehouse ID

memberId
required
stringuuid

Member ID

projectId
required
string

Project ID

Response

200Membersuccessful operation
checksum
read-only
string

Hash of the target specification of the group member, which never changes after creation

createdAt
read-only
stringdate-time

Date the group member was created

currentState
read-only
MemberCurrentState

Current state of the group member, computed by the service

currentTasks
read-only
CurrentTask[]

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

id
read-only
stringuuid

Unique identifier of the group member

resourceStatus
read-only
ResourceStatusEnum

Readiness status of the group member. The group member 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
MemberTargetSpec

Last requested specification of the group member

updatedAt
read-only
stringdate-time

Date of the last change to the group member

400objectError 400 response
404objectError 404 response

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

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/group/{groupId}/member/{memberId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "statusReason": { "code": "CANCELED", "message": "string" }, "userId": "00000000-0000-0000-0000-000000000000" }, "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": { "userId": "00000000-0000-0000-0000-000000000000" }, "updatedAt": "2024-01-01T12:00:00Z"}

Add a user to a group of your lakehouseAlpha

POST
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/group/{groupId}/member

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

Adding a user to a group gives it every role assigned to the group, so it gives data access. A user is a member of a group at most once. The creation is refused with a 409 while the lakehouse, the group or the user is being deleted, or while a previous membership of the user is still being removed. A member cannot be changed after creation: remove it and add the user again.

Path parameters

groupId
required
stringuuid

Group ID

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

Request body (required)

targetSpec
required
MemberTargetSpec

Specification of the group member to create

Response

200Membersuccessful operation
checksum
read-only
string

Hash of the target specification of the group member, which never changes after creation

createdAt
read-only
stringdate-time

Date the group member was created

currentState
read-only
MemberCurrentState

Current state of the group member, computed by the service

currentTasks
read-only
CurrentTask[]

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

id
read-only
stringuuid

Unique identifier of the group member

resourceStatus
read-only
ResourceStatusEnum

Readiness status of the group member. The group member 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
MemberTargetSpec

Last requested specification of the group member

updatedAt
read-only
stringdate-time

Date of the last change to the group member

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

Example uses groupId = 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}/group/{groupId}/member \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "statusReason": { "code": "CANCELED", "message": "string" }, "userId": "00000000-0000-0000-0000-000000000000" }, "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": { "userId": "00000000-0000-0000-0000-000000000000" }, "updatedAt": "2024-01-01T12:00:00Z"}

Remove a user from a group of your lakehouseAlpha

DELETE
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/group/{groupId}/member/{memberId}

Deletes the group member asynchronously. The response is the group member in DELETING, with the deletion task in currentTasks. Once the deletion completes, the group member and every route under it, its tasks included, answer 404. The user itself is kept.

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

groupId
required
stringuuid

Group ID

lakehouseId
required
stringuuid

Lakehouse ID

memberId
required
stringuuid

Member ID

projectId
required
string

Project ID

Response

200Membersuccessful operation
checksum
read-only
string

Hash of the target specification of the group member, which never changes after creation

createdAt
read-only
stringdate-time

Date the group member was created

currentState
read-only
MemberCurrentState

Current state of the group member, computed by the service

currentTasks
read-only
CurrentTask[]

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

id
read-only
stringuuid

Unique identifier of the group member

resourceStatus
read-only
ResourceStatusEnum

Readiness status of the group member. The group member 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
MemberTargetSpec

Last requested specification of the group member

updatedAt
read-only
stringdate-time

Date of the last change to the group member

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

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

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/group/{groupId}/member/{memberId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "statusReason": { "code": "CANCELED", "message": "string" }, "userId": "00000000-0000-0000-0000-000000000000" }, "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": { "userId": "00000000-0000-0000-0000-000000000000" }, "updatedAt": "2024-01-01T12:00:00Z"}

List the events of a group member of your lakehouseAlpha

GET
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/group/{groupId}/member/{memberId}/event

Path parameters

groupId
required
stringuuid

Group ID

lakehouseId
required
stringuuid

Lakehouse ID

memberId
required
stringuuid

Member 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 groupId = 00000000-0000-0000-0000-000000000000, lakehouseId = 00000000-0000-0000-0000-000000000000, memberId = 00000000-0000-0000-0000-000000000000, projectId = string

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/group/{groupId}/member/{memberId}/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 group member of your lakehouseAlpha

GET
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/group/{groupId}/member/{memberId}/task

Path parameters

groupId
required
stringuuid

Group ID

lakehouseId
required
stringuuid

Lakehouse ID

memberId
required
stringuuid

Member 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 groupId = 00000000-0000-0000-0000-000000000000, lakehouseId = 00000000-0000-0000-0000-000000000000, memberId = 00000000-0000-0000-0000-000000000000, projectId = string

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/group/{groupId}/member/{memberId}/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 group member of your lakehouseAlpha

GET
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/group/{groupId}/member/{memberId}/task/{taskId}

Path parameters

groupId
required
stringuuid

Group ID

lakehouseId
required
stringuuid

Lakehouse ID

memberId
required
stringuuid

Member 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 groupId = 00000000-0000-0000-0000-000000000000, lakehouseId = 00000000-0000-0000-0000-000000000000, memberId = 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}/group/{groupId}/member/{memberId}/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"}