com.iland.core.web.rest.api

Interface VdcResource

All Superinterfaces:

Serializable

@Path(value="/vdcs")
 @Consumes(value="application/json")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
public interface VdcResource
extends Serializable

Vdc Resource Interface v1.

Author:

Cory Snyder

Method Summary

Modifier and Type	Method and Description
TaskResponse	addVappFromTemplate(String vdcUuid, VdcAddVappFromTemplateRequest request) Add a vApp from a vApp template.
TaskResponse	buildVapp(String vdcUuid, BuildVappRequest spec) Create a vApp from scratch to the given VDC.
TaskResponse	deleteMetadataForVdc(String vdcUuid, String key) Delete a specific piece of metadata associated with a Vdc by its key.
TaskResponse	generateVmInventoryReportForVdc(String vdcUuid, boolean emailOnCompletion, String email) Generate a VM inventory report for the specified vDC.
BillResponse	getBillingForVdc(String vdcUuid, Integer year, Integer month) Returns vDC billing for a given invoice period.
BillingSampleSerieResponse	getCostOverInvoicePeriodSerie(String vdcUuid, Integer year, Integer month, List<String> additionalFields) Get a serie detailing the hourly cost over an invoice period for a given vDC.
EdgeListResponse	getEdgesForVdc(String vdcUuid) Get the edges for the vDC.
MediaListResponse	getMediasForVdc(String vdcUuid) Get medias available to a given Vdc.
MetadataListResponse	getMetadataForVdc(String vdcUuid) Retrieve metadata associated with a Vdc.
OrgVdcNetworkListResponse	getOrgVdcNetworksForVdc(String vdcUuid) Get org vdc networks for a given VDC.
PerformanceCounterListResponse	getPerformanceCountersForVdc(String vdcUuid) Get the list of performance counters that can be used to query for vDC performance data.
PerfSampleSerieResponse	getPerformanceForVdc(String vdcUuid, String group, String name, String type, Long start, Long end, String interval, String limit) Get VDC performance data for the given VDC, counter, and time range.
StorageProfileListResponse	getStorageProfiles(String vdcUuid, Boolean includeDisabled) Get the storage profiles available to the vDC.
VdcStorageProfileSummaryResponse	getStorageProfileSummary(String vdcUuid, Integer year, Integer month) Gets a summary of storage profile usage for a specified vDC and billing period.
VdcResourceSummaryResponse	getSummaryForVdc(String vdcUuid) Get the resource summary for the given VDC.
BillListResponse	getVappBills(String vdcUuid, Integer month, Integer year) Gets all vapp bills for a specified vDC.
VappResourceSummaryMapResponse	getVappResourceSummaries(String vdcUuid) Get the map of resource summaries for all vApps in the given vDC.
VappListResponse	getVappsForVdc(String vdcUuid) Get a list of vApps for a VDC.
VdcResponse	getVdc(String vdcUuid, Long timestamp) Get a VDC by its UUID.
BillingSummaryResponse	getVdcCurrentBilling(String vdcUuid) Get the current billing for a VDC.
BillListResponse	getVmBills(String vdcUuid, Integer month, Integer year) Gets all vm bills for a specified vDC.
ReportHeaderListResponse	getVmInventoryReportsForVdc(String vdcUuid, ReportFormat reportFormat) Get the VM inventory reports for vDC.
VmResourceSummaryMapResponse	getVmResourceSummaries(String vdcUuid) Get the map of resource summaries for all VMs in the given vDC.
VmListResponse	getVmsForVdc(String vdcUuid) Get a list of VMs for a VDC.
void	sendEventHistoryForVdc(String vdcUuid, EventHistoryEmailRequest spec) Email a CSV report with all event history for a given Vdc.
TaskResponse	updateMetadataForVdc(String vdcUuid, List<UpdateMetadataRequest> metadata) Add / update metadata associated with a Vdc.

Method Detail

getVdc

@GET
 @Path(value="/{vdcUuid}")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
VdcResponse getVdc(@PathParam(value="vdcUuid")
                                                                                                                String vdcUuid,
                                                                                                                @QueryParam(value="timestamp")
                                                                                                                Long timestamp)

Get a VDC by its UUID.

Parameters:

vdcUuid - vdc uuid

