// removed jquery ui css and js

View Resource Summary Report

Details

API Details
NameView Resource Summary Report
Description

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

MethodGET
URI

v2/tenants/tenantId/reports?reportType=reportType&includeSubTenantSummary=boolean&mySummary=boolean&startDate=start_date&endDate=end_date&limit=limit

CloudCenter Release
  • Introduced 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:
    • Call this API by issuing either the mySummary attribute or the includeSubTenantSummary attributes as false. Both attributes cannot both be true in the same API call. 
    • Default response:
      • First four resource details (can be changed using the limit attribute)
      • By cloud

      • All tenants (mySummary or mySummaryOnly=false or includeSubTenantSummary=true)

        The mySummaryOnly attribute is available as a:

        • Response parameter in CloudCenter 4.8.0 and later releases.

        • Query parameter in CloudCenter 4.8.1 and later releases.

    • This API does not support sorting.

    • This API supports the CSV format for the response. See Response Schema > CSV (Only for Reports).
ESB Headeraction: get.tenants.tenantId.reports
actionparam: reportType=report_type&includeSubTenantSummary=boolean&mySummary=boolean&startDate=start_date&endDate=end_date&limit=limit

Example 1  – All Tenants include Cloud and Application Details (CloudCenter 4.8.0x)

curl -k -X GET -H "Accept: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v2/tenants/1/reports?reportType=RESOURCE_SUMMARY_REPORT&includeSubTenantSummary=true&mySummary=false"

Response

{
    "tenantId": "1",
    "userId": "2",
    "startTime": 1467140106230,
    "endDate": 1469732106230,
    "includeSubTenantSummary": false,
    "mySummaryOnly": false,
    "cloudFamilySummary": {
        "resourceType": "CLOUD_FAMILY",
        "cost": {
            "total": 14438.933,
            "details": [{
                "total": 7088.0884,
                "name": "Amazon"
            }, {
                "total": 3263.4998,
                "name": "Vmware"
            }, {
                "total": 2097.9,
                "name": "Google"
            }, {
                "total": 1023.13403,
                "name": "SoftLayer"
            }]
        },
        "nodeHours": {
            "total": 143294.9,
            "details": [{
                "total": 97311.81,
                "name": "Amazon"
            }, {
                "total": 17324.762,
                "name": "Google"
            }, {
                "total": 10664.293,
                "name": "Vmware"
            }, {
                "total": 9998.26,
                "name": "SoftLayer"
            }]
        },
        "runningVMs": {
            "total": 150,
            "details": [{
                "total": 95,
                "name": "Amazon"
            }, {
                "total": 25,
                "name": "Google"
            }, {
                "total": 14,
                "name": "SoftLayer"
            }, {
                "total": 8,
                "name": "Azure"
            }]
        }
    },
    "cloudRegionSummary": {
        "resourceType": "CLOUD_TYPE",
        "cost": {
            "total": 14438.933,
            "details": [{
                "total": 3263.4998,
                "name": "VMWare-CliQr-Private-Cloud"
            }, {
                "total": 3204.201,
                "name": "Amazon-us-west-2"
            }, {
                "total": 3079.3188,
                "name": "Amazon-us-east-1"
            }, {
                "total": 2097.9,
                "name": "Google-us-central1"
            }]
        },
        "nodeHours": {
            "total": 143294.9,
            "details": [{
                "total": 41324.96,
                "name": "Amazon-us-west-2"
            }, {
                "total": 41321.484,
                "name": "Amazon-us-east-1"
            }, {
                "total": 17324.762,
                "name": "Google-us-central1"
            }, {
                "total": 13332.072,
                "name": "Amazon-ap-northeast-1"
            }]
        },
        "runningVMs": {
            "total": 150,
            "details": [{
                "total": 45,
                "name": "Amazon-us-west-2"
            }, {
                "total": 32,
                "name": "Amazon-us-east-1"
            }, {
                "total": 25,
                "name": "Google-us-central1"
            }, {
                "total": 16,
                "name": "Amazon-ap-northeast-1"
            }]
        }
    },
    "applicationSummary": {
        "resourceType": null,
        "cost": {
            "total": 0,
            "details": []
        },
        "nodeHours": {
            "total": 0,
            "details": []
        },
        "runningVMs": {
            "total": 0,
            "details": []
        }
    }
}

Example 2  – All Tenants include Cloud and Application Details (CloudCenter 4.8.1)

curl -k -X GET -H "Accept: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v2/tenants/28/reports?reportType=RESOURCE_SUMMARY_REPORT&includeSubTenantSummary=true&mySummaryOnly=false"

Response

