[{"label":"Latest (v1)","version":"latest"}]
cloud-partner-navigator

Get Reports

Description

Get all reports for a given metering agent.

Request

Request

URL

URL


get
https://{api_host}/api/v1/reports/{year}/{month}/{agentId}
Copy

Path Parameters

Path Parameters

string
year Required

the year for which the reports are requested


string
month Required

the month for which the reports are requested, 1 to 12 for JAN to DEC


string
agentId Required

the unique identifier of the agent


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response 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, must be used as accept header when downloading the report


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 or virtual machine history report, etc.

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl https://{api_host}/api/v1/reports/{year}/{month}/{agentId}


[{"label":"Latest (v1)","version":"latest"}]
cloud-partner-navigator
Feedback

Was this page helpful?