timestamp - optional timestamp parameter to get the vDC details at a certain point in time.

Returns:

virtual data center

getVappsForVdc

@GET
 @Path(value="/{vdcUuid}/vapps")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
VappListResponse getVappsForVdc(@PathParam(value="vdcUuid")
                                                                                                                                   String vdcUuid)

Get a list of vApps for a VDC.

Parameters:

vdcUuid - vdc uuid

Returns:

list of vApps for the VDC

getVmsForVdc

@GET
 @Path(value="/{vdcUuid}/vms")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
VmListResponse getVmsForVdc(@PathParam(value="vdcUuid")
                                                                                                                             String vdcUuid)

Get a list of VMs for a VDC.

Parameters:

vdcUuid - vdc uuid

Returns:

list of VMs for the VDC

getVdcCurrentBilling

@GET
 @Path(value="/{vdcUuid}/billing-summary")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
BillingSummaryResponse getVdcCurrentBilling(@PathParam(value="vdcUuid")
                                                                                                                                                         String vdcUuid)

Get the current billing for a VDC. Excluded from public API as its really only intended for consumption in console.

Parameters:

vdcUuid - vdc uuid

Returns:

current billing for the VDC

getBillingForVdc

@GET
 @Path(value="/{vdcUuid}/billing")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
BillResponse getBillingForVdc(@PathParam(value="vdcUuid")
                                                                                                                                   String vdcUuid,
                                                                                                                                   @QueryParam(value="year")
                                                                                                                                   Integer year,
                                                                                                                                   @QueryParam(value="month")
                                                                                                                                   Integer month)

Returns vDC billing for a given invoice period. If month and year are not explicitly supplied the current invoice period is used.

Parameters:

vdcUuid - vdc uuid

year - the invoice period year (defaults to current year)

month - the invoice period month (defaults to the current month) must be in range 1-12

Returns:

billing for the vDC and given invoice period

getVappBills

@GET
 @Path(value="/{vdcUuid}/vapp-bills")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
BillListResponse getVappBills(@PathParam(value="vdcUuid")
                                                                                                                                      String vdcUuid,
                                                                                                                                      @QueryParam(value="month")
                                                                                                                                      Integer month,
                                                                                                                                      @QueryParam(value="year")
                                                                                                                                      Integer year)

Gets all vapp bills for a specified vDC. Returns the current month bills by default, but query parameters can be used to select an earlier set of bills.

Parameters:

vdcUuid - vdc uuid

Returns:

vapp bills for the specified vDC

getVmBills

@GET
 @Path(value="/{vdcUuid}/vm-bills")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
BillListResponse getVmBills(@PathParam(value="vdcUuid")
                                                                                                                                  String vdcUuid,
                                                                                                                                  @QueryParam(value="month")
                                                                                                                                  Integer month,
                                                                                                                                  @QueryParam(value="year")
                                                                                                                                  Integer year)

Gets all vm bills for a specified vDC. Returns the current month bills by default, but query parameters can be used to select an earlier set of bills.

Parameters:

vdcUuid - vdc uuid

Returns:

vm bills for the specified vDC

sendEventHistoryForVdc

@POST
 @Path(value="/{vdcUuid}/actions/email-event-history")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
void sendEventHistoryForVdc(@PathParam(value="vdcUuid")
                                                                                                                                                      String vdcUuid,
                                                                                                                                                      EventHistoryEmailRequest spec)

Email a CSV report with all event history for a given Vdc.

Parameters:

vdcUuid - vdc uuid

spec - email address spec

getMetadataForVdc

@GET
 @Path(value="/{vdcUuid}/metadata")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
MetadataListResponse getMetadataForVdc(@PathParam(value="vdcUuid")
                                                                                                                                             String vdcUuid)

Retrieve metadata associated with a Vdc.

Parameters:

vdcUuid - vdc uuid

Returns:

list of metadata for the given vdc

updateMetadataForVdc

@PUT
 @Path(value="/{vdcUuid}/metadata")
 @Consumes(value="application/json")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
TaskResponse updateMetadataForVdc(@PathParam(value="vdcUuid")
                                                                                                                                                                             String vdcUuid,
                                                                                                                                                                             List<UpdateMetadataRequest> metadata)

Add / update metadata associated with a Vdc.

Parameters:

