View Usage Summary Report

Details

API Details
NameView Usage Summary Report
Description

Displays the usage summary report for all tenants or for your tenant by cloud/application.

MethodGET
URI
  • v2/tenants/tenantId/reports?reportType=USAGE_SUMMARY_REPORT&startDate=startDate&endDate=endDate&groupBy=TENANT
  • v2/tenants/tenantId/reports?reportType=USAGE_SUMMARY_REPORT&startDate=startDate&endDate=endDate&groupBy=CLOUD
CloudCenter ReleaseIntroduced in CloudCenter 4.6
Notes
  • General Notes:
    • For additional context on <PORT> usage in the following example(s), see Base URI Format.
    • The CloudCenter GET APIs display up to 20 entities in the listing by default. If you have more than 20 entities in your resource listing, use the pagination query parameters to view them beyond the first 20 entities returned by default. See the CloudCenter API Overview  > Pagination  section for additional context.
  • API Notes:
    • Default: Group all clouds by tenant.
    • This API does not support sorting.

    • This API supports the CSV format for the response. See Response Schema > CSV (Only for Reports).
ESB Header
  • action: get.tenants.tenantId.reports
    actionparam: reportType=USAGE_SUMMARY_REPORT&startDate=startDate&endDate=endDate&groupBy=TENANT
  • action: get.tenants.tenantId.reports
    actionparam
    : reportType=USAGE_SUMMARY_REPORT&startDate=startDate&endDate=endDate&groupBy=CLOUD 
 

Example 1 – All Clouds by Tenant (Default)

curl -k -X GET -H "Accept: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v2/tenants/1/reports?reportType=USAGE_SUMMARY_REPORT&startDate=1467153811432&endDate=1469745811433&groupBy=TENANT"

Response

