Extend The Timeout Expiration of an Active Task

You can use the updateProgress link in a BlockingTask to extend the expiration time of an active task.

Prerequisites

This operation is restricted to system administrators.

Procedure

  1. Retrieve the list of active blocking tasks.
    See Monitor Blocking Tasks. If you are using an AMQP client to handle task extension requests, skip this step. Each blocking task creates its own AMQP message, which contains a reference to the BlockingTask mentioned in Step 1.
  2. Retrieve an individual BlockingTask.
    See the request portion of Handling a Blocking Task.
  3. Provide a new timeout value, relative to now, for the task.
    Create a BlockingTaskUpdateProgressParams element that specifies the number of milliseconds until the task times out. See Extend The Timeout Expiration of an Active Task.
  4. POST the BlockingTaskUpdateProgressParams to the updateProgress URL from the BlockingTask.
    The new timeout value is set to now (the time when the updateProgress request is executed) plusTimeoutValueInMilliseconds.

Example: Extend The Timeout Expiration of an Active Task

This request resets the expiration time of the BlockingTask shown in Handling a Blocking Task to ten minutes after the request is processed.

Request:
POST https://vcloud.example.com/api/admin/extension/blockingTask/34/action/updateProgress
Content-Type: application/vnd.vmware.admin.blockingTaskUpdateProgressOperationParams+xml
...
<?xml version="1.0" encoding="UTF-8"?>
<BlockingTaskUpdateProgressParams
   xmlns="http://www.vmware.com/vcloud/extension/v1.5">
   <Message>Giving you ten more minutes...</Message>
   <TimeoutValueInMilliseconds>600000</TimeoutValueInMilliseconds>
</BlockingTaskUpdateProgressParams>

The response includes the entire BlockingTask and shows the new value of the timeoutDate attribute. The value assumes that the request was made at time 2011-05-11T11:50:55. This example omits most of the response.

Response:
200 OK
Content-Type: application/vnd.vmware.admin.blockingTask+xml
...
<vmext:BlockingTask
   xmlns:vmext="http://www.vmware.com/vcloud/extension/v1.5"
   xmlns:vcloud="http://www.vmware.com/vcloud/v1.5"
   status="active"
   timeoutDate="2011-05-11T12:00:55.857+03:00"
   ...
</vmext:BlockingTask>