[{"label":"Latest (v1)","version":"latest"}]
cloud-partner-navigator
Get Reports
DescriptionGet all reports for a specified Usage Meter agent.
Request
URLURL
https://console.navigator.vmware.com/usage/api/v1/reports/{year}/{month}/{agentId}
Path Parameters
Path Parameters
string
year
Required
The year of the requested reports.
string
month
Required
The month of the requested reports. The numbers from 1 to 12 match the months from JAN to DEC.
string
agentId
Required
The unique identifier of the Usage Meter agent.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
array of
Report
of type application/json
A list of all reports for the given agent for the given reporting period.
{
"checksum": "string",
"contentLength": 0,
"contentType": "string",
"ref": "string",
"reportType": "string"
}
string
checksum
Optional
Hex encoded 128-bit MD5 hash of the report.
integer as int64
contentLength
Optional
The length of the report in bytes.
string
contentType
Optional
The content type of the report. When downloading the report, use it as an accept header.
string
ref
Optional
Unique reference to the report. Opaque identifier of the report, should not be interpreted. The format can change for future reports, but old references should continue to work.
string
reportType
Optional
The type of the report. For example - Monthly Usage Report, Virtual Machine History report, etc.
No error details were provided in the OpenAPI specification.
Code SamplesCode Samples
cURL Command
curl https://console.navigator.vmware.com/usage/api/v1/reports/{year}/{month}/{agentId}
[{"label":"Latest (v1)","version":"latest"}]
cloud-partner-navigator