{
    "summary": {
        "numberOfTenants": 8,
        "numberOfClouds": 11,
        "totalCloudCost": 14525.64,
        "totalNodeHours": 144152.11,
        "totalNumberOfRunningVMs": 150
    },
    "spendDetailsByGroups": [{
        "groupName": "C Technologies Inc",
        "groupType": "TENANT",
        "tenantId": "1",
        "cloudFamily": null,
        "totalCloudCost": 281.4,
        "totalNodeHours": 2682.888,
        "totalNumberOfRunningVMs": 4,
        "details": [{
            "groupName": "C Technologies Inc",
            "groupType": "TENANT",
            "tenantId": "1",
            "tenantName": "C Technologies Inc",
            "cloudName": "Amazon-us-west-2",
            "cloudFamily": "Amazon",
            "cloudCost": 281.4,
            "nodeHours": 2682.888,
            "numberOfRunningVMs": 4
        }, {
            "groupName": "C Technologies Inc",
            "groupType": "TENANT",
            "tenantId": "1",
            "tenantName": "C Technologies Inc",
            "cloudName": "Azure-us-east",
            "cloudFamily": "Azure",
            "cloudCost": 0.0,
            "nodeHours": 0.0,
            "numberOfRunningVMs": 0
        }]
    }, {
        "groupName": "CloudCenter SE",
        "groupType": "TENANT",
        "tenantId": "5",
        "cloudFamily": null,
        "totalCloudCost": 609.69995,
        "totalNodeHours": 9386.32,
        "totalNumberOfRunningVMs": 11,
        "details": [{
            "groupName": "CloudCenter SE",
            "groupType": "TENANT",
            "tenantId": "5",
            "tenantName": "CloudCenter SE",
            "cloudName": "Amazon-us-east-1",
            "cloudFamily": "Amazon",
            "cloudCost": 168.84,
            "nodeHours": 1341.5889,
            "numberOfRunningVMs": 0
        }, {
            "groupName": "CloudCenter SE",
            "groupType": "TENANT",
            "tenantId": "5",
            "tenantName": "CloudCenter SE",
            "cloudName": "Amazon-us-west-2",
            "cloudFamily": "Amazon",
            "cloudCost": 206.35999,
            "nodeHours": 4694.1357,
            "numberOfRunningVMs": 6
        }, {
            "groupName": "CloudCenter SE",
            "groupType": "TENANT",
            "tenantId": "5",
            "tenantName": "CloudCenter SE",
            "cloudName": "Azure-us-east",
            "cloudFamily": "Azure",
            "cloudCost": 0.0,
            "nodeHours": 0.0,
            "numberOfRunningVMs": 0
        }, {
            "groupName": "CloudCenter SE",
            "groupType": "TENANT",
            "tenantId": "5",
            "tenantName": "CloudCenter SE",
            "cloudName": "Google-us-central1",
            "cloudFamily": "Google",
            "cloudCost": 234.5,
            "nodeHours": 3350.596,
            "numberOfRunningVMs": 5
        }]
    }, {
        "groupName": "CloudCenter POC",
        "groupType": "TENANT",
        "tenantId": "11",
        "cloudFamily": null,
        "totalCloudCost": 584.24,
        "totalNodeHours": 11400.469,
        "totalNumberOfRunningVMs": 3,
        "details": [{
            "groupName": "CloudCenter POC",
            "groupType": "TENANT",
            "tenantId": "11",
            "tenantName": "CloudCenter POC",
            "cloudName": "Amazon-ap-northeast-1",
            "cloudFamily": "Amazon",
            "cloudCost": 122.61,
            "nodeHours": 2011.3795,
            "numberOfRunningVMs": 0
        }, {
            "groupName": "CloudCenter POC",
            "groupType": "TENANT",
            "tenantId": "11",
            "tenantName": "CloudCenter POC ",
            "cloudName ": "Amazon - us - east - 1 ",
            "cloudFamily ": "Amazon ",
            "cloudCost ": 236.50998,
            "nodeHours ": 5365.644,
            "numberOfRunningVMs": 2
        }, {
            "groupName": "CloudCenter POC",
            "groupType": "TENANT",
            "tenantId": "11",
            "tenantName": "CloudCenter POC ",
            "cloudName ": "Amazon - us - west - 2 ",
            "cloudFamily ": "Amazon ",
            "cloudCost ": 225.12,
            "nodeHours ": 4023.4453,
            "numberOfRunningVMs": 1
        }, {
            "groupName": "CloudCenter POC",
            "groupType": "TENANT",
            "tenantId": "11",
            "tenantName": "CloudCenter POC",
            "cloudName ": "Azure - us - east ",
            "cloudFamily ": "Azure ",
            "cloudCost ": "0.0",
            "nodeHours ": "0.0",
            "numberOfRunningVMs ": 0
        }, {
            "groupName": "CloudCenter POC",
            "groupType": "TENANT",
            "tenantId": "11",
            "tenantName": "CloudCenter POC",
            "cloudName": "SamsungAzure-us-east",
            "cloudFamily": "Azure",
            "cloudCost": 0.0,
            "nodeHours": 0.0,
            "numberOfRunningVMs": 0
        }]
    }, {
        "groupName": "netonejp",
        "groupType": "TENANT",
        "tenantId": "15",
        "cloudFamily": null,
        "totalCloudCost": 351.12,
        "totalNodeHours": 9388.549,
        "totalNumberOfRunningVMs": 13,
        "details": [{
            "groupName": "netonejp",
            "groupType": "TENANT",
            "tenantId": "15",
            "tenantName": "netonejp",
            "cloudName": "Amazon-ap-northeast-1",
            "cloudFamily": "Amazon",
            "cloudCost": 351.12,
            "nodeHours": 9388.549,
            "numberOfRunningVMs": 13
        }]
    }, {
        "groupName": "CloudCenter Team",
        "groupType": "TENANT",
        "tenantId": "28",
        "cloudFamily": null,
        "totalCloudCost": 12102.211,
        "totalNodeHours": 101234.84,
        "totalNumberOfRunningVMs": 107,
        "details": [{
            "groupName": "CloudCenter Team",
            "groupType": "TENANT",
            "tenantId": "28",
            "tenantName": "CloudCenter Team",
            "cloudName": "Amazon-ap-northeast-1",
            "cloudFamily": "Amazon",
            "cloudCost": 235.84,
            "nodeHours": 2011.8734,
            "numberOfRunningVMs": 3
        }, {
            "groupName": "CloudCenter Team",
            "groupType": "TENANT",
            "tenantId": "28",
            "tenantName": "CloudCenter Team",
            "cloudName": "Amazon-eu-west-1",
            "cloudFamily": "Amazon",
            "cloudCost": 0.0,
            "nodeHours": 0.0,
            "numberOfRunningVMs": 0
        }, {
            "groupName": "CloudCenter Team",
            "groupType": "TENANT",
            "tenantId": "28",
            "tenantName": "CloudCenter Team",
            "cloudName": "Amazon-us-east-1",
            "cloudFamily": "Amazon",
            "cloudCost": 2494.137,
            "nodeHours": 30168.436,
            "numberOfRunningVMs": 25
        }, {
            "groupName": "CloudCenter Team",
            "groupType": "TENANT",
            "tenantId": "28",
            "tenantName": "CloudCenter Team",
            "cloudName": "Amazon-us-west-1",
            "cloudFamily": "Amazon",
            "cloudCost": 99.83,
            "nodeHours": 1341.2897,
            "numberOfRunningVMs": 2
        }, {
            "groupName": "CloudCenter Team",
            "groupType": "TENANT",
            "tenantId": "28",
            "tenantName": "CloudCenter Team",
            "cloudName": "Amazon-us-west-2",
            "cloudFamily": "Amazon",
            "cloudCost": 2111.915,
            "nodeHours": 24805.66,
            "numberOfRunningVMs": 27
        }, {
            "groupName": "CloudCenter Team",
            "groupType": "TENANT",
            "tenantId": "28",
            "tenantName": "CloudCenter Team",
            "cloudName": "Azure-us-east",
            "cloudFamily": "Azure",
            "cloudCost": 831.19995,
            "nodeHours": 6033.2686,
            "numberOfRunningVMs": 8
        }, {
            "groupName": "CloudCenter Team",
            "groupType": "TENANT",
            "tenantId": "28",
            "tenantName": "CloudCenter Team",
            "cloudName": "Google-us-central1",
            "cloudFamily": "Google",
            "cloudCost": 1876.0001,
            "nodeHours": 14077.835,
            "numberOfRunningVMs": 20
        }, {
            "groupName": "CloudCenter Team",
            "groupType": "TENANT",
            "tenantId": "28",
            "tenantName": "CloudCenter Team",
            "cloudName": "HPCloud-region-a-geo-1",
            "cloudFamily": "HpCloud",
            "cloudCost": 0.0,
            "nodeHours": 0.0,
            "numberOfRunningVMs": 0
        }, {
            "groupName": "CloudCenter Team",
            "groupType": "TENANT",
            "tenantId": "28",
            "tenantName": "CloudCenter Team",
            "cloudName": "HPCloud-region-b-geo-1",
            "cloudFamily": "HpCloud",
            "cloudCost": 140.91,
            "nodeHours": 2010.333,
            "numberOfRunningVMs": 3
        }, {
            "groupName": "CloudCenter Team",
            "groupType": "TENANT",
            "tenantId": "28",
            "tenantName": "CloudCenter Team",
            "cloudName": "Openstack-regionOne",
            "cloudFamily": "Openstack",
            "cloudCost": 0.0,
            "nodeHours": 0.0,
            "numberOfRunningVMs": 0
        }, {
            "groupName": "CloudCenter Team",
            "groupType": "TENANT",
            "tenantId": "28",
            "tenantName": "CloudCenter Team",
            "cloudName": "SoftLayer-dal09",
            "cloudFamily": "SoftLayer",
            "cloudCost": 1029.278,
            "nodeHours": 10058.06,
            "numberOfRunningVMs": 14
        }, {
            "groupName": "CloudCenter Team",
            "groupType": "TENANT",
            "tenantId": "28",
            "tenantName": "CloudCenter Team",
            "cloudName": "VMWare-CliQr-Private-Cloud",
            "cloudFamily": "Vmware",
            "cloudCost": 3283.1,
            "nodeHours": 10728.084,
            "numberOfRunningVMs": 5
        }]
    }, {
        "groupName": "Service Provider POC",
        "groupType": "TENANT",
        "tenantId": "32",
        "cloudFamily": null,
        "totalCloudCost": 268.67,
        "totalNodeHours": 5363.5015,
        "totalNumberOfRunningVMs": 5,
        "details": [{
            "groupName": "Service Provider POC ",
            "groupType ": "TENANT ",
            "tenantId ": "32 ",
            "tenantName ": "Service Provider POC ",
            "cloudName ": "Amazon - us - east - 1 ",
            "cloudFamily": "Amazon",
            "cloudCost": 198.32,
            "nodeHours": 4692.997,
            "numberOfRunningVMs": 5
        }, {
            "groupName": "Service Provider POC",
            "groupType": "TENANT",
            "tenantId": "32",
            "tenantName": "Service Provider POC",
            "cloudName": "Amazon-us-west-2",
            "cloudFamily": "Amazon",
            "cloudCost": 70.35,
            "nodeHours": 670.50433,
            "numberOfRunningVMs": 0
        }]
    }]
}

