Contents:
The Enterprise Resources Resource offers the data related to cloud resource usage for a specific enterprise.
Enterprise Resources Data Model
| Field Name | Type | Occurs | Required | Description |
|---|
| vCpuReserved | Long | 1 | true | Maximum number of Virtual CPUs reserved for this enterprise. |
| vCpuUsed | Long | 1 | true | Total number of Virtual CPUs in Virtual Machines currently in a running state. |
| memoryReserved | Long | 1 | true | Maximum amount of RAM reserved for this enterprise in megabytes. |
| memoryUsed | Long | 1 | true | Total amount of RAM used by Virtual Machines currently in a running state in megabytes. |
| localStorageReserved | Long | 1 | true | Maximum storage size reserved for this enterprise for Virtual Machines in megabytes. |
| localStorageUsed | Long | 1 | true | Total storage size used by Virtual Machines currently in a running state in megabytes. |
| extStorageReserved | Long | 1 | true | Maximum external storage size reserved for this enterprise in megabytes. |
| extStorageUsed | Long | 1 | true | External storage used (attached or mounted) by any virtual machines (in megabytes) |
| repositoryReserved | Long | 1 | true | Maximum repository size reserved for this enterprise in megabytes. |
| repositoryUsed | Long | 1 | true | Total repository size currently used for this enterprise in megabytes. |
| publicIPsReserved | Long | 1 | true | Total number of IPs assigned to a VirtualDatacenter (Reserved) |
| publicIPsUsed | Long | 1 | true | Total number of IPs used by virtual machines |
| vlanReserved | Long | 1 | true | Total maximum number of VLANs reserved for this enterprise. (enterprise.vlanHard) |
| vlanUsed | Long | 1 | true | Total number of VLANs in use by any datacenter managed. |
Methods related to EnterpriseResources Resource
Retrieve Enterprise Resource Usage data for the whole System
Synopsis: GET http://example.com/admin/statistics/enterpriseresources/actions/total
Roles needed: ROLE_ENTERPRISE_RESOURCE_SUMMARY_ENT (Check out role definitions here)
REQUEST
Request Headers: Accept, Content-Type.
Request Parameters: N/A.
Request Message Body: N/A.
Example Request: Retrieve Enterprise Resources usage Data for the whole System..
% curl --verbose 'http://example.com/api/admin/statistics/enterpriseresources/actions/total' \ -X GET \ -H "Content-type:application/xml" \ -H "Accept:application/xml" > GET /api/admin/statistics/enterpriseresources/actions/total HTTP/1.1 > User-Agent: curl/7.21.0 (i686-pc-linux-gnu) libcurl/7.21.0 OpenSSL/0.9.8o zlib/1.2.3.4 libidn/1.18 > Host: localhost > Content-type:application/xml > Accept:application/xml/actions/total
RESPONSE
Response Headers: Content-Length, Content-Type.
Response Message Body: [enterpriseresources].
Response Status: 200, 401, 403.
Example Response: Response of the GET over EnterpriseResources
< HTTP/1.1 200 OK < Content-Type: application/xml < <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <enterpriseresources> <extStorageReserved>0</extStorageReserved> <extStorageUsed>0</extStorageUsed> <localStorageReserved>0</localStorageReserved> <localStorageUsed>0</localStorageUsed> <memoryReserved>0</memoryReserved> <memoryUsed>0</memoryUsed> <publicIPsReserved>0</publicIPsReserved> <publicIPsUsed>0</publicIPsUsed> <repositoryReserved>0</repositoryReserved> <repositoryUsed>0</repositoryUsed> <virtualCpuReserved>0</virtualCpuReserved> <virtualCpuUsed>0</virtualCpuUsed> <vlanReserved>0</vlanReserved> <vlanUsed>0</vlanUsed> </enterpriseresources>
Retrieve Enterprise Resource Usage Data for an Enterprise
Synopsis: GET http://example.com/api/admin/statistics/enterpriseresources/{$enterpriseId}
Roles needed: ROLE_AUTHENTICATED (Check out role definitions here)
REQUEST
Request Headers: Accept, Content-Type.
Request Parameters: N/A.
Request Message Body: N/A.
Example Request: Retrieve Cloud usage Data for the whole System..
% curl --verbose 'http://example.com/api/admin/statistics/enterpriseresources/{$enterpriseId}' \ -X GET \ -H "Content-type:application/xml" \ -H "Accept:application/xml" > GET /api/admin/statistics/enterpriseresources/1/ HTTP/1.1 > User-Agent: curl/7.21.0 (i686-pc-linux-gnu) libcurl/7.21.0 OpenSSL/0.9.8o zlib/1.2.3.4 libidn/1.18 > Host: localhost > Content-type:application/xml > Accept:application/xml
RESPONSE
Response Headers: Content-Length, Content-Type.
Response Message Body: [enterpriseresources].
Response Status: 200, 401, 403.
Example Response: Response of the GET over EntepriseResource
< HTTP/1.1 200 OK < Content-Type: application/xml < <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <enterpriseresources> <extStorageReserved>0</extStorageReserved> <extStorageUsed>0</extStorageUsed> <localStorageReserved>0</localStorageReserved> <localStorageUsed>0</localStorageUsed> <memoryReserved>0</memoryReserved> <memoryUsed>0</memoryUsed> <publicIPsReserved>0</publicIPsReserved> <publicIPsUsed>0</publicIPsUsed> <repositoryReserved>0</repositoryReserved> <repositoryUsed>0</repositoryUsed> <virtualCpuReserved>0</virtualCpuReserved> <virtualCpuUsed>0</virtualCpuUsed> <vlanReserved>0</vlanReserved> <vlanUsed>0</vlanUsed> </enterpriseresources>
