Get Capacity Usage By Compute Resource Rpt

Get Capacity Usage By Compute Resource Rpt

Retrieve a capacity usage report keyed by the compute resource.

Request
URI
GET
https://{api_host}/iaas-proxy-provider/api/reports/capacityUsageReport/byComputeResource
COPY
Query Parameters
string
computeResourceName
Optional

the name of the compute resource to show machines for, or null to include all machines

string
machineType
Optional

the type of machine to show, or null to include all types of machines.

integer
page
Optional

Page Number

integer
limit
Optional

Number of entries per page

string
$orderby
Optional

Multiple comma-separated properties sorted in ascending or descending order

integer
$top
Optional

Sets the number of returned entries from the top of the response (total number per page in relation to skip)

integer
$skip
Optional

Sets how many entries you would like to skip

string
$filter
Optional

Boolean expression for whether a particular entry should be included in the response


Responses
200

The report is retrieved.

[
    {
        "hostName": "string",
        "machinesTotal": 0,
        "storageAllocatedPercent": 0,
        "cpus": 0,
        "storageUsedGBTotal": 0,
        "memoryPhysicalMBTotal": 0,
        "storageReservedGBTotal": 0,
        "memoryAllocatedMBTotal": 0,
        "memoryReservedMBTotal": 0,
        "storageAllocatedGBTotal": 0,
        "machinesAllocated": 0,
        "storagePhysicalGBTotal": 0,
        "storageReservedPercent": 0,
        "memoryAllocatedPercent": 0,
        "href": "string",
        "memoryReservedPercent": 0,
        "machineType": "string"
    }
]