Get Usage Data

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://umip/api/v1/usage-data/{year-month}
COPY
Path Parameters
string
year-month
Required

The reporting period (yyyy-mm) to download the usage data for

Authentication
This operation uses the following authentication methods.
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

Provided access token is missing or invalid.

Operation doesn't return any data structure

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


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/v1/usage-data/{year-month}
On This Page
Usage Operations
GET
Get Usage Data List
GET
Get Usage Data