Organization pool usage report

Generates the Organization Pool Usage Report.

Request

Security

Table 1. Roles capable of executing the Organization Pool Usage Report API method
Any	Super User	System Admin	Security Admin	Operator
	superUser	systemAdmin (readOnly and read/write)

HTTP method

Edit online

GET /manager/api/{apiResponseType}/1.0/organizationPoolUsageReport.adm HTTP/1.1 Host:{manager.dsnet} dateRange={true|false}&startDate={M/D/Y}&endDate={M/D/Y}

Curl method

Edit online

curl -u {admin}:{password} -k ”https://{manager.dsnet}/manager/api/{apiResponseType}/1.0/organizationPoolUsageReport.adm“ -d ”dateRange={true|false}&startDate={M/D/Y}&endDate={M/D/Y}“

Parameters

Edit online

Table 2. Request parameters for Organization Pool Usage Report (organizationPoolUsageReport) API method
Parameter	Type	Usage	Default	Description
dateRange	Boolean	Optional	false	Must be true if a date range is given.
startDate	date	dateRange=true		Collect pool data start this date (MM/dd/yyyy).
endDate	date	dateRange=true		Collect pool data end this date (MM/dd/yyyy).
scheduleMonthly	String	dateRange=false		Month of data to gather.

Response

Edit online

Storage pool usage information for an organization over a time period.

JSON response example

Edit online

{
  ”responseStatus“:”ok“,
  ”responseHeader“:{
    ”status“:”ok“,
    ”now“:{milliseconds from the UNIX epoch},
    ”requestId“:”U2qeIsCoDicAACV9Ad8AAACH“
  },
  ”responseData“:{
    ”poolUsageReport“:{
      ”organizations“:[
        {
          ”storagePools“:[
            {
              ”usage“:”1396494237471906 bytes days“,
              ”name“:”DigitalMappingArchive“
            },
            ...
            {
              ”usage“:”365424747752169 bytes days“,
              ”name“:”VMs“
            }
          ],
          ”organization“:”My Organization“,
          ”totalUsage“:”25652308887670548 bytes days“
        }
      ],
      ”dateRange“:{
        ”startDate“:”2014-01-01“,
        ”endDate“:”2014-03-05“
      }
    }
  }
}

Parameters

Edit online

Table 3. Response parameters for Organization Pool Usage Report (organizationPoolUsageReport) API method
Parameter	Type	Description
poolUsageReport	object
organizations	array	Organizations in the system.
organization	String	Name of organization object.
totalUsage	String	Number of bytes written by organization as a whole in addition to units.
storagePools	array	Storage pools available to given organization.
usage	String	Number of bytes written to pool in addition to the units.
name	String	Name that is assigned to the storage unit.
dateRange	object	An object with two parameters, startDate and endDate.
startDate	date	Start date this report is using to gather data, in the format yyyy-MM-dd.
endDate	date	End date that this report is using to gather data, in the format yyyy-MM-dd.