Example 2 – All Clouds by Cloud Region

curl -k -X GET -H "Accept: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v2/tenants/1/reports?reportType=USAGE_SUMMARY_REPORT&startDate=1464764400000&endDate=1469948400000&groupBy=CLOUD"

Response

{
    "summary": {
        "numberOfTenants": 8,
        "numberOfClouds": 11,
        "totalCloudCost": 14526.461,
        "totalNodeHours": 144162.11,
        "totalNumberOfRunningVMs": 150
    },
    "spendDetailsByGroups": [{
        "groupName": "Amazon-ap-northeast-1",
        "groupType": "CLOUD",
        "tenantId": null,
        "cloudFamily": "Amazon",
        "totalCloudCost": 709.56995,
        "totalNodeHours": 13411.803,
        "totalNumberOfRunningVMs": 16,
        "details": [{
            "groupName": "Amazon-ap-northeast-1",
            "groupType": "CLOUD",
            "tenantId": "11",
            "tenantName": "CloudCenter POC",
            "cloudName": "Amazon-ap-northeast-1",
            "cloudFamily": "Amazon",
            "cloudCost": 122.61,
            "nodeHours": 2011.3795,
            "numberOfRunningVMs": 0
        }, {
            "groupName": "Amazon-ap-northeast-1",
            "groupType": "CLOUD",
            "tenantId": "15",
            "tenantName": "netonejp",
            "cloudName": "Amazon-ap-northeast-1",
            "cloudFamily": "Amazon",
            "cloudCost": 351.12,
            "nodeHours": 9388.549,
            "numberOfRunningVMs": 13
        }, {
            "groupName": "Amazon-ap-northeast-1",
            "groupType": "CLOUD",
            "tenantId": "28",
            "tenantName": "CloudCenter Team",
            "cloudName": "Amazon-ap-northeast-1",
            "cloudFamily": "Amazon",
            "cloudCost": 235.84,
            "nodeHours": 2011.8735,
            "numberOfRunningVMs": 3
        }]
    }, {
        "groupName": "Amazon-eu-west-1",
        "groupType": "CLOUD",
        "tenantId": null,
        "cloudFamily": "Amazon",
        "totalCloudCost": 0.0,
        "totalNodeHours": 0.0,
        "totalNumberOfRunningVMs": 0,
        "details": [{
            "groupName": "Amazon-eu-west-1",
            "groupType": "CLOUD",
            "tenantId": "28",
            "tenantName": "CloudCenter Team",
            "cloudName": "Amazon-eu-west-1",
            "cloudFamily": "Amazon",
            "cloudCost": 0.0,
            "nodeHours": 0.0,
            "numberOfRunningVMs": 0
        }]
    }, {
        "groupName": "Amazon-us-east-1",
        "groupType": "CLOUD",
        "tenantId": null,
        "cloudFamily": "Amazon",
        "totalCloudCost": 3098.117,
        "totalNodeHours": 41572.668,
        "totalNumberOfRunningVMs": 32,
        "details": [{
            "groupName": "Amazon-us-east-1",
            "groupType": "CLOUD",
            "tenantId": "5",
            "tenantName": "CloudCenter SE ",
            "cloudName ": "Amazon - us - east - 1 ",
            "cloudFamily ": "Amazon ",
            "cloudCost ": 168.84,
            "nodeHours ": 1341.5889,
            "numberOfRunningVMs ": 0
        }, {
            "groupName": "Amazon-us-east-1",
            "groupType": "CLOUD",
            "tenantId": "11",
            "tenantName": "CloudCenter POC",
            "cloudName": "Amazon-us-east-1",
            "cloudFamily": "Amazon",
            "cloudCost": 236.52998,
            "nodeHours": 5366.6465,
            "numberOfRunningVMs": 2
        }, {
            "groupName": "Amazon-us-east-1",
            "groupType": "CLOUD",
            "tenantId": "28",
            "tenantName": "CloudCenter Team",
            "cloudName": "Amazon-us-east-1",
            "cloudFamily": "Amazon",
            "cloudCost": 2494.4268,
            "nodeHours": 30171.438,
            "numberOfRunningVMs": 25
        }, {
            "groupName": "Amazon-us-east-1",
            "groupType": "CLOUD",
            "tenantId": "32",
            "tenantName": "Service Provider POC ",
            "cloudName ": "Amazon - us - east - 1 ",
            "cloudFamily ": "Amazon ",
            "cloudCost ": 198.32,
            "nodeHours ": 4692.997,
            "numberOfRunningVMs ": 5
        }]
    }, {
        "groupName": "Amazon-us-west-1",
        "groupType": "CLOUD",
        "tenantId": null,
        "cloudFamily": "Amazon",
        "totalCloudCost": 99.83,
        "totalNodeHours": 1341.2897,
        "totalNumberOfRunningVMs": 2,
        "details": [{
            "groupName": "Amazon-us-west-1",
            "groupType": "CLOUD",
            "tenantId": "28",
            "tenantName": "CloudCenter Team",
            "cloudName": "Amazon-us-west-1",
            "cloudFamily": "Amazon",
            "cloudCost": 99.83,
            "nodeHours": 1341.2897,
            "numberOfRunningVMs": 2
        }]
    }, {
        "groupName": "Amazon-us-west-2",
        "groupType": "CLOUD",
        "tenantId": null,
        "cloudFamily": "Amazon",
        "totalCloudCost": 3223.4456,
        "totalNodeHours": 41572.176,
        "totalNumberOfRunningVMs": 45,
        "details": [{
            "groupName": "Amazon-us-west-2",
            "groupType": "CLOUD",
            "tenantId": "1",
            "tenantName": "CloudCenter Technologies Inc",
            "cloudName": "Amazon-us-west-2",
            "cloudFamily": "Amazon",
            "cloudCost": 281.4,
            "nodeHours": 2682.888,
            "numberOfRunningVMs": 4
        }, {
            "groupName": "Amazon-us-west-2",
            "groupType": "CLOUD",
            "tenantId": "5",
            "tenantName": "CloudCenter SE",
            "cloudName": "Amazon-us-west-2",
            "cloudFamily": "Amazon",
            "cloudCost": 206.35999,
            "nodeHours": 4694.1357,
            "numberOfRunningVMs": 6
        }, {
            "groupName": "Amazon-us-west-2",
            "groupType": "CLOUD",
            "tenantId": "11",
            "tenantName": "CloudCenter POC",
            "cloudName": "Amazon-us-west-2",
            "cloudFamily": "Amazon",
            "cloudCost": 225.12,
            "nodeHours": 4023.445,
            "numberOfRunningVMs": 1
        }, {
            "groupName": "Amazon-us-west-2",
            "groupType": "CLOUD",
            "tenantId": "28",
            "tenantName": "CloudCenter Team",
            "cloudName": "Amazon-us-west-2",
            "cloudFamily": "Amazon",
            "cloudCost": 2111.9153,
            "nodeHours": 24805.664,
            "numberOfRunningVMs": 27
        }, {
            "groupName": "Amazon-us-west-2",
            "groupType": "CLOUD",
            "tenantId": "32",
            "tenantName": "Service Provider POC",
            "cloudName": "Amazon-us-west-2",
            "cloudFamily": "Amazon",
            "cloudCost": 70.35,
            "nodeHours": 670.50433,
            "numberOfRunningVMs": 0
        }]
    }, {
        "groupName": "Azure-us-east",
        "groupType": "CLOUD",
        "tenantId": null,
        "cloudFamily": "Azure",
        "totalCloudCost": 831.36005,
        "totalNodeHours": 6034.2695,
        "totalNumberOfRunningVMs": 8,
        "details": [{
            "groupName": "Azure-us-east",
            "groupType": "CLOUD",
            "tenantId": "1",
            "tenantName": "CloudCenter Technologies Inc",
            "cloudName": "Azure-us-east",
            "cloudFamily": "Azure",
            "cloudCost": 0.0,
            "nodeHours": 0.0,
            "numberOfRunningVMs": 0
        }, {
            "groupName": "Azure-us-east",
            "groupType": "CLOUD",
            "tenantId": "5",
            "tenantName": "CloudCenter SE",
            "cloudName": "Azure-us-east",
            "cloudFamily": "Azure",
            "cloudCost": 0.0,
            "nodeHours": 0.0,
            "numberOfRunningVMs": 0
        }, {
            "groupName": "Azure-us-east",
            "groupType": "CLOUD",
            "tenantId": "11",
            "tenantName": "CloudCenter POC",
            "cloudName": "Azure-us-east",
            "cloudFamily": "Azure",
            "cloudCost": 0.0,
            "nodeHours": 0.0,
            "numberOfRunningVMs": 0
        }, {
            "groupName": "Azure-us-east",
            "groupType": "CLOUD",
            "tenantId": "28",
            "tenantName": "CloudCenter Team",
            "cloudName": "Azure-us-east",
            "cloudFamily": "Azure",
            "cloudCost": 831.36005,
            "nodeHours": 6034.2695,
            "numberOfRunningVMs": 8
        }]
    }, {
        "groupName": "Google-us-central1",
        "groupType": "CLOUD",
        "tenantId": null,
        "cloudFamily": "Google",
        "totalCloudCost": 2110.8499,
        "totalNodeHours": 17433.438,
        "totalNumberOfRunningVMs": 25,
        "details": [{
            "groupName": "Google-us-central1",
            "groupType": "CLOUD",
            "tenantId": "5",
            "tenantName": "CloudCenter SE ",
            "cloudName ": "Google - us - central1 ",
            "cloudFamily ": "Google ",
            "cloudCost ": 234.85,
            "nodeHours ": 3355.6042,
            "numberOfRunningVMs": 5
        }, {
            "groupName": "Google-us-central1",
            "groupType": "CLOUD",
            "tenantId": "28",
            "tenantName": "CloudCenter Team",
            "cloudName": "Google-us-central1",
            "cloudFamily": "Google",
            "cloudCost": 1875.9999,
            "nodeHours": 14077.834,
            "numberOfRunningVMs": 20
        }]
    }, {
        "groupName": "HPCloud-region-a-geo-1",
        "groupType": "CLOUD",
        "tenantId": null,
        "cloudFamily": "HpCloud",
        "totalCloudCost": 0.0,
        "totalNodeHours": 0.0,
        "totalNumberOfRunningVMs": 0,
        "details": [{
            "groupName": "HPCloud-region-a-geo-1",
            "groupType": "CLOUD",
            "tenantId": "28",
            "tenantName": "CloudCenter Team",
            "cloudName": "HPCloud-region-a-geo-1",
            "cloudFamily": "HpCloud",
            "cloudCost": 0.0,
            "nodeHours": 0.0,
            "numberOfRunningVMs": 0
        }]
    }, {
        "groupName": "HPCloud-region-b-geo-1",
        "groupType": "CLOUD",
        "tenantId": null,
        "cloudFamily": "HpCloud",
        "totalCloudCost": 140.91,
        "totalNodeHours": 2010.333,
        "totalNumberOfRunningVMs": 3,
        "details": [{
            "groupName": "HPCloud-region-b-geo-1",
            "groupType": "CLOUD",
            "tenantId": "28",
            "tenantName": "CloudCenter Team",
            "cloudName": "HPCloud-region-b-geo-1",
            "cloudFamily": "HpCloud",
            "cloudCost": 140.91,
            "nodeHours": 2010.333,
            "numberOfRunningVMs": 3
        }]
    }, {
        "groupName": "Openstack-regionOne",
        "groupType": "CLOUD",
        "tenantId": null,
        "cloudFamily": "Openstack",
        "totalCloudCost": 0.0,
        "totalNodeHours": 0.0,
        "totalNumberOfRunningVMs": 0,
        "details": [{
            "groupName": "Openstack-regionOne",
            "groupType": "CLOUD",
            "tenantId": "28",
            "tenantName": "CloudCenter Team",
            "cloudName": "Openstack-regionOne",
            "cloudFamily": "Openstack",
            "cloudCost": 0.0,
            "nodeHours": 0.0,
            "numberOfRunningVMs": 0
        }]
    }, {
        "groupName": "SamAzure-us-east",
        "groupType": "CLOUD",
        "tenantId": null,
        "cloudFamily": "Azure",
        "totalCloudCost": 0.0,
        "totalNodeHours": 0.0,
        "totalNumberOfRunningVMs": 0,
        "details": [{
            "groupName": "SamAzure-us-east",
            "groupType": "CLOUD",
            "tenantId": "11",
            "tenantName": "CloudCenter POC ",
            "cloudName ": "SamAzure - us - east ",
            "cloudFamily ": "Azure ",
            "cloudCost ": 0.0,
            "nodeHours ": 0.0,
            "numberOfRunningVMs ": 0
        }]
    }, {
        "groupName": "SoftLayer-dal09",
        "groupType": "CLOUD",
        "tenantId": null,
        "cloudFamily": "SoftLayer",
        "totalCloudCost": 1029.278,
        "totalNodeHours": 10058.059,
        "totalNumberOfRunningVMs": 14,
        "details": [{
            "groupName": "SoftLayer-dal09",
            "groupType": "CLOUD",
            "tenantId": "28",
            "tenantName": "CloudCenter Team",
            "cloudName": "SoftLayer-dal09",
            "cloudFamily": "SoftLayer",
            "cloudCost": 1029.278,
            "nodeHours": 10058.059,
            "numberOfRunningVMs": 14
        }]
    }, {
        "groupName": "VMWare-CliQr-Private-Cloud",
        "groupType": "CLOUD",
        "tenantId": null,
        "cloudFamily": "Vmware",
        "totalCloudCost": 3283.1,
        "totalNodeHours": 10728.084,
        "totalNumberOfRunningVMs": 5,
        "details": [{
            "groupName": "VMWare-CliQr-Private-Cloud",
            "groupType": "CLOUD",
            "tenantId": "28",
            "tenantName": "CloudCenter Team",
            "cloudName": "VMWare-CliQr-Private-Cloud",
            "cloudFamily": "Vmware",
            "cloudCost": 3283.1,
            "nodeHours": 10728.084,
            "numberOfRunningVMs": 5
        }]
    }]
}

