v1

latestSwagger 2.02026-08-061,9128853.7 MB
Tasks

Marks the given task as canceled.

post/{spaceId}/tasks/{id}/cancel

Path parameters

spaceIdstring required

The ID of the space containing the resources.

idstring required

ID of the Task to cancel

Response

Returned in response to CancelServerTaskRequest. If the ServerTask cancellation failed, clients should receive an error instead.

Argumentsobject
CanRerunboolean
Completedstring
CompletedTimestring date-time
Descriptionstring
Durationstring
ErrorMessagestring
EstimatedRemainingQueueDurationSecondsinteger
FinishedSuccessfullyboolean
HasBeenPickedUpByProcessorboolean
HasPendingInterruptionsboolean
HasPendingPreconditionsboolean
HasWarningsOrErrorsboolean
Idstring
IsCompletedboolean
LastModifiedBystring
LastModifiedOnstring date-time
LastUpdatedTimestring date-time
Linksobject
Namestring
PendingInterruptionTypesstring[]
PendingPreconditionTypesstring[]
ProjectIdstring
QueueTimestring date-time
QueueTimeExpirystring date-time
ServerNodestring
SpaceIdstring
StartTimestring date-time
State'Queued' | 'Executing' | 'Failed' | 'Canceled' | 'TimedOut' | 'Success' | 'Cancelling'