A system administrator can retrieve a list of all pending and active blocking tasks. Links in the returned BlockingTask element allow the administrator to take action on the request.

In addition to being subject to programmatic action by an AMQP client (see Notification Message Format), blocking tasks can be monitored and managed by a system administrator using the VMware Cloud Director API.

Prerequisites

This operation is restricted to system administrators.

Procedure

  1. Retrieve the list of blocking tasks.
    See the request portion of Retrieve a List of Blocking Tasks. If the BlockingTaskReferences element contains no Reference elements, no blocking tasks are currently active in the system.
  2. Retrieve an individual blocking task from one of the Reference elements in the response.
    See the request portion of Handling a Blocking Task.
  3. Use one of the action links in the BlockingTask to take action on the task.
    See the response portion of Handling a Blocking Task.

Example: Retrieve a List of Blocking Tasks

Request: 
GET https://vcloud.example.com/api/admin/extension/blockingTasks/
Response: 
200 OK
Content-Type: application/vnd.vmware.admin.blockingTaskList+xml
...
<vmext:BlockingTaskReferences
   xmlns:vmext="http://www.vmware.com/vcloud/extension/v1.5"
   xmlns:vcloud="http://www.vmware.com/vcloud/v1.5"
   ... >
   <vcloud:Link
      rel="up"
      type="application/vnd.vmware.admin.vmwExtension+xml"
      href="https://vcloud.example.com/api/admin/extension" />
   <vcloud:Reference
      type="application/vnd.vmware.admin.blockingTask+xml"
      name="vdcUpdateTemplate"
      href="https://vcloud.example.com/api/admin/extension/blockingTask/28" />
   <vcloud:Reference
      type="application/vnd.vmware.admin.blockingTask+xml"
      name="vdcComposeVapp"
      href="https://vcloud.example.com/api/admin/extension/blockingTask/25" />
   <vcloud:Reference
      type="application/vnd.vmware.admin.blockingTask+xml"
      name="vdcUploadMedia"
      href="https://vcloud.example.com/api/admin/extension/blockingTask/12" />
</vmext:BlockingTaskReferences>