Request Attributes

reportType=USAGE_SUMMARY_REPORT&startDate=startDate&endDate=endDate&groupBy=TENANT

tenantId
  • DescriptionUnique, system-generated identifier for the tenant organization. A tenant admin must belong to this tenant to invoke any APIs for this tenant. See Add Sub-Tenants > Tenant ID and Tenant Name Dependency.

  • Type: String

Required

reportType

Required

 

startDate

Optional query parameter

 

endDate

Optional query parameter

groupBy
  • Description: The aggregate number of resources when grouped by tenant or cloud region 
  • Type: Enumeration

    EnumerationDescription
    TENANTBy cloud region for every sub-tenant
    CLOUDBy sub-tenant for every cloud region

Optional query parameter

Response Attributes

tenantId
  • DescriptionUnique, system-generated identifier for the tenant organization. A tenant admin must belong to this tenant to invoke any APIs for this tenant. See Add Sub-Tenants > Tenant ID and Tenant Name Dependency.

  • Type: String

See pageResource or Pagination for additional context

userId
  • Description: Unique, system-generated identifier for a user
  • Type: String

startTime

endDate

summary
  • Description: Identifies the total managed VM inventory information for your cloud region or cloud account:
  • Type: Sequence of groups

    tenantId
    • DescriptionUnique, system-generated identifier for the tenant organization. A tenant admin must belong to this tenant to invoke any APIs for this tenant. See Add Sub-Tenants > Tenant ID and Tenant Name Dependency.

    • Type: String
     totalCloudCost 
     totalNodeHours  
    • Type: Float
     totalNumberOfRunningVMs   
    • Type: Integer
    totalNumberOfVMs
spendDetailsByGroups
  • Description: Identifies the usage summary information for your tenant (default) or cloud region by group:
  • Type: Sequence of groups

    groupName
    • Description: Identifies the name for this aggregation of resources that is grouped by tenant or cloud region 
    • Type: String

    groupType
    • Description: Identifies if this aggregation of resources is grouped by tenant or cloud region 
    • Type: Enumeration

      EnumerationDescription
      TENANTBy cloud region for every sub-tenant
      CLOUDBy sub-tenant for every cloud region
    tenantId
    • DescriptionUnique, system-generated identifier for the tenant organization. A tenant admin must belong to this tenant to invoke any APIs for this tenant. See Add Sub-Tenants > Tenant ID and Tenant Name Dependency.

    • Type: String
    cloudFamily                                                                                                                                                                                
    • Description: The cloud provider name.                     
    • Type: String
     totalCloudCost 
     totalNodeHours  
    • Type: Float
     totalNumberOfRunningVMs   
    • Type: Integer
    details (click for additional details)