@Path(value="/vapps") @Consumes(value="application/json") @Produces(value="application/vnd.ilandcloud.api.v1.0+json") public interface VappResource extends Serializable
Modifier and Type | Method and Description |
---|---|
TaskResponse |
addOrgVdcNetworkToVapp(String vappUuid,
String networkUuid)
Add a new Org Vdc Network Direct Network to the given vApp.
|
TaskResponse |
addVappNetwork(String vappUuid,
VappNetworkCreateRequest vappNetworkCreateRequest)
Add a new vApp network to the given vApp.
|
TaskResponse |
addVms(String vappUuid,
List<VmCreateRequest> requests)
Add virtual machines to the vApp from templates.
|
TaskResponse |
buildVms(String vappUuid,
List<BuildVmRequest> vms)
Create virtual machines in a vApp
|
TaskResponse |
copyVapp(String vappUuid,
VappCopyMoveRequest spec)
Creates a new vApp in the Vdc based on an existing vapp.
|
TaskResponse |
createSnapshot(String vappUuid,
SnapshotCreateRequest request)
Create a snapshot for the given vApp.
|
TaskResponse |
deleteMetadataForVapp(String vappUuid,
String key)
Delete a specific piece of metadata associated with a Vapp by its key.
|
TaskResponse |
deleteVapp(String vappUuid)
Delete a vApp.
|
InputStream |
downloadVapp(String vappUuid)
Download the vApp as an OVA package.
|
TaskResponse |
enableDownload(String vappUuid)
Enable the download of the vapp.
|
StorageProfileListResponse |
getAvailableStorageProfiles(String vappUuid,
Boolean includeDisabled)
Get the storage profiles available to the vApp.
|
BillResponse |
getBillingForVapp(String vappUuid,
Integer year,
Integer month)
Returns vApp Billing for a given invoice period.
|
DownloadDetailsResponse |
getDownloadDetailsForVapp(String vappUuid)
Gets download details for the vApp.
|
MetadataListResponse |
getMetadataForVapp(String vappUuid)
Retrieve metadata associated with a Vapp.
|
VappNetworkListResponse |
getNetworksFor(String vappUuid)
Get the networks for a given vApp.
|
PerformanceCounterListResponse |
getPerformanceCounters(String vappUuid)
Get the list of performance counters that can be used to query for vApp
performance data.
|
PerfSampleSerieResponse |
getPerformanceForVapp(String vappUuid,
String group,
String name,
String type,
Long start,
Long end,
String interval,
String limit)
Get vApp performance data for the given vApp, counter, and time range.
|
SnapshotResponse |
getSnapshot(String vappUuid)
Get the snapshot for the given vApp.
|
VappStartupSectionItemListResponse |
getStartupSection(String vappUuid)
Get the startup section for a particular Vapp.
|
VappResourceSummaryResponse |
getSummary(String vappUuid)
Get the resource summary for the given vApp.
|
VappResponse |
getVapp(String vAppUuid)
Get a vApp by UUID.
|
VmResourceSummaryMapResponse |
getVmResourceSummariesForVapp(String vappUuid)
Get the map of resource summaries for all VMs in the given vApp.
|
VmListResponse |
getVmsForVapp(String vappUuid)
Get the list of VMs for a vApp.
|
HasSnapshotResponse |
hasVappSnapshot(String vappUuid)
Check for the existence of a snapshot for the given vApp.
|
TaskResponse |
managedShutdown(String vappUuid)
Managed shutdown of a vApp using the vApp's startup section settings.
|
TaskResponse |
moveVapp(String vappUuid,
VappCopyMoveRequest spec)
Creates a new vApp in the Vdc based on an existing vapp.
|
TaskResponse |
powerOffVapp(String vappUuid)
Power off a vApp.
|
TaskResponse |
powerOnVapp(String vappUuid,
boolean forceGuestCustomization)
Power on a vApp.
|
TaskResponse |
rebootVapp(String vappUuid)
Reboot a vApp.
|
TaskResponse |
removeSnapshot(String vappUuid)
Remove a snapshot from a vApp.
|
TaskResponse |
resetVapp(String vappUuid)
Reset a vApp.
|
TaskResponse |
restoreSnapshot(String vappUuid)
Restore a vApp from a snapshot.
|
void |
sendEventHistoryForVapp(String vappUuid,
EventHistoryEmailRequest request)
Email a CSV report with all event history for a given Vapp.
|
TaskResponse |
shutdownVapp(String vappUuid)
Shutdown a vApp.
|
TaskResponse |
suspendVapp(String vappUuid)
Suspend a vApp.
|
TaskResponse |
updateDescription(String vappUuid,
VappDescriptionUpdateRequest request)
Update the description for a vapp.
|
TaskResponse |
updateMetadataForVapp(String vappUuid,
List<UpdateMetadataRequest> metadata)
Add / update metadata associated with a Vapp.
|
TaskResponse |
updateName(String vappUuid,
VappRenameRequest request)
Rename a vApp.
|
TaskResponse |
updateRuntimeLease(String vappUuid,
RuntimeLeaseUpdateRequest request)
Update the runtime lease for the given vApp.
|
TaskResponse |
updateStartupSection(String vappUuid,
List<VappStartupSectionItemRequest> startupSection)
Update the startup section of a particular Vapp.
|
TaskResponse |
updateStorageLease(String vappUuid,
StorageLeaseUpdateRequest request)
Update the storage lease for the given vApp.
|
@GET @Path(value="/{vappUuid}/billing") @Produces(value="application/vnd.ilandcloud.api.v1.0+json") BillResponse getBillingForVapp(@PathParam(value="vappUuid") String vappUuid, @QueryParam(value="year") Integer year, @QueryParam(value="month") Integer month)
vappUuid
- vapp uuidyear
- the invoice period year (defaults to current year)month
- the invoice period month (defaults to the current month) must
be in range 1-12@POST @Path(value="/{vappUuid}/actions/update-description") @Consumes(value="application/json") @Produces(value="application/vnd.ilandcloud.api.v1.0+json") TaskResponse updateDescription(@PathParam(value="vappUuid") String vappUuid, VappDescriptionUpdateRequest request)
vappUuid
- vapp uuidrequest
- request to update vapp description@GET @Path(value="/{vappUuid}/startup-section") @Produces(value="application/vnd.ilandcloud.api.v1.0+json") VappStartupSectionItemListResponse getStartupSection(@PathParam(value="vappUuid") String vappUuid)
vappUuid
- vapp uuid@POST @Path(value="/{vappUuid}/actions/update-startup-section") @Consumes(value="application/json") @Produces(value="application/vnd.ilandcloud.api.v1.0+json") TaskResponse updateStartupSection(@PathParam(value="vappUuid") String vappUuid, List<VappStartupSectionItemRequest> startupSection)
vappUuid
- vapp uuidstartupSection
- of instances@POST @Path(value="/{vappUuid}/actions/email-event-history") @Consumes(value="application/json") @Produces(value="application/vnd.ilandcloud.api.v1.0+json") void sendEventHistoryForVapp(@PathParam(value="vappUuid") String vappUuid, EventHistoryEmailRequest request)
vappUuid
- vapp uuidrequest
- email address request@GET @Path(value="/{vappUuid}/metadata") @Produces(value="application/vnd.ilandcloud.api.v1.0+json") MetadataListResponse getMetadataForVapp(@PathParam(value="vappUuid") String vappUuid)
vappUuid
- vm uuid@PUT @Path(value="/{vappUuid}/metadata") @Consumes(value="application/json") @Produces(value="application/vnd.ilandcloud.api.v1.0+json") TaskResponse updateMetadataForVapp(@PathParam(value="vappUuid") String vappUuid, List<UpdateMetadataRequest> metadata)
vappUuid
- vapp uuidmetadata
- of instances@DELETE @Path(value="/{vappUuid}/metadata/{key}") @Produces(value="application/vnd.ilandcloud.api.v1.0+json") TaskResponse deleteMetadataForVapp(@PathParam(value="vappUuid") String vappUuid, @PathParam(value="key") String key)
vappUuid
- vapp uuidkey
- metadata key@POST @Path(value="/{vappUuid}/actions/copy") @Consumes(value="application/json") @Produces(value="application/vnd.ilandcloud.api.v1.0+json") TaskResponse copyVapp(@PathParam(value="vappUuid") String vappUuid, VappCopyMoveRequest spec)
vappUuid
- vapp uuidspec
- specifications for newly copyied vapp@POST @Path(value="/{vappUuid}/actions/move") @Consumes(value="application/json") @Produces(value="application/vnd.ilandcloud.api.v1.0+json") TaskResponse moveVapp(@PathParam(value="vappUuid") String vappUuid, VappCopyMoveRequest spec)
vappUuid
- vapp uuidspec
- specifications for newly copyied vapp@POST @Path(value="/{vappUuid}/org-vdc-network/{networkUuid}") @Produces(value="application/vnd.ilandcloud.api.v1.0+json") TaskResponse addOrgVdcNetworkToVapp(@PathParam(value="vappUuid") String vappUuid, @PathParam(value="networkUuid") String networkUuid)
vappUuid
- vapp uuidnetworkUuid
- network uuid@POST @Path(value="/{vappUuid}/actions/add-vapp-network") @Consumes(value="application/json") @Produces(value="application/vnd.ilandcloud.api.v1.0+json") TaskResponse addVappNetwork(@PathParam(value="vappUuid") String vappUuid, VappNetworkCreateRequest vappNetworkCreateRequest)
vappUuid
- vapp uuidvappNetworkCreateRequest
- add vapp network request@POST @Path(value="/{vappUuid}/actions/update-name") @Consumes(value="application/json") @Produces(value="application/vnd.ilandcloud.api.v1.0+json") TaskResponse updateName(@PathParam(value="vappUuid") String vappUuid, VappRenameRequest request)
vappUuid
- vapp uuidrequest
- request for renaming a vApp@DELETE @Path(value="/{vappUuid}") @Produces(value="application/vnd.ilandcloud.api.v1.0+json") TaskResponse deleteVapp(@PathParam(value="vappUuid") String vappUuid)
vappUuid
- vapp uuid@GET @Path(value="/{vappUuid}/snapshot") @Produces(value="application/vnd.ilandcloud.api.v1.0+json") SnapshotResponse getSnapshot(@PathParam(value="vappUuid") String vappUuid)
vappUuid
- vapp uuid@GET @Path(value="/{vappUuid}/has-snapshot") @Produces(value="application/vnd.ilandcloud.api.v1.0+json") HasSnapshotResponse hasVappSnapshot(@PathParam(value="vappUuid") String vappUuid)
vappUuid
- vapp uuid@POST @Path(value="/{vappUuid}/actions/create-snapshot") @Consumes(value="application/json") @Produces(value="application/vnd.ilandcloud.api.v1.0+json") TaskResponse createSnapshot(@PathParam(value="vappUuid") String vappUuid, SnapshotCreateRequest request)
vappUuid
- vapp uuidrequest
- request for creating a snapshot of a vApp@POST @Path(value="/{vappUuid}/actions/restore-snapshot") @Produces(value="application/vnd.ilandcloud.api.v1.0+json") TaskResponse restoreSnapshot(@PathParam(value="vappUuid") String vappUuid)
vappUuid
- vapp uuid@POST @Path(value="/{vappUuid}/actions/remove-snapshot") @Produces(value="application/vnd.ilandcloud.api.v1.0+json") TaskResponse removeSnapshot(@PathParam(value="vappUuid") String vappUuid)
vappUuid
- vapp uuid@POST @Path(value="/{vappUuid}/actions/update-runtime-lease") @Produces(value="application/vnd.ilandcloud.api.v1.0+json") TaskResponse updateRuntimeLease(@PathParam(value="vappUuid") String vappUuid, RuntimeLeaseUpdateRequest request)
vappUuid
- vapp uuidrequest
- lease expiration from now in (seconds)@POST @Path(value="/{vappUuid}/actions/update-storage-lease") @Produces(value="application/vnd.ilandcloud.api.v1.0+json") TaskResponse updateStorageLease(@PathParam(value="vappUuid") String vappUuid, StorageLeaseUpdateRequest request)
vappUuid
- vapp uuidrequest
- lease expiration from now in (seconds)@POST @Path(value="/{vappUuid}/actions/add-vms-from-templates") @Consumes(value="application/json") @Produces(value="application/vnd.ilandcloud.api.v1.0+json") TaskResponse addVms(@PathParam(value="vappUuid") String vappUuid, List<VmCreateRequest> requests)
vappUuid
- vapp uuidrequests
- list of add vm requests@POST @Path(value="/{vappUuid}/actions/build-vms") @Consumes(value="application/json") @Produces(value="application/vnd.ilandcloud.api.v1.0+json") TaskResponse buildVms(@PathParam(value="vappUuid") String vappUuid, List<BuildVmRequest> vms)
vappUuid
- vapp uuidvms
- list of vapp vms@GET @Path(value="/{vappUuid}/networks") @Produces(value="application/vnd.ilandcloud.api.v1.0+json") VappNetworkListResponse getNetworksFor(@PathParam(value="vappUuid") String vappUuid)
vappUuid
- vapp uuid@GET @Path(value="/{vappUuid}/performance/{group}::{name}::{type}") @Produces(value="application/vnd.ilandcloud.api.v1.0+json") PerfSampleSerieResponse getPerformanceForVapp(@PathParam(value="vappUuid") String vappUuid, @PathParam(value="group") String group, @PathParam(value="name") String name, @PathParam(value="type") String type, @QueryParam(value="start") Long start, @QueryParam(value="end") Long end, @QueryParam(value="interval") String interval, @QueryParam(value="limit") String limit)
vappUuid
- vapp uuidgroup
- the performance counter groupname
- the performance counter nametype
- the performance counter typestart
- start dateend
- end dateinterval
- intervallimit
- limit@GET @Path(value="/{vappUuid}/performance-counters") @Produces(value="application/vnd.ilandcloud.api.v1.0+json") PerformanceCounterListResponse getPerformanceCounters(@PathParam(value="vappUuid") String vappUuid)
vappUuid
- vApp UUID@POST @Path(value="/{vappUuid}/actions/poweron") @Produces(value="application/vnd.ilandcloud.api.v1.0+json") TaskResponse powerOnVapp(@PathParam(value="vappUuid") String vappUuid, @QueryParam(value="forceGuestCustomization") boolean forceGuestCustomization)
vappUuid
- vapp uuidforceGuestCustomization
- optional param to force guest
re-customization on restart defaults to false@POST @Path(value="/{vappUuid}/actions/poweroff") @Produces(value="application/vnd.ilandcloud.api.v1.0+json") TaskResponse powerOffVapp(@PathParam(value="vappUuid") String vappUuid)
vappUuid
- vapp uuid@POST @Path(value="/{vappUuid}/actions/managed-shutdown") @Produces(value="application/vnd.ilandcloud.api.v1.0+json") TaskResponse managedShutdown(@PathParam(value="vappUuid") String vappUuid)
vappUuid
- vapp uuid@POST @Path(value="/{vappUuid}/actions/suspend") @Produces(value="application/vnd.ilandcloud.api.v1.0+json") TaskResponse suspendVapp(@PathParam(value="vappUuid") String vappUuid)
vappUuid
- vapp uuid@POST @Path(value="/{vappUuid}/actions/shutdown") @Produces(value="application/vnd.ilandcloud.api.v1.0+json") TaskResponse shutdownVapp(@PathParam(value="vappUuid") String vappUuid)
vappUuid
- vapp uuid@POST @Path(value="/{vappUuid}/actions/reset") @Produces(value="application/vnd.ilandcloud.api.v1.0+json") TaskResponse resetVapp(@PathParam(value="vappUuid") String vappUuid)
vappUuid
- vapp uuid@POST @Path(value="/{vappUuid}/actions/reboot") @Produces(value="application/vnd.ilandcloud.api.v1.0+json") TaskResponse rebootVapp(@PathParam(value="vappUuid") String vappUuid)
vappUuid
- vapp uuid@GET @Path(value="/{vappUuid}") @Produces(value="application/vnd.ilandcloud.api.v1.0+json") VappResponse getVapp(@PathParam(value="vappUuid") String vAppUuid)
vAppUuid
- vapp uuid@GET @Path(value="/{vAppUuid}/vms") @Produces(value="application/vnd.ilandcloud.api.v1.0+json") VmListResponse getVmsForVapp(@PathParam(value="vAppUuid") String vappUuid)
vappUuid
- vapp uuid@GET @Path(value="/{vappUuid}/summary") @Produces(value="application/vnd.ilandcloud.api.v1.0+json") VappResourceSummaryResponse getSummary(@PathParam(value="vappUuid") String vappUuid)
vappUuid
- vapp uuid@POST @Path(value="/{vappUuid}/actions/enable-download") @Produces(value="application/vnd.ilandcloud.api.v1.0+json") TaskResponse enableDownload(@PathParam(value="vappUuid") String vappUuid)
downloadVapp(String)
endpoint when task
progress is synced to download the vapp.vappUuid
- String
vapp uuidTaskResponse
core task@GET @Path(value="/{vappUuid}/download") @Produces(value="application/vnd.ilandcloud.api.v1.0+octet-stream") InputStream downloadVapp(@PathParam(value="vappUuid") String vappUuid)
enableDownload(String)
must
be called and synced before attempting to download the vapp.vappUuid
- String
vapp uuidInputStream
ova file@GET @Path(value="/{vappUuid}/download-details") @Produces(value="application/vnd.ilandcloud.api.v1.0+json") DownloadDetailsResponse getDownloadDetailsForVapp(@PathParam(value="vappUuid") String vappUuid)
vappUuid
- String
vapp uuid@GET @Path(value="{vappUuid}/vm-summary-map") @Produces(value="application/vnd.ilandcloud.api.v1.0+json") VmResourceSummaryMapResponse getVmResourceSummariesForVapp(@PathParam(value="vappUuid") String vappUuid)
vappUuid
- vApp uuid@GET @Path(value="/{vappUuid}/available-storage-profiles") @Produces(value="application/vnd.ilandcloud.api.v1.0+json") StorageProfileListResponse getAvailableStorageProfiles(@PathParam(value="vappUuid") String vappUuid, @QueryParam(value="includeDisabled") Boolean includeDisabled)
vappUuid
- vApp uuidincludeDisabled
- whether to include disabled profiles (defaults to
false if not explicitly provided)Copyright © 2019 iland Internet Solutions, Corp. All rights reserved.