Vault usage report
Generates the Vault Usage Report.
Request
Security
| Any | Super User | System Admin | Security Admin | Operator |
|---|---|---|---|---|
| superUser | systemAdmin (readOnly and read/write) |
HTTP method
GET /manager/api/{apiResponseType}/1.0/vaultUsageReport.adm HTTP/1.1 Host:{manager.dsnet}
dateRange={true|false}&startDate={M/D/Y}&endDate={M/D/Y}
Curl method
curl -u {admin}:{password} -k
”https://{manager.dsnet}/manager/api/{apiResponseType}/1.0/vaultUsageReport.adm“ -d
”dateRange={true|false}&startDate={M/D/Y}&endDate={M/D/Y}“
Parameters
| 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 date (MM/dd/yyyy). |
|
| endDate | date | dateRange=true |
Collect pool data end date (MM/dd/yyyy). |
|
| month | String | dateRange=false |
Month of data to gather. Example - Mar 2017. |
Response
Vault usage information per vault over a time period.
JSON response example
{
"responseStatus": "ok",
"responseHeader": {
"now": 1496166318818,
"status": "ok",
"requestId": null
},
"responseData": {
"vaultUsageReport": {
"dateRange": {
"startDate": "2017-03-01",
"endDate": "2017-04-01"
},
"vaults": [
{
"id": 5,
"uuid": "5d9c9256-d1be-7c68-0005-2333abfe2b80",
"name": "dsmgmt-s1",
"storagePool": "s1",
"usage": 1382190567,
"provisioningCode": "N/A",
"isDeleted": false,
"usageReportingStart": "Thu, 09 Mar 2017 21:44:00 -0600",
"usageReportingEnd": "Sat, 01 Apr 2017 00:00:00 -0500"
},
{
"id": 6,
"uuid": "dd4a92ca-375a-766b-11c2-48c7846baa80",
"name": "sv0",
"storagePool": "s1",
"usage": 0,
"provisioningCode": "N/A",
"isDeleted": false,
"usageReportingStart": "Tue, 14 Mar 2017 20:46:01 -0500",
"usageReportingEnd": "Sat, 01 Apr 2017 00:00:00 -0500"
},
{
"id": 4,
"uuid": "5afa7182-1c6a-75e2-11e6-aea821198880",
"name": "v1",
"storagePool": "s1",
"usage": 78114473290,
"provisioningCode": "N/A",
"isDeleted": false,
"usageReportingStart": "Thu, 09 Mar 2017 21:44:00 -0600",
"usageReportingEnd": "Sat, 01 Apr 2017 00:00:00 -0500"
},
{
"id": 2,
"uuid": "70f00b4d-cdb8-7917-11d5-c636f01ba180",
"name": "dsmgmt-s1",
"storagePool": "s1",
"usage": 770319,
"provisioningCode": "N/A",
"isDeleted": true,
"usageReportingStart": "Thu, 09 Mar 2017 21:14:13 -0600",
"usageReportingEnd": "Thu, 09 Mar 2017 21:43:23 -0600"
},
{
"id": 3,
"uuid": "6e19184a-10a8-752f-1128-c96130e49180",
"name": "v1",
"storagePool": "s1",
"usage": 418691104,
"provisioningCode": "N/A",
"isDeleted": true,
"usageReportingStart": "Thu, 09 Mar 2017 21:15:02 -0600",
"usageReportingEnd": "Thu, 09 Mar 2017 21:42:41 -0600"
}
]
}
}
}
Parameters
| Parameter | Type | Description |
|---|---|---|
| vaultUsageReport | object | |
| dateRange | object | An object with the following 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 this report is using to gather data, in the format yyyy-MM-dd. End date is exclusive. |
| vaults | array | Vaults available in the system, which is sorted by name, and grouped by isDeleted. |
| id | Long | ID that is assigned to the Vault. |
| uuid | String | Universally Unique Identifier for Vault across the system. |
| name | String | Name that is assigned to the vault. |
| storagePool | String | Storage pool for the vault. |
| usage | String | Number of bytes written to vault in addition to the units. |
| provisioningCode | String |
The manager generated ID for a deployed Container Vault. Parameter is included only for a system with service vault present. |
| isDeleted | String | Parameter is included only when the gathered data for the date range contains deleted vaults. |
| usageReportingStart | Date | In the user selected date range, Start date from when the usage data is reported for the vault. |
| usageReportingEnd | Date | In the user selected date range, End date from when the usage data is reported for the vault. |