@Path(value="/vdcs")
@Consumes(value="application/json")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
public interface VdcResource
| 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.
|
BackupGroupResponse |
createBackupGroup(String vdcUuid,
BackupGroupUpdateRequest creationRequest)
Create a new backup group.
|
BackupPolicyResponse |
createBackupPolicy(String vdcUuid,
BackupPolicyUpdateRequest creationRequest)
Create a new vdc-scoped backup policy.
|
DistributedFirewallLayer2RestorePointDetailsResponse |
createDistributedFirewallLayer2RestorePoint(String vdcUuid,
DistributedFirewallRestorePointCreateRequest restorePointCreateRequest)
Create a distributed firewall layer2 restore point for a vDC's distributed firewall.
|
DistributedFirewallLayer2RuleResponse |
createDistributedFirewallLayer2Rule(String vdcUuid,
Long eTag,
DistributedFirewallLayer2RuleCreateRequest createRequest)
Create a rule within the distributed firewall at layer 2 (ethernet) for a given vDC.
|
DistributedFirewallLayer3RestorePointDetailsResponse |
createDistributedFirewallLayer3RestorePoint(String vdcUuid,
DistributedFirewallRestorePointCreateRequest restorePointCreateRequest)
Create a distributed firewall layer3 restore point for a vDC's distributed firewall.
|
DistributedFirewallLayer3RuleResponse |
createDistributedFirewallLayer3Rule(String vdcUuid,
Long eTag,
DistributedFirewallLayer3RuleCreateRequest createRequest)
Create a rule within the distributed firewall at layer 3 (general) for a given vDC.
|
IpSetResponse |
createIpSet(String vdcUuid,
IpSetCreateRequest ipSetCreateRequest)
Create a IP set grouping object for a given vDC.
|
MacSetResponse |
createMacSet(String vdcUuid,
MacSetCreateRequest macSetCreateRequest)
Create a MAC set grouping object for a given vDC.
|
TaskResponse |
createOrgVdcNetwork(String vdcUuid,
OrgVdcNetworkCreateRequest createRequest)
Create a new org-vdc network for this vDC.
|
SecurityGroupResponse |
createSecurityGroup(String vdcUuid,
SecurityGroupCreateRequest createRequest)
Create a new security group for a given vDC.
|
SecurityTagWithAssignedVMsResponse |
createSecurityTag(String vdcUuid,
SecurityTagCreateRequest createRequest)
Create a new security tag for a given vDC.
|
TaskResponse |
createVmAffinityRule(String vdcUuid,
VmAffinityRuleCreateRequest request)
Create a vm affinity rule.
|
void |
deleteBackupPolicy(String vdcUuid,
String backupPolicyUid)
Delete a backup policy.
|
void |
deleteDistributedFirewallLayer2RestorePoint(String vdcUuid,
long restorePointTime)
Delete a distributed firewall layer2 restore point.
|
void |
deleteDistributedFirewallLayer2Rule(String vdcUuid,
long ruleId,
Long eTag)
Delete a rule within the distributed firewall at layer 2 (ethernet) for a given vDC.
|
void |
deleteDistributedFirewallLayer3RestorePoint(String vdcUuid,
long restorePointTime)
Delete a distributed firewall layer3 restore point.
|
void |
deleteDistributedFirewallLayer3Rule(String vdcUuid,
long ruleId,
Long eTag)
Delete a rule within the distributed firewall at layer 3 (general) for a given vDC.
|
void |
deleteIpSet(String vdcUuid,
String ipSetId)
Delete the specified IP set.
|
void |
deleteMacSet(String vdcUuid,
String macSetId)
Delete the specified MAC set.
|
TaskResponse |
deleteMetadataForVdc(String vdcUuid,
String key)
Delete a specific piece of metadata associated with a Vdc by its key.
|
void |
deleteSecurityGroup(String vdcUuid,
String securitygroupId)
Delete a specified security group for a given vDC.
|
void |
deleteSecurityTag(String vdcUuid,
String securitytagId)
Delete a specified security tag for a given vDC.
|
TaskResponse |
deleteVmAffinityRule(String vdcUuid,
String ruleUuid)
Deletes a given vm affinity rule.
|
void |
enableDistributedFirewall(String vdcUuid)
Enable the distributed firewall on an Org vDC.
|
TaskResponse |
generateVmInventoryReportForVdc(String vdcUuid,
boolean emailOnCompletion,
String email)
Generate a VM inventory report for the specified vDC.
|
ApplicationResponse |
getApplication(String vdcUuid,
String applicationId)
Get the specified application group for the given vDC.
|
ApplicationGroupResponse |
getApplicationGroup(String vdcUuid,
String applicationGroupId)
Get a specified application group for a given vDC.
|
ApplicationGroupListResponse |
getApplicationGroups(String vdcUuid)
Get a list application group grouping objects for a given vDC.
|
ApplicationListResponse |
getApplications(String vdcUuid)
Get all the application grouping objects for a given vDC.
|
VdcBackupSummaryStatsResponse |
getBackupGroupSummaryStats(String vdcUuid,
GetBackupGroupSummaryStatsFilters filters)
Gets backup group summary stats for the vDC.
|
BackupPolicyResponse |
getBackupPolicy(String vdcUuid,
String backupPolicyUid)
Get details of an individual vDC-scoped backup policy.
|
BackupRestoreTaskDetailResponse |
getBackupRestoreTask(String vdcUuid,
String restoreTaskUid)
Gets detailed recovery task information for a specific advanced backup
restore task.
|
VdcBackupStatusResponse |
getBackupStatus(String vdcUuid)
Gets the vDC's backup status.
|
VdcBackupStorageMetricListResponse |
getBackupStorageMetrics(String vdcUuid)
Gets the list of storage metrics that are available for the vDC.
|
VdcBackupStorageSampleSeriesResponse |
getBackupStorageSamples(String vdcUuid,
VdcBackupStorageMetric metric,
GetBackupStorageSamplesFilters filters)
Gets a series of vDC backup storage samples for a specified storage metric.
|
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.
|
DistributedFirewallLayer2Response |
getDistributedFirewallLayer2(String vdcUuid)
Get the distributed firewall at layer 2 (ethernet) for a given vDC.
|
DistributedFirewallAppliedToObjectListResponse |
getDistributedFirewallLayer2AppliedToObjects(String vdcUuid,
String type,
ObjectPagingParams filters)
Get the list of applied to objects for distributed firewall layer 2 (ethernet).
|
DistributedFirewallAppliedToTypeListResponse |
getDistributedFirewallLayer2AppliedToObjectTypes(String vdcUuid)
Get the list of distributed firewall layer 2 (ethernet) applied to object types.
|
DistributedFirewallDestinationObjectListResponse |
getDistributedFirewallLayer2DestinationObjects(String vdcUuid,
String type,
ObjectPagingParams filters)
Get the list of destination objects for distributed firewall layer 2 (ethernet).
|
DistributedFirewallDestinationTypeListResponse |
getDistributedFirewallLayer2DestinationObjectTypes(String vdcUuid)
Get the list of distributed firewall layer 2 (ethernet) destination object types.
|
DistributedFirewallLayer2RestorePointDetailsResponse |
getDistributedFirewallLayer2RestorePoint(String vdcUuid,
long restorePointTime)
Get a distributed firewall layer2 restore point for a vDC at a given time.
|
DistributedFirewallRestorePointListResponse |
getDistributedFirewallLayer2RestorePoints(String vdcUuid)
Get the distributed firewall layer2 restore points for a vDC.
|
DistributedFirewallLayer2RuleResponse |
getDistributedFirewallLayer2Rule(String vdcUuid,
long ruleId)
Get a rule within the distributed firewall at layer 2 (ethernet) for a given vDC.
|
DistributedFirewallSourceObjectListResponse |
getDistributedFirewallLayer2SourceObjects(String vdcUuid,
String type,
ObjectPagingParams filters)
Get the list of source objects for distributed firewall layer 2 (ethernet).
|
DistributedFirewallSourceTypeListResponse |
getDistributedFirewallLayer2SourceObjectTypes(String vdcUuid)
Get the list of distributed firewall layer 2 (ethernet) source object types.
|
DistributedFirewallLayer3Response |
getDistributedFirewallLayer3(String vdcUuid)
Get the distributed firewall at layer 3 (general) for a given vDC.
|
DistributedFirewallAppliedToObjectListResponse |
getDistributedFirewallLayer3AppliedToObjects(String vdcUuid,
String type,
ObjectPagingParams filters)
Get the list of applied to objects for distributed firewall layer 3 (general).
|
DistributedFirewallAppliedToTypeListResponse |
getDistributedFirewallLayer3AppliedToObjectTypes(String vdcUuid)
Get the list of distributed firewall layer 3 (general) applied to object types.
|
DistributedFirewallDestinationObjectListResponse |
getDistributedFirewallLayer3DestinationObjects(String vdcUuid,
String type,
ObjectPagingParams filters)
Get the list of destination objects for distributed firewall layer 3 (general).
|
DistributedFirewallDestinationTypeListResponse |
getDistributedFirewallLayer3DestinationObjectTypes(String vdcUuid)
Get the list of distributed firewall layer 3 (general) destination object types.
|
DistributedFirewallLayer3RestorePointDetailsResponse |
getDistributedFirewallLayer3RestorePoint(String vdcUuid,
long restorePointTime)
Get a distributed firewall layer3 restore point for a vDC at a given time.
|
DistributedFirewallRestorePointListResponse |
getDistributedFirewallLayer3RestorePoints(String vdcUuid)
Get the distributed firewall layer3 restore points for a vDC.
|
DistributedFirewallLayer3RuleResponse |
getDistributedFirewallLayer3Rule(String vdcUuid,
long ruleId)
Get a rule within the distributed firewall at layer 3 (general) for a given vDC.
|
DistributedFirewallSourceObjectListResponse |
getDistributedFirewallLayer3SourceObjects(String vdcUuid,
String type,
ObjectPagingParams filters)
Get the list of source objects for distributed firewall layer 3 (general).
|
DistributedFirewallSourceTypeListResponse |
getDistributedFirewallLayer3SourceObjectTypes(String vdcUuid)
Get the list of distributed firewall layer 3 (general) source object types.
|
EdgeListResponse |
getEdgesForVdc(String vdcUuid)
Get the edges for the vDC.
|
VdcIntegratedBackupStatusDetailResponse |
getIntegratedBackupStatus(String vdcUuid)
Gets the vDC's integrated backup status.
|
IpSetResponse |
getIpSet(String vdcUuid,
String ipSetId)
Get the specified IP set given it's UUID.
|
IpSetListResponse |
getIpSets(String vdcUuid)
Get all the IP sets for a given vDC.
|
MacSetResponse |
getMacSet(String vdcUuid,
String macSetId)
Get the specified MAC set given it's UUID.
|
MacSetListResponse |
getMacSets(String vdcUuid)
Get all the MAC sets for a given 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.
|
SecurityGroupResponse |
getSecurityGroup(String vdcUuid,
String securitygroupId)
Get the specified security group for a given vDC.
|
SecurityGroupMemberListResponse |
getSecurityGroupMembers(String vdcUuid,
String type,
ObjectPagingParams filter)
Get the list of security group members.
|
SecurityGroupMemberTypeListResponse |
getSecurityGroupMemberTypes(String vdcUuid)
Get the list of security group member types.
|
SecurityGroupsResponse |
getSecurityGroups(String vdcUuid)
Get a list of security groups for a given vDC.
|
SecurityTagWithAssignedVMsResponse |
getSecurityTag(String vdcUuid,
String securitytagId)
Get the specified security tag for a given vDC.
|
SecurityTagObjectListResponse |
getSecurityTagObjects(String vdcUuid,
String type,
ObjectPagingParams filter)
Get the list of security tag objects.
|
SecurityTagObjectTypeListResponse |
getSecurityTagObjectTypes(String vdcUuid)
Get the list of security tag object types.
|
SecurityTagsResponse |
getSecurityTags(String vdcUuid)
Get a list of security tags for a given vDC.
|
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.
|
VdcBackupClusterInfo |
getVdcBackupClusterInfo(String vdcUuid)
Gets info about the backup cluster and remote replicas that are available
to the vDC.
|
VmAffinityRuleListResponse |
getVmAffinityRules(String vdcUuid)
Get all the vm affinity rules for a given 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.
|
BackupGroupRunListResponse |
listBackupGroupRuns(String vdcUuid,
ListBackupGroupRunsQueryParams params)
List backup runs for the specified vDC.
|
BackupGroupListResponse |
listBackupGroups(String vdcUuid,
boolean includeDeleted,
boolean includeSummaryStats,
boolean includeLastRun,
boolean includeBackupPolicy)
List the existing backup groups that are configured in a specified virtual
datacenter.
|
BackupPolicyListResponse |
listBackupPolicies(String vdcUuid,
boolean includeOrgPolicies)
List the existing backup policies that are configured in a
vDC.
|
BackupRestoreTaskListResponse |
listBackupRestoreTasks(String vdcUuid,
ListBackupRestoreTasksFilters filters)
Lists detailed task information for advanced backup restore tasks in a
specified vDC.
|
IaasBackupBillListResponse |
listIaasBackupBills(String vdcUuid,
String start,
String end)
Lists bills for IaaS backup in the specified time range.
|
IaasBackupSubscriptionListResponse |
listIaasBackupSubscriptions(String vdcUuid,
Long startTimeMillis,
Long endTimeMillis)
Lists IaaS backup subscriptions that were active in the specified time range.
|
DistributedFirewallLayer2Response |
restoreDistributedFirewallLayer2(String vdcUuid,
RestoreDistributedFirewallRequest restoreDistributedFirewallRequest)
Restore a vDC's distributed firewall layer2 configuration to a specified restore point.
|
DistributedFirewallLayer3Response |
restoreDistributedFirewallLayer3(String vdcUuid,
RestoreDistributedFirewallRequest restoreDistributedFirewallRequest)
Restore a vDC's distributed firewall layer3 configuration to a specified restore point.
|
TaskResponse |
restoreVMBackupsInVdc(String vdcUuid,
RestoreVMBackupsInVdcParams params)
Restores one or more VM backups within the vDC.
|
RecoverableFilesSearchResultListResponse |
searchRecoverableFilesAndFolders(String vdcUuid,
SearchVdcRecoverableFilesAndFoldersFilters filters)
Searches for recoverable backup files and folders within the vDC.
|
VMBackupSnapshotListResponse |
searchRecoverableVMs(String vdcUuid,
SearchVdcRecoverableVMsFilters filters)
Searches for recoverable VM snapshots within the vDC.
|
void |
sendEventHistoryForVdc(String vdcUuid,
EventHistoryEmailRequest spec)
Email a CSV report with all event history for a given Vdc.
|
BackupPolicyResponse |
updateBackupPolicy(String vdcUuid,
String backupPolicyUid,
BackupPolicyUpdateRequest updateRequest)
Update a backup policy.
|
DistributedFirewallLayer2Response |
updateDistributedFirewallLayer2(String vdcUuid,
Long eTag,
DistributedFirewallLayer2UpdateRequest updateRequest)
Update the distributed firewall at layer 2 (ethernet) for a given vDC.
|
DistributedFirewallLayer2RuleResponse |
updateDistributedFirewallLayer2Rule(String vdcUuid,
long ruleId,
Long eTag,
DistributedFirewallLayer2RuleUpdateRequest updateRequest)
Update a rule within the distributed firewall at layer 2 (ethernet) for a given vDC.
|
DistributedFirewallLayer3Response |
updateDistributedFirewallLayer3(String vdcUuid,
Long eTag,
DistributedFirewallLayer3UpdateRequest updateRequest)
Update the distributed firewall at layer 3 (general) for a given vDC.
|
DistributedFirewallLayer3RuleResponse |
updateDistributedFirewallLayer3Rule(String vdcUuid,
long ruleId,
Long eTag,
DistributedFirewallLayer3RuleUpdateRequest updateRequest)
Update a rule within the distributed firewall at layer 3 (general) for a given vDC.
|
IpSetResponse |
updateIpSet(String vdcUuid,
String ipSetId,
IpSetUpdateRequest ipSetUpdateRequest)
Updates a IP set grouping object for a given vDC.
|
MacSetResponse |
updateMacSet(String vdcUuid,
String macSetId,
MacSetUpdateRequest macSetUpdateRequest)
Updates a MAC set grouping object for a given vDC.
|
TaskResponse |
updateMetadataForVdc(String vdcUuid,
List<UpdateMetadataRequest> metadata)
Add / update metadata associated with a Vdc.
|
SecurityGroupResponse |
updateSecurityGroup(String vdcUuid,
String securitygroupId,
SecurityGroupUpdateRequest updateRequest)
Update a specified security group for a given vDC.
|
SecurityTagWithAssignedVMsResponse |
updateSecurityTag(String vdcUuid,
String securitytagId,
SecurityTagUpdateRequest updateRequest)
Update a specified security tag for a given vDC.
|
TaskResponse |
updateVmAffinityRule(String vdcUuid,
VmAffinityRuleUpdateRequest vmAffinityRuleUpdateRequest)
Update the given vm affinity rule.
|
@GET
@Path(value="/{vdcUuid}")
VdcResponse getVdc(@PathParam(value="vdcUuid")
String vdcUuid,
@QueryParam(value="timestamp")
Long timestamp)
vdcUuid - vdc uuidtimestamp - optional timestamp parameter to get the vDC details at a
certain point in time.@GET
@Path(value="/{vdcUuid}/vapps")
VappListResponse getVappsForVdc(@PathParam(value="vdcUuid")
String vdcUuid)
vdcUuid - vdc uuid@GET
@Path(value="/{vdcUuid}/vms")
VmListResponse getVmsForVdc(@PathParam(value="vdcUuid")
String vdcUuid)
vdcUuid - vdc uuid@GET
@Path(value="/{vdcUuid}/billing")
BillResponse getBillingForVdc(@PathParam(value="vdcUuid")
String vdcUuid,
@QueryParam(value="year")
Integer year,
@QueryParam(value="month")
Integer month)
If month and year are not explicitly supplied the current invoice period is used.
vdcUuid - vdc 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@GET
@Path(value="/{vdcUuid}/vapp-bills")
BillListResponse getVappBills(@PathParam(value="vdcUuid")
String vdcUuid,
@QueryParam(value="month")
Integer month,
@QueryParam(value="year")
Integer year)
vdcUuid - vdc uuid@GET
@Path(value="/{vdcUuid}/vm-bills")
BillListResponse getVmBills(@PathParam(value="vdcUuid")
String vdcUuid,
@QueryParam(value="month")
Integer month,
@QueryParam(value="year")
Integer year)
vdcUuid - vdc uuid@POST
@Path(value="/{vdcUuid}/actions/email-event-history")
void sendEventHistoryForVdc(@PathParam(value="vdcUuid")
String vdcUuid,
EventHistoryEmailRequest spec)
vdcUuid - vdc uuidspec - email address spec@GET
@Path(value="/{vdcUuid}/metadata")
MetadataListResponse getMetadataForVdc(@PathParam(value="vdcUuid")
String vdcUuid)
vdcUuid - vdc uuid@PUT
@Path(value="/{vdcUuid}/metadata")
@Consumes(value="application/json")
TaskResponse updateMetadataForVdc(@PathParam(value="vdcUuid")
String vdcUuid,
List<UpdateMetadataRequest> metadata)
vdcUuid - vdc uuidmetadata - of instances@DELETE
@Path(value="/{vdcUuid}/metadata/{key}")
TaskResponse deleteMetadataForVdc(@PathParam(value="vdcUuid")
String vdcUuid,
@PathParam(value="key")
String key)
vdcUuid - vdc uuidkey - metadata key@GET
@Path(value="/{vdcUuid}/medias")
MediaListResponse getMediasForVdc(@PathParam(value="vdcUuid")
String vdcUuid)
vdcUuid - vdc uuid@GET
@Path(value="/{vdcUuid}/storage-profiles")
StorageProfileListResponse getStorageProfiles(@PathParam(value="vdcUuid")
String vdcUuid,
@QueryParam(value="includeDisabled")
Boolean includeDisabled)
vdcUuid - vdc uuidincludeDisabled - whether to include disabled profiles (defaults to
false if not explicitly provided)@POST
@Path(value="/{vdcUuid}/actions/add-vapp-from-template")
@Consumes(value="application/json")
TaskResponse addVappFromTemplate(@PathParam(value="vdcUuid")
String vdcUuid,
VdcAddVappFromTemplateRequest request)
vdcUuid - vdc uuidrequest - specification for new vApp paramters@POST
@Path(value="/{vdcUuid}/actions/build-vapp")
@Consumes(value="application/json")
TaskResponse buildVapp(@PathParam(value="vdcUuid")
String vdcUuid,
BuildVappRequest spec)
vdcUuid - vdc uuidspec - specification for the new vApp@GET
@Path(value="/{vdcUuid}/org-vdc-networks")
OrgVdcNetworkListResponse getOrgVdcNetworksForVdc(@PathParam(value="vdcUuid")
String vdcUuid)
vdcUuid - vdc uuid@GET
@Path(value="/{vdcUuid}/performance/{group}::{name}::{type}")
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)
vdcUuid - vDC UUIDgroup - the performance counter groupname - the performance counter nametype - the performance counter typestart - start dateend - end dateinterval - intervallimit - limit@GET
@Path(value="/{vdcUuid}/performance-counters")
PerformanceCounterListResponse getPerformanceCountersForVdc(@PathParam(value="vdcUuid")
String vdcUuid)
vdcUuid - vDC UUID@GET
@Path(value="/{vdcUuid}/summary")
VdcResourceSummaryResponse getSummaryForVdc(@PathParam(value="vdcUuid")
String vdcUuid)
vdcUuid - vdc uuid@GET
@Path(value="{vdcUuid}/vapp-summary-map")
VappResourceSummaryMapResponse getVappResourceSummaries(@PathParam(value="vdcUuid")
String vdcUuid)
vdcUuid - vdc uuid@GET
@Path(value="{vdcUuid}/vm-summary-map")
VmResourceSummaryMapResponse getVmResourceSummaries(@PathParam(value="vdcUuid")
String vdcUuid)
vdcUuid - vdc uuid@POST
@Path(value="/{vdcUuid}/actions/create-org-vdc-network")
@Consumes(value="application/json")
TaskResponse createOrgVdcNetwork(@PathParam(value="vdcUuid")
String vdcUuid,
OrgVdcNetworkCreateRequest createRequest)
vdcUuid - vdc uuidcreateRequest - the new org vdc network@GET
@Path(value="/{vdcUuid}/edges")
EdgeListResponse getEdgesForVdc(@PathParam(value="vdcUuid")
String vdcUuid)
vdcUuid - vdc uuid@GET
@Path(value="/{vdcUuid}/storage-profile-summary")
VdcStorageProfileSummaryResponse getStorageProfileSummary(@PathParam(value="vdcUuid")
String vdcUuid,
@QueryParam(value="year")
Integer year,
@QueryParam(value="month")
Integer month)
vdcUuid - the UUID of the vDCyear - the yearmonth - the month in range 1-12@GET
@Path(value="/{vdcUuid}/cost-over-invoice-period")
BillingSampleSerieResponse getCostOverInvoicePeriodSerie(@PathParam(value="vdcUuid")
String vdcUuid,
@QueryParam(value="year")
Integer year,
@QueryParam(value="month")
Integer month,
@QueryParam(value="additionalFields")
List<String> additionalFields)
vdcUuid - the UUID of the vDCyear - the yearmonth - the month in range 1-12additionalFields - any additional fields that should be included in
the series@POST
@Path(value="/{vdcUuid}/actions/generate-vm-inventory-report")
TaskResponse generateVmInventoryReportForVdc(@PathParam(value="vdcUuid")
String vdcUuid,
@QueryParam(value="emailOnCompletion")
boolean emailOnCompletion,
@QueryParam(value="email")
String email)
Only available report type of 'csv'
vdcUuid - String vdc uuidemailOnCompletion - whether to email the report upon successful
generation, superseded by BillingReportSpec's email propertyemail - email address to send the report to if emailOnCompletion is
true, defaults to the user's profile email if not specified@GET
@Path(value="/{vdcUuid}/vm-inventory-reports")
ReportHeaderListResponse getVmInventoryReportsForVdc(@PathParam(value="vdcUuid")
String vdcUuid,
@QueryParam(value="format")
ReportFormat reportFormat)
The endpoint also supports filtering by report format, using the query param "format".
vdcUuid - virtual data center uuid@POST
@Path(value="/{vdcUuid}/actions/create-vm-affinity-rule")
@Consumes(value="application/json")
TaskResponse createVmAffinityRule(@PathParam(value="vdcUuid")
String vdcUuid,
VmAffinityRuleCreateRequest request)
request - vm affinity rule create request@PUT
@Path(value="/{vdcUuid}/actions/update-vm-affinity-rule")
@Consumes(value="application/json")
TaskResponse updateVmAffinityRule(@PathParam(value="vdcUuid")
String vdcUuid,
VmAffinityRuleUpdateRequest vmAffinityRuleUpdateRequest)
vdcUuid - virtual data center uuidvmAffinityRuleUpdateRequest - vm affinity rule update request@DELETE
@Path(value="/{vdcUuid}/actions/delete-vm-affinity-rule/{ruleUuid}")
TaskResponse deleteVmAffinityRule(@PathParam(value="vdcUuid")
String vdcUuid,
@PathParam(value="ruleUuid")
String ruleUuid)
vdcUuid - virtual data center uuidruleUuid - vm affinity rule uuid@GET
@Path(value="/{vdcUuid}/vm-affinity-rules")
VmAffinityRuleListResponse getVmAffinityRules(@PathParam(value="vdcUuid")
String vdcUuid)
vdcUuid - vdc uuid@POST
@Path(value="/{vdcUuid}/actions/enable-distributed-firewall")
void enableDistributedFirewall(@PathParam(value="vdcUuid")
String vdcUuid)
vdcUuid - String vDC uuid@GET
@Path(value="/{vdcUuid}/distributed-firewall-layer3")
DistributedFirewallLayer3Response getDistributedFirewallLayer3(@PathParam(value="vdcUuid")
String vdcUuid)
vdcUuid - vDC uuid@GET
@Path(value="/{vdcUuid}/distributed-firewall-layer2")
DistributedFirewallLayer2Response getDistributedFirewallLayer2(@PathParam(value="vdcUuid")
String vdcUuid)
vdcUuid - vDC uuid@PUT
@Path(value="/{vdcUuid}/distributed-firewall-layer3")
DistributedFirewallLayer3Response updateDistributedFirewallLayer3(@PathParam(value="vdcUuid")
String vdcUuid,
@QueryParam(value="eTag")
Long eTag,
DistributedFirewallLayer3UpdateRequest updateRequest)
vdcUuid - vDC uuideTag - the eTag value. specifying an eTag value allows a client to ensure that the distributed firewall has not been updated since it last read the configuration. If the specified eTag value does not match the current etag value, the request will fail. Use the response from getDistributedFirewallLayer3 to retrieve the current generationNumber needed to modify the configuration (e.g. 1583956143338)updateRequest - update request@PUT
@Path(value="/{vdcUuid}/distributed-firewall-layer2")
DistributedFirewallLayer2Response updateDistributedFirewallLayer2(@PathParam(value="vdcUuid")
String vdcUuid,
@QueryParam(value="eTag")
Long eTag,
DistributedFirewallLayer2UpdateRequest updateRequest)
vdcUuid - vDC uuideTag - the eTag value. specifying an eTag value allows a client to ensure that the distributed firewall has not been updated since it last read the configuration. If the specified eTag value does not match the current etag value, the request will fail. Use the response from getDistributedFirewallLayer3 to retrieve the current generationNumber needed to modify the configuration (e.g. 1583956143338)updateRequest - update request@GET
@Path(value="/{vdcUuid}/distributed-firewall-layer3-rules/{ruleId}")
DistributedFirewallLayer3RuleResponse getDistributedFirewallLayer3Rule(@PathParam(value="vdcUuid")
String vdcUuid,
@PathParam(value="ruleId")
long ruleId)
vdcUuid - vDC uuidruleId - rule id@GET
@Path(value="/{vdcUuid}/distributed-firewall-layer2-rules/{ruleId}")
DistributedFirewallLayer2RuleResponse getDistributedFirewallLayer2Rule(@PathParam(value="vdcUuid")
String vdcUuid,
@PathParam(value="ruleId")
long ruleId)
vdcUuid - vDC uuidruleId - rule id@Consumes(value="application/json")
@POST
@Path(value="/{vdcUuid}/distributed-firewall-layer3-rules")
DistributedFirewallLayer3RuleResponse createDistributedFirewallLayer3Rule(@PathParam(value="vdcUuid")
String vdcUuid,
@QueryParam(value="eTag")
Long eTag,
DistributedFirewallLayer3RuleCreateRequest createRequest)
vdcUuid - vDC uuideTag - the eTag value. specifying an eTag value allows a client to ensure that the distributed firewall has not been updated since it last read the configuration. If the specified eTag value does not match the current etag value, the request will fail. Use the response from getDistributedFirewallLayer3 to retrieve the current generationNumber needed to modify the configuration (e.g. 1583956143338)createRequest - create request@Consumes(value="application/json")
@POST
@Path(value="/{vdcUuid}/distributed-firewall-layer2-rules")
DistributedFirewallLayer2RuleResponse createDistributedFirewallLayer2Rule(@PathParam(value="vdcUuid")
String vdcUuid,
@QueryParam(value="eTag")
Long eTag,
DistributedFirewallLayer2RuleCreateRequest createRequest)
vdcUuid - vDC uuideTag - the eTag value. specifying an eTag value allows a client to ensure that the distributed firewall has not been updated since it last read the configuration. If the specified eTag value does not match the current etag value, the request will fail. Use the response from getDistributedFirewallLayer3 to retrieve the current generationNumber needed to modify the configuration (e.g. 1583956143338)createRequest - create request@Consumes(value="application/json")
@PUT
@Path(value="/{vdcUuid}/distributed-firewall-layer3-rules/{ruleId}")
DistributedFirewallLayer3RuleResponse updateDistributedFirewallLayer3Rule(@PathParam(value="vdcUuid")
String vdcUuid,
@PathParam(value="ruleId")
long ruleId,
@QueryParam(value="eTag")
Long eTag,
DistributedFirewallLayer3RuleUpdateRequest updateRequest)
vdcUuid - vDC uuidruleId - rule ideTag - the eTag value. specifying an eTag value allows a client to ensure that the distributed firewall has not been updated since it last read the configuration. If the specified eTag value does not match the current etag value, the request will fail. Use the response from getDistributedFirewallLayer3 to retrieve the current generationNumber needed to modify the configuration (e.g. 1583956143338)updateRequest - update request@Consumes(value="application/json")
@PUT
@Path(value="/{vdcUuid}/distributed-firewall-layer2-rules/{ruleId}")
DistributedFirewallLayer2RuleResponse updateDistributedFirewallLayer2Rule(@PathParam(value="vdcUuid")
String vdcUuid,
@PathParam(value="ruleId")
long ruleId,
@QueryParam(value="eTag")
Long eTag,
DistributedFirewallLayer2RuleUpdateRequest updateRequest)
vdcUuid - vDC uuidruleId - rule ideTag - the eTag value. specifying an eTag value allows a client to ensure that the distributed firewall has not been updated since it last read the configuration. If the specified eTag value does not match the current etag value, the request will fail. Use the response from getDistributedFirewallLayer3 to retrieve the current generationNumber needed to modify the configuration (e.g. 1583956143338)updateRequest - update request@DELETE
@Path(value="/{vdcUuid}/distributed-firewall-layer3-rules/{ruleId}")
void deleteDistributedFirewallLayer3Rule(@PathParam(value="vdcUuid")
String vdcUuid,
@PathParam(value="ruleId")
long ruleId,
@QueryParam(value="eTag")
Long eTag)
vdcUuid - vDC uuidruleId - rule ideTag - the eTag value. specifying an eTag value allows a client to ensure that the distributed firewall has not been updated since it last read the configuration. If the specified eTag value does not match the current etag value, the request will fail. Use the response from getDistributedFirewallLayer3 to retrieve the current generationNumber needed to modify the configuration (e.g. 1583956143338)@DELETE
@Path(value="/{vdcUuid}/distributed-firewall-layer2-rules/{ruleId}")
void deleteDistributedFirewallLayer2Rule(@PathParam(value="vdcUuid")
String vdcUuid,
@PathParam(value="ruleId")
long ruleId,
@QueryParam(value="eTag")
Long eTag)
vdcUuid - vDC uuidruleId - rule ideTag - the eTag value. specifying an eTag value allows a client to ensure that the distributed firewall has not been updated since it last read the configuration. If the specified eTag value does not match the current etag value, the request will fail. Use the response from getDistributedFirewallLayer3 to retrieve the current generationNumber needed to modify the configuration (e.g. 1583956143338)@GET
@Path(value="/{vdcUuid}/distributed-firewall-layer3/sources")
DistributedFirewallSourceTypeListResponse getDistributedFirewallLayer3SourceObjectTypes(@PathParam(value="vdcUuid")
String vdcUuid)
vdcUuid - vDC uuid@GET
@Path(value="/{vdcUuid}/distributed-firewall-layer3/sources/{type}")
DistributedFirewallSourceObjectListResponse getDistributedFirewallLayer3SourceObjects(@PathParam(value="vdcUuid")
String vdcUuid,
@PathParam(value="type")
String type,
@BeanParam
ObjectPagingParams filters)
vdcUuid - vDC uuidtype - source object typefilters - source object filters@GET
@Path(value="/{vdcUuid}/distributed-firewall-layer3/destinations")
DistributedFirewallDestinationTypeListResponse getDistributedFirewallLayer3DestinationObjectTypes(@PathParam(value="vdcUuid")
String vdcUuid)
vdcUuid - vDC uuid@GET
@Path(value="/{vdcUuid}/distributed-firewall-layer3/destinations/{type}")
DistributedFirewallDestinationObjectListResponse getDistributedFirewallLayer3DestinationObjects(@PathParam(value="vdcUuid")
String vdcUuid,
@PathParam(value="type")
String type,
@BeanParam
ObjectPagingParams filters)
vdcUuid - vDC uuidtype - destination object typefilters - destination object filters@GET
@Path(value="/{vdcUuid}/distributed-firewall-layer3/applied-to-objects")
DistributedFirewallAppliedToTypeListResponse getDistributedFirewallLayer3AppliedToObjectTypes(@PathParam(value="vdcUuid")
String vdcUuid)
vdcUuid - vDC uuid@GET
@Path(value="/{vdcUuid}/distributed-firewall-layer3/applied-to-objects/{type}")
DistributedFirewallAppliedToObjectListResponse getDistributedFirewallLayer3AppliedToObjects(@PathParam(value="vdcUuid")
String vdcUuid,
@PathParam(value="type")
String type,
@BeanParam
ObjectPagingParams filters)
vdcUuid - vDC uuidtype - applied to object typefilters - applied to object filters@POST
@Path(value="/{vdcUuid}/distributed-firewall-layer3/restore-points")
DistributedFirewallLayer3RestorePointDetailsResponse createDistributedFirewallLayer3RestorePoint(@PathParam(value="vdcUuid")
String vdcUuid,
DistributedFirewallRestorePointCreateRequest restorePointCreateRequest)
vdcUuid - vdc uuidrestorePointCreateRequest - distributed firewall layer3 restore point create request@GET
@Path(value="/{vdcUuid}/distributed-firewall-layer3/restore-points")
DistributedFirewallRestorePointListResponse getDistributedFirewallLayer3RestorePoints(@PathParam(value="vdcUuid")
String vdcUuid)
vdcUuid - vDC uuid@GET
@Path(value="/{vdcUuid}/distributed-firewall-layer3/restore-points/{restorePointTime}")
DistributedFirewallLayer3RestorePointDetailsResponse getDistributedFirewallLayer3RestorePoint(@PathParam(value="vdcUuid")
String vdcUuid,
@PathParam(value="restorePointTime")
long restorePointTime)
Restore point time is epoch time in milliseconds.
vdcUuid - vDC uuidrestorePointTime - restore point time@DELETE
@Path(value="/{vdcUuid}/distributed-firewall-layer3/restore-points/{restorePointTime}")
void deleteDistributedFirewallLayer3RestorePoint(@PathParam(value="vdcUuid")
String vdcUuid,
@PathParam(value="restorePointTime")
long restorePointTime)
Restore point time is epoch time in milliseconds.
vdcUuid - vDC uuidrestorePointTime - restore point time@POST
@Path(value="/{vdcUuid}/distributed-firewall-layer3/actions/restore")
DistributedFirewallLayer3Response restoreDistributedFirewallLayer3(@PathParam(value="vdcUuid")
String vdcUuid,
RestoreDistributedFirewallRequest restoreDistributedFirewallRequest)
vdcUuid - vDC uuidrestoreDistributedFirewallRequest - the request body, which specifies the restore point time@POST
@Path(value="/{vdcUuid}/distributed-firewall-layer2/restore-points")
DistributedFirewallLayer2RestorePointDetailsResponse createDistributedFirewallLayer2RestorePoint(@PathParam(value="vdcUuid")
String vdcUuid,
DistributedFirewallRestorePointCreateRequest restorePointCreateRequest)
vdcUuid - vdc uuidrestorePointCreateRequest - distributed firewall layer2 restore point create request@GET
@Path(value="/{vdcUuid}/distributed-firewall-layer2/restore-points")
DistributedFirewallRestorePointListResponse getDistributedFirewallLayer2RestorePoints(@PathParam(value="vdcUuid")
String vdcUuid)
vdcUuid - vDC uuid@GET
@Path(value="/{vdcUuid}/distributed-firewall-layer2/restore-points/{restorePointTime}")
DistributedFirewallLayer2RestorePointDetailsResponse getDistributedFirewallLayer2RestorePoint(@PathParam(value="vdcUuid")
String vdcUuid,
@PathParam(value="restorePointTime")
long restorePointTime)
Restore point time is epoch time in milliseconds.
vdcUuid - vDC uuidrestorePointTime - restore point time@DELETE
@Path(value="/{vdcUuid}/distributed-firewall-layer2/restore-points/{restorePointTime}")
void deleteDistributedFirewallLayer2RestorePoint(@PathParam(value="vdcUuid")
String vdcUuid,
@PathParam(value="restorePointTime")
long restorePointTime)
Restore point time is epoch time in milliseconds.
vdcUuid - vDC uuidrestorePointTime - restore point time@POST
@Path(value="/{vdcUuid}/distributed-firewall-layer2/actions/restore")
DistributedFirewallLayer2Response restoreDistributedFirewallLayer2(@PathParam(value="vdcUuid")
String vdcUuid,
RestoreDistributedFirewallRequest restoreDistributedFirewallRequest)
vdcUuid - vDC uuidrestoreDistributedFirewallRequest - the request body, which specifies the restore point time@GET
@Path(value="/{vdcUuid}/distributed-firewall-layer2/sources")
DistributedFirewallSourceTypeListResponse getDistributedFirewallLayer2SourceObjectTypes(@PathParam(value="vdcUuid")
String vdcUuid)
vdcUuid - vDC uuid@GET
@Path(value="/{vdcUuid}/distributed-firewall-layer2/sources/{type}")
DistributedFirewallSourceObjectListResponse getDistributedFirewallLayer2SourceObjects(@PathParam(value="vdcUuid")
String vdcUuid,
@PathParam(value="type")
String type,
@BeanParam
ObjectPagingParams filters)
vdcUuid - vDC uuidtype - source object typefilters - source object filters@GET
@Path(value="/{vdcUuid}/distributed-firewall-layer2/destinations")
DistributedFirewallDestinationTypeListResponse getDistributedFirewallLayer2DestinationObjectTypes(@PathParam(value="vdcUuid")
String vdcUuid)
vdcUuid - vDC uuid@GET
@Path(value="/{vdcUuid}/distributed-firewall-layer2/destinations/{type}")
DistributedFirewallDestinationObjectListResponse getDistributedFirewallLayer2DestinationObjects(@PathParam(value="vdcUuid")
String vdcUuid,
@PathParam(value="type")
String type,
@BeanParam
ObjectPagingParams filters)
vdcUuid - vDC uuidtype - destination object typefilters - destination object filters@GET
@Path(value="/{vdcUuid}/distributed-firewall-layer2/applied-to-objects")
DistributedFirewallAppliedToTypeListResponse getDistributedFirewallLayer2AppliedToObjectTypes(@PathParam(value="vdcUuid")
String vdcUuid)
vdcUuid - vDC uuid@GET
@Path(value="/{vdcUuid}/distributed-firewall-layer2/applied-to-objects/{type}")
DistributedFirewallAppliedToObjectListResponse getDistributedFirewallLayer2AppliedToObjects(@PathParam(value="vdcUuid")
String vdcUuid,
@PathParam(value="type")
String type,
@BeanParam
ObjectPagingParams filters)
vdcUuid - vDC uuidtype - applied to object typefilters - applied to object filters@POST
@Path(value="/{vdcUuid}/ipsets")
@Consumes(value="application/json")
IpSetResponse createIpSet(@PathParam(value="vdcUuid")
String vdcUuid,
IpSetCreateRequest ipSetCreateRequest)
vdcUuid - vDC uuidipSetCreateRequest - ip set create request@GET
@Path(value="/{vdcUuid}/ipsets")
IpSetListResponse getIpSets(@PathParam(value="vdcUuid")
String vdcUuid)
vdcUuid - vDC uuid@POST
@Path(value="/{vdcUuid}/macsets")
@Consumes(value="application/json")
MacSetResponse createMacSet(@PathParam(value="vdcUuid")
String vdcUuid,
MacSetCreateRequest macSetCreateRequest)
vdcUuid - vDC uuidmacSetCreateRequest - mac set create request@GET
@Path(value="/{vdcUuid}/macsets")
MacSetListResponse getMacSets(@PathParam(value="vdcUuid")
String vdcUuid)
vdcUuid - vDC uuid@GET
@Path(value="/{vdcUuid}/ipsets/{ipsetId}")
IpSetResponse getIpSet(@PathParam(value="vdcUuid")
String vdcUuid,
@PathParam(value="ipsetId")
String ipSetId)
vdcUuid - vDC uuidipSetId - ip set id (e.g. ipset-1)@PUT
@Path(value="/{vdcUuid}/ipsets/{ipsetId}")
IpSetResponse updateIpSet(@PathParam(value="vdcUuid")
String vdcUuid,
@PathParam(value="ipsetId")
String ipSetId,
IpSetUpdateRequest ipSetUpdateRequest)
vdcUuid - vDC uuidipSetId - ip set id (e.g. ipset-1)ipSetUpdateRequest - ip set update request@DELETE
@Path(value="/{vdcUuid}/ipsets/{ipsetId}")
void deleteIpSet(@PathParam(value="vdcUuid")
String vdcUuid,
@PathParam(value="ipsetId")
String ipSetId)
vdcUuid - vDC uuidipSetId - ip set id (e.g. ipset-1)@GET
@Path(value="/{vdcUuid}/applications")
ApplicationListResponse getApplications(@PathParam(value="vdcUuid")
String vdcUuid)
vdcUuid - vdc uuid@GET
@Path(value="/{vdcUuid}/applications/{applicationId}")
ApplicationResponse getApplication(@PathParam(value="vdcUuid")
String vdcUuid,
@PathParam(value="applicationId")
String applicationId)
vdcUuid - vdc uuidapplicationId - application grouping object id (e.g. application-1)@GET
@Path(value="/{vdcUuid}/application-groups")
ApplicationGroupListResponse getApplicationGroups(@PathParam(value="vdcUuid")
String vdcUuid)
vdcUuid - vdc uuid@GET
@Path(value="/{vdcUuid}/application-groups/{applicationGroupId}")
ApplicationGroupResponse getApplicationGroup(@PathParam(value="vdcUuid")
String vdcUuid,
@PathParam(value="applicationGroupId")
String applicationGroupId)
vdcUuid - vdc uuidapplicationGroupId - application group id (e.g. applicationgroup-1)@GET
@Path(value="/{vdcUuid}/macsets/{macsetId}")
MacSetResponse getMacSet(@PathParam(value="vdcUuid")
String vdcUuid,
@PathParam(value="macsetId")
String macSetId)
vdcUuid - vDC uuidmacSetId - mac set id (e.g. macset-1)@PUT
@Path(value="/{vdcUuid}/macsets/{macsetId}")
MacSetResponse updateMacSet(@PathParam(value="vdcUuid")
String vdcUuid,
@PathParam(value="macsetId")
String macSetId,
MacSetUpdateRequest macSetUpdateRequest)
vdcUuid - vDC uuidmacSetId - mac set id (e.g. macset-1)macSetUpdateRequest - mac set update request@DELETE
@Path(value="/{vdcUuid}/macsets/{macsetId}")
void deleteMacSet(@PathParam(value="vdcUuid")
String vdcUuid,
@PathParam(value="macsetId")
String macSetId)
vdcUuid - vDC uuidmacSetId - mac set id (e.g. macset-1)@GET
@Path(value="/{vdcUuid}/security-tags")
SecurityTagsResponse getSecurityTags(@PathParam(value="vdcUuid")
String vdcUuid)
vdcUuid - vDC uuid@GET
@Path(value="/{vdcUuid}/security-tags/{securitytagId}")
SecurityTagWithAssignedVMsResponse getSecurityTag(@PathParam(value="vdcUuid")
String vdcUuid,
@PathParam(value="securitytagId")
String securitytagId)
vdcUuid - vDC uuidsecuritytagId - security tag id (e.g. securitytag-1)@POST
@Path(value="/{vdcUuid}/security-tags")
@Consumes(value="application/json")
SecurityTagWithAssignedVMsResponse createSecurityTag(@PathParam(value="vdcUuid")
String vdcUuid,
SecurityTagCreateRequest createRequest)
vdcUuid - vDC uuidcreateRequest - create request@PUT
@Path(value="/{vdcUuid}/security-tags/{securitytagId}")
SecurityTagWithAssignedVMsResponse updateSecurityTag(@PathParam(value="vdcUuid")
String vdcUuid,
@PathParam(value="securitytagId")
String securitytagId,
SecurityTagUpdateRequest updateRequest)
vdcUuid - vDC uuidsecuritytagId - security tag id (e.g. securitytag-1)updateRequest - update request@DELETE
@Path(value="/{vdcUuid}/security-tags/{securitytagId}")
void deleteSecurityTag(@PathParam(value="vdcUuid")
String vdcUuid,
@PathParam(value="securitytagId")
String securitytagId)
vdcUuid - vDC uuidsecuritytagId - security tag id (e.g. securitytag-1)@GET
@Path(value="/{vdcUuid}/security-tag-objects")
SecurityTagObjectTypeListResponse getSecurityTagObjectTypes(@PathParam(value="vdcUuid")
String vdcUuid)
vdcUuid - vDC uuid@GET
@Path(value="/{vdcUuid}/security-tag-objects/{type}")
SecurityTagObjectListResponse getSecurityTagObjects(@PathParam(value="vdcUuid")
String vdcUuid,
@PathParam(value="type")
String type,
@BeanParam
ObjectPagingParams filter)
vdcUuid - vDC uuidtype - security tag object typefilter - security tag object filter@GET
@Path(value="/{vdcUuid}/security-groups")
SecurityGroupsResponse getSecurityGroups(@PathParam(value="vdcUuid")
String vdcUuid)
vdcUuid - vDC uuid@GET
@Path(value="/{vdcUuid}/security-groups/{securitygroupId}")
SecurityGroupResponse getSecurityGroup(@PathParam(value="vdcUuid")
String vdcUuid,
@PathParam(value="securitygroupId")
String securitygroupId)
vdcUuid - vDC uuidsecuritygroupId - security group id (e.g. securitygroup-1)@POST
@Path(value="/{vdcUuid}/security-groups")
SecurityGroupResponse createSecurityGroup(@PathParam(value="vdcUuid")
String vdcUuid,
SecurityGroupCreateRequest createRequest)
vdcUuid - vDC uuidcreateRequest - create request@PUT
@Path(value="/{vdcUuid}/security-groups/{securitygroupId}")
SecurityGroupResponse updateSecurityGroup(@PathParam(value="vdcUuid")
String vdcUuid,
@PathParam(value="securitygroupId")
String securitygroupId,
SecurityGroupUpdateRequest updateRequest)
vdcUuid - vDC uuidsecuritygroupId - security group id (e.g. securitygroup-1)updateRequest - update request@DELETE
@Path(value="/{vdcUuid}/security-groups/{securitygroupId}")
void deleteSecurityGroup(@PathParam(value="vdcUuid")
String vdcUuid,
@PathParam(value="securitygroupId")
String securitygroupId)
vdcUuid - vDC uuidsecuritygroupId - security group id (e.g. securitygroup-1)@GET
@Path(value="/{vdcUuid}/security-group-members")
SecurityGroupMemberTypeListResponse getSecurityGroupMemberTypes(@PathParam(value="vdcUuid")
String vdcUuid)
vdcUuid - vDC uuid@GET
@Path(value="/{vdcUuid}/security-group-members/{type}")
SecurityGroupMemberListResponse getSecurityGroupMembers(@PathParam(value="vdcUuid")
String vdcUuid,
@PathParam(value="type")
String type,
@BeanParam
ObjectPagingParams filter)
vdcUuid - vDC uuidtype - security group member typefilter - security group member filter@GET
@Path(value="/{vdcUuid}/backup-groups")
BackupGroupListResponse listBackupGroups(@PathParam(value="vdcUuid")
String vdcUuid,
@QueryParam(value="includeDeleted")
boolean includeDeleted,
@QueryParam(value="includeSummaryStats")
boolean includeSummaryStats,
@QueryParam(value="includeLastRun")
boolean includeLastRun,
@QueryParam(value="includeBackupPolicy")
boolean includeBackupPolicy)
vdcUuid - the UUID of the vDCincludeDeleted - whether to include deleted backup groupsincludeSummaryStats - whether to include backup summary statsincludeLastRun - whether to include last run info in the response.includeBackupPolicy - whether to include backup policy detailsBackupGroupListResponse@GET
@Path(value="/{vdcUuid}/backup-group-summary-stats")
VdcBackupSummaryStatsResponse getBackupGroupSummaryStats(@PathParam(value="vdcUuid")
String vdcUuid,
@BeanParam
GetBackupGroupSummaryStatsFilters filters)
Stat time-range defaults to the past 24 hours.
vdcUuid - the UUID of the vDCfilters - optional filters that can be used to specify a custom
timeframe.VdcBackupSummaryStatsResponse@POST
@Path(value="/{vdcUuid}/backup-groups")
@Consumes(value="application/json")
BackupGroupResponse createBackupGroup(@PathParam(value="vdcUuid")
String vdcUuid,
BackupGroupUpdateRequest creationRequest)
vdcUuid - the UUID of the virtual datacentercreationRequest - the creation request bodyBackupGroupResponse@GET
@Path(value="/{vdcUuid}/backup-policies")
BackupPolicyListResponse listBackupPolicies(@PathParam(value="vdcUuid")
String vdcUuid,
@QueryParam(value="includeOrgPolicies")
boolean includeOrgPolicies)
vdcUuid - the UUID of the vDCincludeOrgPolicies - whether to include org-scoped policies from the parent orgBackupPolicyListResponse@GET
@Path(value="/{vdcUuid}/backup-policies/{backupPolicyUid}")
BackupPolicyResponse getBackupPolicy(@PathParam(value="vdcUuid")
String vdcUuid,
@PathParam(value="backupPolicyUid")
String backupPolicyUid)
backupPolicyUid - the UID of the backup policyvdcUuid - the UUID of the vdcBackupPolicyResponse@POST
@Path(value="/{vdcUuid}/backup-policies")
@Consumes(value="application/json")
BackupPolicyResponse createBackupPolicy(@PathParam(value="vdcUuid")
String vdcUuid,
BackupPolicyUpdateRequest creationRequest)
vdcUuid - the UUID of the vdccreationRequest - the creation request bodyBackupPolicyResponse@PUT
@Path(value="/{vdcUuid}/backup-policies/{backupPolicyUid}")
@Consumes(value="application/json")
BackupPolicyResponse updateBackupPolicy(@PathParam(value="vdcUuid")
String vdcUuid,
@PathParam(value="backupPolicyUid")
String backupPolicyUid,
BackupPolicyUpdateRequest updateRequest)
vdcUuid - the UUID of the vdcbackupPolicyUid - the UID of the backup policyupdateRequest - the update request bodyBackupPolicyResponse@DELETE
@Path(value="/{vdcUuid}/backup-policies/{backupPolicyUid}")
@Consumes(value="application/json")
void deleteBackupPolicy(@PathParam(value="vdcUuid")
String vdcUuid,
@PathParam(value="backupPolicyUid")
String backupPolicyUid)
vdcUuid - the UUID of the vdcbackupPolicyUid - the UID of the backup policy@GET
@Path(value="/{vdcUuid}/backup-runs")
BackupGroupRunListResponse listBackupGroupRuns(@PathParam(value="vdcUuid")
String vdcUuid,
@BeanParam
ListBackupGroupRunsQueryParams params)
Limit defaults to 10 and query time range defaults to last 24 hours.
vdcUuid - the vDC UUIDparams - query filter paramsBackupGroupRunListResponse@GET
@Path(value="/{vdcUuid}/backup-status")
VdcBackupStatusResponse getBackupStatus(@PathParam(value="vdcUuid")
String vdcUuid)
vdcUuid - the UUID of the vDC@GET
@Path(value="/{vdcUuid}/integrated-backup-status")
VdcIntegratedBackupStatusDetailResponse getIntegratedBackupStatus(@PathParam(value="vdcUuid")
String vdcUuid)
vdcUuid - the UUID of the vDC@GET
@Path(value="/{vdcUuid}/recoverable-files-and-folders")
RecoverableFilesSearchResultListResponse searchRecoverableFilesAndFolders(@PathParam(value="vdcUuid")
String vdcUuid,
@BeanParam
SearchVdcRecoverableFilesAndFoldersFilters filters)
vdcUuid - the UUID of the vDCfilters - optional query filters@GET
@Path(value="/{vdcUuid}/backup-storage-metrics")
VdcBackupStorageMetricListResponse getBackupStorageMetrics(@PathParam(value="vdcUuid")
String vdcUuid)
vdcUuid - the UUID of the vDC@GET
@Path(value="/{vdcUuid}/backup-storage-metrics/{metric}/samples")
VdcBackupStorageSampleSeriesResponse getBackupStorageSamples(@PathParam(value="vdcUuid")
String vdcUuid,
@PathParam(value="metric")
VdcBackupStorageMetric metric,
@BeanParam
GetBackupStorageSamplesFilters filters)
vdcUuid - the UUID of the vDCmetric - the storage metric namefilters - optional filters for the start and end of the series@GET
@Path(value="/{vdcUuid}/iaas-backup-bills")
IaasBackupBillListResponse listIaasBackupBills(@PathParam(value="vdcUuid")
String vdcUuid,
@QueryParam(value="start")
String start,
@QueryParam(value="end")
String end)
Both start and end time query params default to the current month.
vdcUuid - the UUID of the vDCstart - Specifies the start of the range as a year-month in the ISO-8601 calendar system, such as 2007-12.end - Specifies the end of the range as a year-month in the ISO-8601 calendar system, such as 2007-12.@GET
@Path(value="/{vdcUuid}/iaas-backup-subscriptions")
IaasBackupSubscriptionListResponse listIaasBackupSubscriptions(@PathParam(value="vdcUuid")
String vdcUuid,
@QueryParam(value="startTimeMillis")
Long startTimeMillis,
@QueryParam(value="endTimeMillis")
Long endTimeMillis)
vdcUuid - the UUID of the vDCstartTimeMillis - the start time in epoch millisendTimeMillis - the end time in epoch millis@GET
@Path(value="/{vdcUuid}/recoverable-vms")
VMBackupSnapshotListResponse searchRecoverableVMs(@PathParam(value="vdcUuid")
String vdcUuid,
@BeanParam
SearchVdcRecoverableVMsFilters filters)
vdcUuid - the UUID of the vDCfilters - optional query filters@POST
@Path(value="/{vdcUuid}/actions/restore-vm-backups")
TaskResponse restoreVMBackupsInVdc(@PathParam(value="vdcUuid")
String vdcUuid,
RestoreVMBackupsInVdcParams params)
vdcUuid - the UUID of the vDCparams - restoration parameters@GET
@Path(value="/{vdcUuid}/backup-cluster-info")
VdcBackupClusterInfo getVdcBackupClusterInfo(@PathParam(value="vdcUuid")
String vdcUuid)
vdcUuid - the UUID of the vDC@GET
@Path(value="/{vdcUuid}/backup-restore-tasks")
BackupRestoreTaskListResponse listBackupRestoreTasks(@PathParam(value="vdcUuid")
String vdcUuid,
@BeanParam
ListBackupRestoreTasksFilters filters)
vdcUuid - the UUID of the vDCfilters - optional query filters@GET
@Path(value="/{vdcUuid}/backup-restore-tasks/{restoreTaskUid}")
BackupRestoreTaskDetailResponse getBackupRestoreTask(@PathParam(value="vdcUuid")
String vdcUuid,
@PathParam(value="restoreTaskUid")
String restoreTaskUid)
vdcUuid - the UUID of the vDCrestoreTaskUid - the UID of the restore task to retrieveCopyright © 2023 iland Internet Solutions, Corp. All rights reserved.