Get Usage Data
Downloads usage data in an opaque binary format suitable only for subsequent upload to VMware. Most customers will have no need to use this API.
Request
URI
GET
https://{api_host}/usage-data/{year-month}
COPY
Path Parameters
string
year-month
Required
The reporting period (yyyy-mm) to download the usage data for
Header Parameters
string
sessionid
Required
The authentication token obtained from login API response
Responses
200
OK
Returns file of type(s) application/octet-stream
"<opaque binary data in a proprietary format>"Response Headers
string
Content-Disposition
Specifies that the content is an attachment, that is downloaded
401
Returns 401Unauthorized_sessionID of type(s) application/json
{
"errCode": "GW_LOGIN_REQUIRED",
"errMessage": "Your session not found or already expired. Please login"
}string
errCode
Optional
errCode
string
errMessage
Optional
errMessage
404
Invalid reporting period specified.
Returns Error of type(s) application/json
{
"errCode": "TBD",
"errMessage": "Usage metering data not found for the specified period"
}string
errCode
Optional
errCode
string
errMessage
Optional
errMessage