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
Procedure
1 Retrieve the XML representation of the service.
This request retrieves the XML representation of the service created in “Example: Register an Extension
Service,” on page 285:
GET https://vcloud.example.com/api/admin/extension/service/45
2 Examine the response to find the Link for listing service links.
This Link has the following form:
<vcloud:Link
rel="down:serviceLinks"
type="application/vnd.vmware.vcloud.query.records+xml"
href="https://vcloud.example.com/api/admin/extension/service/44/links" />
3 Make a GET request to the link described in Step 2.
4 Examine the response to find the ServiceLinkRecord that represents the service link to delete.
5 Make a DELETE request to the URL in the href attribute value of that ServiceLinkRecord.
Example: Delete a Service Link
Start by getting the service's list of service links.
Request:
GET https://vcloud.example.com/api/admin/extension/service/45
Response:
<?xml version="1.0" encoding="UTF-8"?>
<QueryResultRecords
total="3"
pageSize="25"
page="1"
name="serviceLink"
type="application/vnd.vmware.vcloud.query.records+xml"
... >
...
<ServiceLinkRecord
service="https://vcloud.example.com/api/admin/extension/service/45"
resourceType="application/vnd.vmware.vcloud.vApp+xml"
rel="down"
mimeType="application/vnd.vmware.vcloud.backupList+xml"
linkHref="{baseUri}api/vApp/vapp-{resourceId}/backups"
href="https://vcloud.example.com/api/admin/extension/service/link/01ca..." />
<ServiceLinkRecord
service="https://vcloud.example.com/api/admin/extension/service/45"
resourceType="application/vnd.vmware.vcloud.org+xml"
rel="down"
mimeType="application/vnd.vmware.vcloud.backupList+xml"
linkHref="{baseUri}org/{resourceId}"
href="https://vcloud.example.com/api/admin/extension/service/link/a624..." />
<ServiceLinkRecord
service="https://vcloud.example.com/api/admin/extension/service/45"
resourceType="application/vnd.vmware.vcloud.vApp+xml"
rel="backup"
vCloud API Programming Guide
290 VMware, Inc.