{
   "tenantId":"28",
   "userId":"48",
   "startTime":1498290586905,
   "endDate":1500882586905,
   "includeSubTenantSummary":true,
   "mySummaryOnly":false,
   "cloudFamilySummary":{
      "resourceType":"CLOUD_FAMILY",
      "cost":{
         "total":59.240997,
         "details":[
            {
               "total":59.240997,
               "id":null,
               "name":"Amazon"
            }
         ]
      },
      "nodeHours":{
         "total":2558.2207,
         "details":[
            {
               "total":2558.2207,
               "id":null,
               "name":"Amazon"
            }
         ]
      },
      "runningVMs":{
         "total":4,
         "details":[
            {
               "total":4,
               "id":null,
               "name":"Amazon"
            }
         ]
      }
   },
   "cloudRegionSummary":{
      "resourceType":"CLOUD_TYPE",
      "cost":{
         "total":59.240997,
         "details":[
            {
               "total":59.240997,
               "id":null,
               "name":"Amazon-us-east-1"
            }
         ]
      },
      "nodeHours":{
         "total":2558.2207,
         "details":[
            {
               "total":2558.2207,
               "id":null,
               "name":"Amazon-us-east-1"
            }
         ]
      },
      "runningVMs":{
         "total":4,
         "details":[
            {
               "total":4,
               "id":null,
               "name":"Amazon-us-east-1"
            }
         ]
      }
   },
   "applicationSummary":null
}

Request 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

Required

reportType

Required

includeSubTenantSummary 
  • Description: Identifies if the summary must be included for each sub-tenant within this tenant.

    The mySummary and includeSubTenantSummary attributes cannot both be true in one call

  • Type: Boolean:
    • true = The sub-tenant summary is included.
    • false = Default. The sub-tenant summary is not included.

Optional query parameter

mySummary
  • Description: Identifies if the summary must be included for your tenant.

    The mySummary and includeSubTenantSummary attributes cannot both be true in one call.

    This attribute is the same as the mySummaryOnly attribute.

  • Type: Boolean:
    • true = The tenant summary is included for your tenant.
    • false = Default. The summary is not included for your tenant.

Optional query parameter in CloudCenter 4.8.0x

mySummaryOnly
  • Description: Identifies if the summary must be included for your tenant.

    The mySummaryOnly and includeSubTenantSummary attributes cannot both be true in one call.

    This attribute is the same as the mySummary attribute.

  • Type: Boolean:
    • true = The tenant summary is included for your tenant.
    • false = Default. The summary is not included for your tenant.

Optional query parameter in CloudCenter 4.8.1 and later

startDate

Optional query parameter

endDate

Optional query parameter

limit
  • Description: The number of resources for which the details are provided. Default = 4 resources. 
  • Type: Integer

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

includeSubTenantSummary 
  • Description: Identifies if the summary must be included for each sub-tenant within this tenant.

    The mySummary and includeSubTenantSummary attributes cannot both be true in one call

  • Type: Boolean:
    • true = The sub-tenant summary is included.
    • false = Default. The sub-tenant summary is not included.

mySummaryOnly
  • Description: Identifies if the summary must be included for your tenant.

    The mySummaryOnly and includeSubTenantSummary attributes cannot both be true in one call.

    This attribute is the same as the mySummary attribute.

  • Type: Boolean:
    • true = The tenant summary is included for your tenant.
    • false = Default. The summary is not included for your tenant.

cloudFamilySummary
  • Description: The resource usage breakdown for 4 (default) CloudCenter clouds.
  • Type: A sequence of resource details

    resourceType
    • Description: The data type for a CloudCenter Resource.

    • Type: String
      StringCategory
      CLOUD_FAMILYIdentifies this resource to be the cloud family
      CLOUD_TYPEIdentifies this resource to be the cloud region
      APP_NAMEIdentifies this resource to be the application
    cost
    • Description: The total cost of using the cloud for this tenant organization along with the breakdown details for each listed resource in the following format:
      • total: The individual cost of the resource identified in the name attribute below.
      • name: The name of the resource that contributes to the total cost.
    • Type: Float
    nodeHours
    • Description: The number of run time hours (see Financial Overview) for this tenant organization along with the breakdown details for each listed resource in the following format:
      • total: The individual run time hours of the resource identified in the name attribute below.
      • name: The name of the resource that contributes to the run time hours.
    • Type: Float
    runningVMs
    • Description: The number of VMs running concurrently at any point for this tenant organization along with the breakdown details for each listed resource in the following format:
      • total: The individual number of VMs for the resource identified in the name attribute below.
      • name: The name of the resource that contributes to the total number of VMs.
    • Type: Integer

cloudRegionSummary
  • Description: The resource usage breakdown for 4 (default) CloudCenter cloud regions.
  • Type: A sequence of resource details

    resourceType
    • Description: The data type for a CloudCenter Resource.

    • Type: String
      StringCategory
      CLOUD_FAMILYIdentifies this resource to be the cloud family
      CLOUD_TYPEIdentifies this resource to be the cloud region
      APP_NAMEIdentifies this resource to be the application
    cost
    • Description: The total cost of using the cloud for this tenant organization along with the breakdown details for each listed resource in the following format:
      • total: The individual cost of the resource identified in the name attribute below.
      • name: The name of the resource that contributes to the total cost.
    • Type: Float
    nodeHours
    • Description: The number of run time hours (see Financial Overview) for this tenant organization along with the breakdown details for each listed resource in the following format:
      • total: The individual run time hours of the resource identified in the name attribute below.
      • name: The name of the resource that contributes to the run time hours.
    • Type: Float
    runningVMs
    • Description: The number of VMs running concurrently at any point for this tenant organization along with the breakdown details for each listed resource in the following format:
      • total: The individual number of VMs for the resource identified in the name attribute below.
      • name: The name of the resource that contributes to the total number of VMs.
    • Type: Integer

typeSummary(applicationSummary) (click for additional details)

© 2017 Cisco Systems