vdcUuid - vdc uuid

metadata - of instances

Returns:

asynchronous task details

deleteMetadataForVdc

@DELETE
 @Path(value="/{vdcUuid}/metadata/{key}")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
TaskResponse deleteMetadataForVdc(@PathParam(value="vdcUuid")
                                                                                                                                                 String vdcUuid,
                                                                                                                                                 @PathParam(value="key")
                                                                                                                                                 String key)

Delete a specific piece of metadata associated with a Vdc by its key.

Parameters:

vdcUuid - vdc uuid

key - metadata key

Returns:

asynchronous task details

getMediasForVdc

@GET
 @Path(value="/{vdcUuid}/medias")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
MediaListResponse getMediasForVdc(@PathParam(value="vdcUuid")
                                                                                                                                      String vdcUuid)

Get medias available to a given Vdc.

Parameters:

vdcUuid - vdc uuid

Returns:

list of medias for the vdc

getStorageProfiles

@GET
 @Path(value="/{vdcUuid}/storage-profiles")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
StorageProfileListResponse getStorageProfiles(@PathParam(value="vdcUuid")
                                                                                                                                                            String vdcUuid,
                                                                                                                                                            @QueryParam(value="includeDisabled")
                                                                                                                                                            Boolean includeDisabled)

Get the storage profiles available to the vDC.

Parameters:

vdcUuid - vdc uuid

includeDisabled - whether to include disabled profiles (defaults to false if not explicitly provided)

Returns:

list of storage profiles available to the VDC

addVappFromTemplate

@POST
 @Path(value="/{vdcUuid}/actions/add-vapp-from-template")
 @Consumes(value="application/json")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
TaskResponse addVappFromTemplate(@PathParam(value="vdcUuid")
                                                                                                                                                                                                   String vdcUuid,
                                                                                                                                                                                                   VdcAddVappFromTemplateRequest request)

Add a vApp from a vApp template.

Parameters:

vdcUuid - vdc uuid

request - specification for new vApp paramters

Returns:

asynchronous task details

buildVapp

@POST
 @Path(value="/{vdcUuid}/actions/build-vapp")
 @Consumes(value="application/json")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
TaskResponse buildVapp(@PathParam(value="vdcUuid")
                                                                                                                                                                             String vdcUuid,
                                                                                                                                                                             BuildVappRequest spec)

Create a vApp from scratch to the given VDC.

Parameters:

vdcUuid - vdc uuid

spec - specification for the new vApp

Returns:

asynchronous task details

getOrgVdcNetworksForVdc

@GET
 @Path(value="/{vdcUuid}/org-vdc-networks")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
OrgVdcNetworkListResponse getOrgVdcNetworksForVdc(@PathParam(value="vdcUuid")
                                                                                                                                                                String vdcUuid)

Get org vdc networks for a given VDC.

Parameters:

vdcUuid - vdc uuid

Returns:

list of networks

getPerformanceForVdc

@GET
 @Path(value="/{vdcUuid}/performance/{group}::{name}::{type}")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
PerfSampleSerieResponse getPerformanceForVdc(@PathParam(value="vdcUuid")
                                                                                                                                                                              String vdcUuid,
                                                                                                                                                                              @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)

Get VDC performance data for the given VDC, counter, and time range.

Parameters:

vdcUuid - vDC UUID

group - the performance counter group

name - the performance counter name

type - the performance counter type

start - start date

end - end date

interval - interval

limit - limit

Returns:

performance samples serie for the given vdc, counter and date range

getPerformanceCountersForVdc

@GET
 @Path(value="/{vdcUuid}/performance-counters")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
PerformanceCounterListResponse getPerformanceCountersForVdc(@PathParam(value="vdcUuid")
                                                                                                                                                                              String vdcUuid)

Get the list of performance counters that can be used to query for vDC performance data.

Parameters:

vdcUuid - vDC UUID

Returns:

the list of performance counters

getSummaryForVdc

@GET
 @Path(value="/{vdcUuid}/summary")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
VdcResourceSummaryResponse getSummaryForVdc(@PathParam(value="vdcUuid")
                                                                                                                                                 String vdcUuid)

Get the resource summary for the given VDC.

Parameters:

vdcUuid - vdc uuid

Returns:

vdc resource summary

