Resource Representations for Resource Collections
For collections of key resources, Veeam Backup Enterprise Manager REST API provides the same two types of representations as for specific entities of key resources:
- Entity reference resource representation
- Entity resource representation
For example, a reference representation for a collection of cloud tenant accounts looks similar to the following:
XML Representation
<EntityReferences xmlns="http://www.veeam.com/ent/v1.0"> |
JSON Representation
{ "Refs": [ { "Links": [ { "Rel": "Up", "Href": "https://srv13.tech.local:9398/api/backupServers/4ceb4e03-d23d-4c4e-be05-21580b260243", "Name": "srv13.tech.local", "Type": "BackupServerReference" }, { "Rel": "Alternate", "Href": "https://srv13.tech.local:9398/api/cloud/tenants/b7c7f152-a44a-4651-94df-40bb14cfe840?format=Entity", "Name": "QWE Systems", "Type": "CloudTenant" } ], "UID": "urn:veeam:CloudTenant:b7c7f152-a44a-4651-94df-40bb14cfe840", "Name": "QWE Systems", "Href": "https://srv13.tech.local:9398/api/cloud/tenants/b7c7f152-a44a-4651-94df-40bb14cfe840", "Type": "CloudTenantReference" }, { "Links": [ { "Rel": "Up", "Href": "https://srv13.tech.local:9398/api/backupServers/4ceb4e03-d23d-4c4e-be05-21580b260243", "Name": "srv13.tech.local", "Type": "BackupServerReference" }, { "Rel": "Alternate", "Href": "https://srv13.tech.local:9398/api/cloud/tenants/e38a8692-6816-443e-9052-7fa71ee7fd65?format=Entity", "Name": "ABC Company", "Type": "CloudTenant" } ], "UID": "urn:veeam:CloudTenant:e38a8692-6816-443e-9052-7fa71ee7fd65", "Name": "ABC Company", "Href": "https://srv13.tech.local:9398/api/cloud/tenants/e38a8692-6816-443e-9052-7fa71ee7fd65", "Type": "CloudTenantReference" }, { "Links": [ { "Rel": "Up", "Href": "https://srv13.tech.local:9398/api/backupServers/4ceb4e03-d23d-4c4e-be05-21580b260243", "Name": "srv13.tech.local", "Type": "BackupServerReference" }, { "Rel": "Alternate", "Href": "https://srv13.tech.local:9398/api/cloud/tenants/55d37e56-4f2f-40a9-894e-e094f57e6dd9?format=Entity", "Name": "TechCompanyOrg", "Type": "CloudTenant" } ], "UID": "urn:veeam:CloudTenant:55d37e56-4f2f-40a9-894e-e094f57e6dd9", "Name": "TechCompanyOrg", "Href": "https://srv13.tech.local:9398/api/cloud/tenants/55d37e56-4f2f-40a9-894e-e094f57e6dd9", "Type": "CloudTenantReference" } ] } |
To get an entity representation of the resource collection, the client should send the GET HTTP request to the URL of the resource entity, for example:
GET https://localhost:9398/api/cloud/tenants?format=Entity |
In the response, the server returns an entity representation providing complete information about all resources in the collection:
XML representation
<CloudTenants xmlns="http://www.veeam.com/ent/v1.0"> |
JSON representation
{ "CloudTenants": [ { "Password": null, "Description": "Tenant account for QWE Systems", "Enabled": true, "LeaseOptions": { "Enabled": false }, "Resources": { "CloudTenantResources": [ { "RepositoryQuota": { "DisplayName": "Repository 1", "RepositoryUid": "urn:veeam:Repository:5236d23a-c8a9-4bbf-9e4a-26b4c63e339d", "WanAcceleratorUid": null, "Quota": 256000, "UsedQuota": 169903 }, "Id": "5416d479-70fa-4ba1-8751-46f4cd60822f", "Links": null, "Href": "https://srv13.tech.local:9398/api/cloud/tenants/b7c7f152-a44a-4651-94df-40bb14cfe840/resources/5416d479-70fa-4ba1-8751-46f4cd60822f", "Type": "CloudTenantResource" }, { "RepositoryQuota": { "DisplayName": "QWE Vol 02", "RepositoryUid": "urn:veeam:Repository:003a6ffe-b9f5-4e37-9aa8-27c468d827da", "WanAcceleratorUid": null, "Quota": 10240, "UsedQuota": 103 }, "Id": "e6d8d2f9-19f6-4cd2-a971-67db539e7de8", "Links": null, "Href": "https://srv13.tech.local:9398/api/cloud/tenants/b7c7f152-a44a-4651-94df-40bb14cfe840/resources/e6d8d2f9-19f6-4cd2-a971-67db539e7de8", "Type": "CloudTenantResource" } ] }, "LastResult": "Success", "LastActive": "2020-02-03T14:20:27.177Z", "ComputeResources": { "CloudTenantComputeResources": null }, "ThrottlingEnabled": false, "ThrottlingSpeedLimit": 1, "ThrottlingSpeedUnit": "MBps", "PublicIpCount": 0, "BackupCount": 0, "ReplicaCount": 0, "MaxConcurrentTasks": 1, "WorkStationBackupCount": 0, "ServerBackupCount": 2, "BackupProtectionEnabled": true, "BackupProtectionPeriod": 3, "TenantType": { "StandaloneTenant": { "TenantCredentials": { "Username": "QWE Systems", "Password": null } }, "vCloudTenant": null }, "VCloudComputeResources": null, "CloudGatewayPools": null, "Name": "QWE Systems", "UID": "urn:veeam:CloudTenant:b7c7f152-a44a-4651-94df-40bb14cfe840", "Links": [ { "Rel": "Up", "Href": "https://srv13.tech.local:9398/api/backupServers/4ceb4e03-d23d-4c4e-be05-21580b260243", "Name": "srv13.tech.local", "Type": "BackupServerReference" }, { "Rel": "Alternate", "Href": "https://srv13.tech.local:9398/api/cloud/tenants/b7c7f152-a44a-4651-94df-40bb14cfe840", "Name": "QWE Systems", "Type": "CloudTenantReference" }, { "Rel": "Edit", "Href": "https://srv13.tech.local:9398/api/cloud/tenants/b7c7f152-a44a-4651-94df-40bb14cfe840", "Name": "QWE Systems", "Type": "CloudTenantReference" }, { "Rel": "Down", "Href": "https://srv13.tech.local:9398/api/cloud/tenants/b7c7f152-a44a-4651-94df-40bb14cfe840/resources", "Type": "CloudTenantResourceList" }, { "Rel": "Create", "Href": "https://srv13.tech.local:9398/api/cloud/tenants/b7c7f152-a44a-4651-94df-40bb14cfe840/resources", "Type": "CloudTenantResource" }, { "Rel": "Delete", "Href": "https://srv13.tech.local:9398/api/cloud/tenants/b7c7f152-a44a-4651-94df-40bb14cfe840" }, { "Rel": "Down", "Href": "https://srv13.tech.local:9398/api/cloud/tenants/b7c7f152-a44a-4651-94df-40bb14cfe840/computeResources", "Type": "CloudTenantComputeResourceList" }, { "Rel": "Create", "Href": "https://srv13.tech.local:9398/api/cloud/tenants/b7c7f152-a44a-4651-94df-40bb14cfe840/computeResources", "Type": "CloudTenantComputeResource" }, { "Rel": "Down", "Href": "https://srv13.tech.local:9398/api/cloud/tenants/b7c7f152-a44a-4651-94df-40bb14cfe840/subtenants", "Type": "CloudSubtenantList" }, { "Rel": "Create", "Href": "https://srv13.tech.local:9398/api/cloud/tenants/b7c7f152-a44a-4651-94df-40bb14cfe840/subtenants", "Type": "CloudSubtenant" }, { "Rel": "Related", "Href": "https://srv13.tech.local:9398/api/cloud/tenants/b7c7f152-a44a-4651-94df-40bb14cfe840/freelicenseCounters", "Name": "FreeLicenseCounters", "Type": "FreeLicenseCounters" } ], "Href": "https://srv13.tech.local:9398/api/cloud/tenants/b7c7f152-a44a-4651-94df-40bb14cfe840?format=Entity", "Type": "CloudTenant" }, { "Password": null, "Description": "Tenant account for ABC Company", "Enabled": true, "LeaseOptions": { "Enabled": false }, "Resources": { "CloudTenantResources": [ { "RepositoryQuota": { "DisplayName": "ABC Company Repository", "RepositoryUid": "urn:veeam:Repository:5236d23a-c8a9-4bbf-9e4a-26b4c63e339d", "WanAcceleratorUid": null, "Quota": 204800, "UsedQuota": 49260 }, "Id": "502686fc-44ea-4f8b-b5f6-7c11a90aa12d", "Links": null, "Href": "https://srv13.tech.local:9398/api/cloud/tenants/e38a8692-6816-443e-9052-7fa71ee7fd65/resources/502686fc-44ea-4f8b-b5f6-7c11a90aa12d", "Type": "CloudTenantResource" } ] }, "LastResult": "Warning", "LastActive": "2020-02-03T07:13:02.22Z", "ComputeResources": { "CloudTenantComputeResources": [ { "CloudHardwarePlanUid": "urn:veeam:CloudHardwarePlan:1c355c26-faed-4625-a61a-71fb033935db", "WanAcceleratorUid": null, "PlatformType": "VMware", "UseNetworkFailoverResources": true, "NetworkAppliance": { "Name": "ABC Company", "ProductionNetwork": "VM Network", "ObtainIPAddressAutomatically": true, "ManualIpAddressSettingsInfoType": null, "ViDistributedSwitchUuid": "", "ProductionNetworkUnderDvs": false }, "ComputeResourceStats": { "MemoryUsageMb": 8192, "CPUCount": 4, "StorageResourceStats": { "StorageResourceStats": [ { "StorageName": "Cloud Replicas", "StorageUsageGb": 68, "StorageLimitGb": 300 } ] } }, "Id": "be65b70a-5305-43d3-bfeb-651c910118e7", "Links": null, "Href": "https://srv13.tech.local:9398/api/cloud/tenants/e38a8692-6816-443e-9052-7fa71ee7fd65/computeResources/be65b70a-5305-43d3-bfeb-651c910118e7", "Type": "CloudTenantComputeResource" } ] }, "ThrottlingEnabled": true, "ThrottlingSpeedLimit": 10, "ThrottlingSpeedUnit": "MBps", "PublicIpCount": 2, "BackupCount": 2, "ReplicaCount": 2, "MaxConcurrentTasks": 2, "WorkStationBackupCount": 0, "ServerBackupCount": 0, "BackupProtectionEnabled": true, "BackupProtectionPeriod": 14, "TenantType": { "StandaloneTenant": { "TenantCredentials": { "Username": "ABC Company", "Password": null } }, "vCloudTenant": null }, "VCloudComputeResources": null, "CloudGatewayPools": null, "Name": "ABC Company", "UID": "urn:veeam:CloudTenant:e38a8692-6816-443e-9052-7fa71ee7fd65", "Links": [ { "Rel": "Up", "Href": "https://srv13.tech.local:9398/api/backupServers/4ceb4e03-d23d-4c4e-be05-21580b260243", "Name": "srv13.tech.local", "Type": "BackupServerReference" }, { "Rel": "Alternate", "Href": "https://srv13.tech.local:9398/api/cloud/tenants/e38a8692-6816-443e-9052-7fa71ee7fd65", "Name": "ABC Company", "Type": "CloudTenantReference" }, { "Rel": "Edit", "Href": "https://srv13.tech.local:9398/api/cloud/tenants/e38a8692-6816-443e-9052-7fa71ee7fd65", "Name": "ABC Company", "Type": "CloudTenantReference" }, { "Rel": "Down", "Href": "https://srv13.tech.local:9398/api/cloud/tenants/e38a8692-6816-443e-9052-7fa71ee7fd65/resources", "Type": "CloudTenantResourceList" }, { "Rel": "Create", "Href": "https://srv13.tech.local:9398/api/cloud/tenants/e38a8692-6816-443e-9052-7fa71ee7fd65/resources", "Type": "CloudTenantResource" }, { "Rel": "Delete", "Href": "https://srv13.tech.local:9398/api/cloud/tenants/e38a8692-6816-443e-9052-7fa71ee7fd65" }, { "Rel": "Down", "Href": "https://srv13.tech.local:9398/api/cloud/tenants/e38a8692-6816-443e-9052-7fa71ee7fd65/computeResources", "Type": "CloudTenantComputeResourceList" }, { "Rel": "Create", "Href": "https://srv13.tech.local:9398/api/cloud/tenants/e38a8692-6816-443e-9052-7fa71ee7fd65/computeResources", "Type": "CloudTenantComputeResource" }, { "Rel": "Down", "Href": "https://srv13.tech.local:9398/api/cloud/tenants/e38a8692-6816-443e-9052-7fa71ee7fd65/subtenants", "Type": "CloudSubtenantList" }, { "Rel": "Create", "Href": "https://srv13.tech.local:9398/api/cloud/tenants/e38a8692-6816-443e-9052-7fa71ee7fd65/subtenants", "Type": "CloudSubtenant" }, { "Rel": "Related", "Href": "https://srv13.tech.local:9398/api/cloud/tenants/e38a8692-6816-443e-9052-7fa71ee7fd65/freelicenseCounters", "Name": "FreeLicenseCounters", "Type": "FreeLicenseCounters" } ], "Href": "https://srv13.tech.local:9398/api/cloud/tenants/e38a8692-6816-443e-9052-7fa71ee7fd65?format=Entity", "Type": "CloudTenant" }, { "Password": null, "Description": "Tenant account for TechCompany", "Enabled": true, "LeaseOptions": { "Enabled": false }, "Resources": { "CloudTenantResources": [ { "RepositoryQuota": { "DisplayName": "TechCompany Cloud Vol", "RepositoryUid": "urn:veeam:Repository:5236d23a-c8a9-4bbf-9e4a-26b4c63e339d", "WanAcceleratorUid": null, "Quota": 102400, "UsedQuota": 85 }, "Id": "e464930b-7fb6-4cd4-992a-9c6c14eaf3b3", "Links": null, "Href": "https://srv13.tech.local:9398/api/cloud/tenants/55d37e56-4f2f-40a9-894e-e094f57e6dd9/resources/e464930b-7fb6-4cd4-992a-9c6c14eaf3b3", "Type": "CloudTenantResource" } ] }, "LastResult": "Failed", "LastActive": "2020-02-02T20:33:04.52Z", "ComputeResources": { "CloudTenantComputeResources": null }, "ThrottlingEnabled": false, "ThrottlingSpeedLimit": 1, "ThrottlingSpeedUnit": "MBps", "PublicIpCount": 0, "BackupCount": 0, "ReplicaCount": 1, "MaxConcurrentTasks": 2, "WorkStationBackupCount": 0, "ServerBackupCount": 0, "BackupProtectionEnabled": false, "BackupProtectionPeriod": 1, "TenantType": { "StandaloneTenant": null, "vCloudTenant": { "OrganizationName": "TechCompanyOrg", "OrganizationRef": "urn:vCloud:Organization:7b8c3fa3-b664-43d6-8a59-19803997ce48.urn:vcloud:org:49c8966b-260a-4d3b-9bca-d0cc6349a9a6" } }, "VCloudComputeResources": { "CloudTenantVCloudComputeResources": [ { "VirtualDataCenterName": "TechCompanyOrgVDC", "VirtualDataCenterRef": "urn:vCloud:OrgVdc:7b8c3fa3-b664-43d6-8a59-19803997ce48.urn:vcloud:vdc:64318a39-a879-4a27-8e5d-58fae0fafaab", "Enabled": true, "AllocationModel": "AllocationPool", "UseNetworkFailoverResources": false, "ResourceUsage": { "CpuUsageMhz": 0, "MemoryUsageMb": 0, "StorageUsageGb": 16 }, "WanAcceleratorUid": null, "NetworkAppliance": null, "Id": "64318a39-a879-4a27-8e5d-58fae0fafaab", "Links": null, "Href": "https://srv13.tech.local:9398/api/cloud/tenants/55d37e56-4f2f-40a9-894e-e094f57e6dd9/vcloudcomputeresources/64318a39-a879-4a27-8e5d-58fae0fafaab", "Type": "CloudTenantVCloudComputeResource" } ] }, "CloudGatewayPools": null, "Name": "TechCompanyOrg", "UID": "urn:veeam:CloudTenant:55d37e56-4f2f-40a9-894e-e094f57e6dd9", "Links": [ { "Rel": "Up", "Href": "https://srv13.tech.local:9398/api/backupServers/4ceb4e03-d23d-4c4e-be05-21580b260243", "Name": "srv13.tech.local", "Type": "BackupServerReference" }, { "Rel": "Alternate", "Href": "https://srv13.tech.local:9398/api/cloud/tenants/55d37e56-4f2f-40a9-894e-e094f57e6dd9", "Name": "TechCompanyOrg", "Type": "CloudTenantReference" }, { "Rel": "Edit", "Href": "https://srv13.tech.local:9398/api/cloud/tenants/55d37e56-4f2f-40a9-894e-e094f57e6dd9", "Name": "TechCompanyOrg", "Type": "CloudTenantReference" }, { "Rel": "Down", "Href": "https://srv13.tech.local:9398/api/cloud/tenants/55d37e56-4f2f-40a9-894e-e094f57e6dd9/resources", "Type": "CloudTenantResourceList" }, { "Rel": "Create", "Href": "https://srv13.tech.local:9398/api/cloud/tenants/55d37e56-4f2f-40a9-894e-e094f57e6dd9/resources", "Type": "CloudTenantResource" }, { "Rel": "Delete", "Href": "https://srv13.tech.local:9398/api/cloud/tenants/55d37e56-4f2f-40a9-894e-e094f57e6dd9" }, { "Rel": "Down", "Href": "https://srv13.tech.local:9398/api/cloud/tenants/55d37e56-4f2f-40a9-894e-e094f57e6dd9/vcloudcomputeresources", "Type": "CloudTenantVCloudComputeResourceList" }, { "Rel": "Create", "Href": "https://srv13.tech.local:9398/api/cloud/tenants/55d37e56-4f2f-40a9-894e-e094f57e6dd9/vcloudcomputeresources", "Type": "CloudTenantVCloudComputeResource" }, { "Rel": "Related", "Href": "https://srv13.tech.local:9398/api/cloud/tenants/55d37e56-4f2f-40a9-894e-e094f57e6dd9/freelicenseCounters", "Name": "FreeLicenseCounters", "Type": "FreeLicenseCounters" } ], "Href": "https://srv13.tech.local:9398/api/cloud/tenants/55d37e56-4f2f-40a9-894e-e094f57e6dd9?format=Entity", "Type": "CloudTenant" } ] } |