VMware Cloud Director API - BlockingTask

VMware Cloud Director API - BlockingTask


Describes a blocking task request. Contains references to objects involved in the task.
Media type(s):
XML Representation:
<BlockingTask xmlns="http://www.vmware.com/vcloud/extension/v1.5" xmlns:vcloud_v1.5="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
        name="xs:string" createdTime="xs:dateTime" timeoutDate="xs:dateTime" timeoutAction="xs:string"
    <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string" model="xs:string"/>
    <Description> xs:string </Description>
        <vcloud_v1.5:Task href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
                name="xs:string" status="xs:string" operation="xs:string" operationName="xs:string"
                serviceNamespace="xs:string" startTime="xs:dateTime" endTime="xs:dateTime" expiryTime="xs:dateTime"
            <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string" model="xs:string"/>
            <Description> xs:string </Description>
            <vcloud_v1.5:Tasks> vcloud_v1.5:TasksInProgressType </vcloud_v1.5:Tasks>
            <vcloud_v1.5:Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <vcloud_v1.5:Error stackTrace="xs:string" message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string"
                <vcloud_v1.5:TenantError message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"/>
            <vcloud_v1.5:User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <vcloud_v1.5:Organization href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Progress> xs:int </Progress>
            <Params> ... </Params>
            <Details> xs:string </Details>
                <vcloud_v1.5:VcTask name="xs:string" moref="xs:string" status="xs:string" description="xs:string"
                        errorMessage="xs:string" objectName="xs:string" objectType="xs:string" objectMoref="xs:string"
                        virtualCenterID="xs:string" startTime="xs:dateTime" endTime="xs:dateTime"/>
                <ResultContent> ... </ResultContent>
                <vcloud_v1.5:ResultReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    <vcloud_v1.5:Organization href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    <vcloud_v1.5:User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    <vcloud_v1.5:TaskOwner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>


Attribute Type Required Modifiable Since Deprecated Description
href anyURI No always 1.5 The URI of the entity.
type string No always 1.5 The MIME type of the entity.
id string No none 1.5 The entity identifier, expressed in URN format. The value of this attribute uniquely identifies the entity, persists for the life of the entity, and is never reused.
operationKey string No create 5.1 Optional unique identifier to support idempotent semantics for create and delete operations.
name string Yes always 1.5 The name of the entity.
createdTime dateTime Yes none 1.5 The date/time that the blocking task was created.
timeoutDate dateTime Yes none 1.5 The date/time at which this request times out. Requests time out if not acted upon within a configured interval. When a request times out, the action specified in timeoutAction is taken automatically.
timeoutAction string Yes none 1.5 Action that is automatically taken when a request times out. One of:
resume (The task will be resumed.)
abort (The task will be aborted. Transient objects are cleaned up. Task status is set to ABORTED.)
fail (The task will be failed. Transient object status and task status are set to ERROR.)
status string Yes none 1.5 Status of the blocking task.


Element Type Required Modifiable Since Deprecated Description
Description string No always 1.5 Optional description.
Link LinkType No none 1.5 A reference to an entity or operation associated with this object.
Organization ReferenceType Yes none 1.5 The organization in which the blocking task runs.
TaskOwner ReferenceType No none 1.5 The owner of the blocking task.
Tasks TasksInProgressType No none 1.5 A list of queued, running, or recently completed tasks associated with this entity.
User ReferenceType No none 1.5 The user who triggered the blocking task.
VCloudExtension VCloudExtensionType No always 1.5 An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.


CRUD Operation Description Since Deprecated
create POST /admin/extension/blockingTask/{id}/action/updateProgress Extend the expiration timeout of an active task. 1.5
read GET /admin/extension/blockingTask/{id} Retrieve the representation of a blocking task. 1.5
action POST /admin/extension/blockingTask/{id}/action/abort Abort a blocking task. 1.5
action POST /admin/extension/blockingTask/{id}/action/fail Fail a blocking task. 1.5
action POST /admin/extension/blockingTask/{id}/action/resume Resume a blocking task. 1.5