getVappResourceSummaries

@GET
 @Path(value="{vdcUuid}/vapp-summary-map")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
VappResourceSummaryMapResponse getVappResourceSummaries(@PathParam(value="vdcUuid")
                                                                                                                                                                     String vdcUuid)

Get the map of resource summaries for all vApps in the given vDC.

Parameters:

vdcUuid - vdc uuid

Returns:

map of vApp uuid to vApp resource summary

getVmResourceSummaries

@GET
 @Path(value="{vdcUuid}/vm-summary-map")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
VmResourceSummaryMapResponse getVmResourceSummaries(@PathParam(value="vdcUuid")
                                                                                                                                                               String vdcUuid)

Get the map of resource summaries for all VMs in the given vDC.

Parameters:

vdcUuid - vdc uuid

Returns:

map of VM uuid to vm resource summary

getEdgesForVdc

@GET
 @Path(value="/{vdcUuid}/edges")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
EdgeListResponse getEdgesForVdc(@PathParam(value="vdcUuid")
                                                                                                                                   String vdcUuid)

Get the edges for the vDC.

Parameters:

vdcUuid - vdc uuid

Returns:

a list of vcd edges

getStorageProfileSummary

@GET
 @Path(value="/{vdcUuid}/storage-profile-summary")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
VdcStorageProfileSummaryResponse getStorageProfileSummary(@PathParam(value="vdcUuid")
                                                                                                                                                                               String vdcUuid,
                                                                                                                                                                               @QueryParam(value="year")
                                                                                                                                                                               Integer year,
                                                                                                                                                                               @QueryParam(value="month")
                                                                                                                                                                               Integer month)

Gets a summary of storage profile usage for a specified vDC and billing period.

Parameters:

vdcUuid - the UUID of the vDC

year - the year

month - the month in range 1-12

Returns:

a summary of storage profile usage

getCostOverInvoicePeriodSerie

@GET
 @Path(value="/{vdcUuid}/cost-over-invoice-period")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
BillingSampleSerieResponse getCostOverInvoicePeriodSerie(@PathParam(value="vdcUuid")
                                                                                                                                                                               String vdcUuid,
                                                                                                                                                                               @QueryParam(value="year")
                                                                                                                                                                               Integer year,
                                                                                                                                                                               @QueryParam(value="month")
                                                                                                                                                                               Integer month,
                                                                                                                                                                               @QueryParam(value="additionalFields")
                                                                                                                                                                               List<String> additionalFields)

Get a serie detailing the hourly cost over an invoice period for a given vDC.

Parameters:

vdcUuid - the UUID of the vDC

year - the year

month - the month in range 1-12

additionalFields - any additional fields that should be included in the series

Returns:

a serie of samples detailing hourly vDC total cost by hour for the invoice period

generateVmInventoryReportForVdc

@POST
 @Path(value="/{vdcUuid}/actions/generate-vm-inventory-report")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
TaskResponse generateVmInventoryReportForVdc(@PathParam(value="vdcUuid")
                                                                                                                                                                                String vdcUuid,
                                                                                                                                                                                @QueryParam(value="emailOnCompletion")
                                                                                                                                                                                boolean emailOnCompletion,
                                                                                                                                                                                @QueryParam(value="email")
                                                                                                                                                                                String email)

Generate a VM inventory report for the specified vDC. Only available report type of 'csv'

Parameters:

vdcUuid - String vdc uuid

emailOnCompletion - whether to email the report upon successful generation, superseded by BillingReportSpec's email property

email - email address to send the report to if emailOnCompletion is true, defaults to the user's profile email if not specified

Returns:

asynchronous task details

getVmInventoryReportsForVdc

@GET
 @Path(value="/{vdcUuid}/vm-inventory-reports")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
ReportHeaderListResponse getVmInventoryReportsForVdc(@PathParam(value="vdcUuid")
                                                                                                                                                                       String vdcUuid,
                                                                                                                                                                       @QueryParam(value="format")
                                                                                                                                                                       ReportFormat reportFormat)

Get the VM inventory reports for vDC. The endpoint also supports filtering by report format, using the query param "format". Report formats available to filter on include:

• PDF
• HTML
• CSV

Parameters:

vdcUuid - virtual data center uuid

Returns:

list of reports available for download