5.1
Table Of Contents
- vCloud API Programming Guide
- Contents
- vCloud API Programming Guide
- About the VMware vCloud API
- Hello vCloud: A Simplified RESTful Workflow
- Exploring a Cloud
- Summary of vCloud API Browsing Requests
- Retrieve the Login URL and List of Supported API Versions
- Create a Login Session Using the Integrated Identity Provider
- Retrieve a List of Organizations Accessible to You
- Retrieve an Administrative View of a Cloud
- Retrieve a List of vSphere Platform Operations and Objects for a Cloud
- Provisioning an Organization
- Summary of vCloud API Provisioning Requests
- Upload an OVF Package to Create a vApp Template
- Download a vApp Template as OVF
- Upload a Media Image
- Copying and Moving with the vCloud API
- Capturing and Importing vApps
- Cataloging vApp Templates and Media Images
- Creating and Using Independent Disks
- View or Change the Owner of an Object
- Deploying and Operating vApps
- Summary of vCloud API vApp and Virtual Machine Operations Requests
- Create a vApp From a Template
- Compose a vApp From Existing Virtual Machines
- Recompose a vApp to Add or Remove Virtual Machines
- Provide User Input Requested by a Virtual Machine
- Attach or Detach an Independent Disk
- Creating and Using vApp Snapshots
- Operate a vApp
- Configuring vApps and Virtual Machines
- Retrieve the Configuration Links for a vApp
- Retrieve the Configuration Links for a Virtual Machine
- Update Multiple Sections of a Virtual Machine
- Retrieve or Update a Modifiable Section
- Update a vApp Network Configuration
- Update the NetworkConnectionSection of a Virtual Machine
- Retrieve or Modify the CPU Configuration of a Virtual Machine
- Retrieve or Modify the GuestCustomizationSection of a Virtual Machine
- Retrieve or Modify ProductSection Elements
- Retrieve or Modify Groups of Related Sections in a Virtual Machine
- Retrieve or Modify the Hard Disk Configuration of a Virtual Machine
- Update the Storage Profile for a Virtual Machine
- Creating and Managing Organizations
- Summary of Administrative Requests
- Administrator Credentials and Privileges
- Organization Administration
- vDC Administration
- Network Administration
- Catalog Administration
- User and Group Administration
- Working With Roles and Rights
- Controlling Access to vApps and Catalogs
- Managing and Monitoring a Cloud
- Summary of vSphere Platform Extension Requests
- Retrieve or Update System Settings
- Attach a vCenter Server
- Finding Available vCenter Resources
- Create a Provider vDC
- Create an External Network
- Create a Network Pool
- Import a Virtual Machine from vCenter
- Relocate a Virtual Machine to a Different Datastore
- Truststore and Keytab Maintenance
- Retrieve the vSphere URL of an Object
- Working With Object Metadata
- Using the Query Service
- Configuring and Using Blocking Tasks and Notifications
- vCloud Director Extension Services
- XML Representations in the vCloud API
- Index
fail
End the task, setting the status of any transient objects that it created to ERROR.
Task status is set to ERROR.
updateProgress
Reset the timeout value and timeout action for an active task. Use this action
to keep the task alive when it might become subject to a timeout action.
Prerequisites
Verify that you are logged in to the vCloud API as a system administrator.
Procedure
1 Retrieve the list of active blocking tasks.
See “Monitor Blocking Tasks,” on page 276. If you are using an AMQP client to handle blocking tasks,
skip this step. Each blocking task creates its own AMQP message, which contains a reference to the
BlockingTask.
2 Retrieve an individual BlockingTask.
See the request portion of “Example: Handling a Blocking Task,” on page 278.
3 Make a request.
Action Request
resume
POST a BlockingTaskOperationParams element to the Link where
rel="resume"
abort
POST a BlockingTaskOperationParams element to the Link where
rel="abort"
fail
POST a BlockingTaskOperationParams element to the Link where
rel="fail"
updateProgress
POST a BlockingTaskUpdateProgressParams element to the Link where
rel="updateProgress"
Example: Handling a Blocking Task
This request shows how to retrieve a blocking task without using an AMQP client. “Example: Notification
Message Format,” on page 268 shows how to retrieve the same task using information in the AMQP message.
Request:
GET https://vcloud.example.com/api/admin/extension/blockingTask/25
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-07T16:25:18.857+03:00"
timeoutAction="abort"
createdTime="2011-05-02T16:25:18.857+03:00"
name="importSingletonTemplate"
id="urn:vcloud:blockingTask:25"
type="application/vnd.vmware.admin.blockingTask+xml"
href="https://vcloud.example.com/api/admin/extension/blockingTask/25">
<vcloud:Link
vCloud API Programming Guide
278 VMware, Inc.