With this update the Cloudability Utilization Report end point is available on the v3 API. This is the second of six endpoints being launched on Cloudability’s latest-gen public API this month.
This endpoint can be used to dynamically run utilization reports to determine patterns for EC2 instance usage programmatically and as part of an automated process. Utilization Analytics provides resource level details such as Average CPU utilization and Disk I/O. It is ideal for visualizing overall elasticity and whether the EC2 instances require rightsizing or need to be turned off. Flexible filtering, sorting, and measure (dimensions and metrics) selection is available to craft results to meet specific reporting needs. Availability on the v3 API brings benefits including being backed by a high-performance cloud app, a fully RESTful interface with predictable resource-orientated URLs and well-factored payloads, and comprehensive user documentation.
The cost metrics available in utilization analytics – Cost (Estimated On-demand) and Avg Hourly Cost - are calculated using on-demand rates and cover only the instance-hour portion of your bill (i.e., the billable instance hours but not data transfer or EBS). As such, they should be used for trending and prioritization only, not financial reporting.
Similarities and differences between v1 and v3 for utilization reports
To make the transition to v3 as straightforward as possible changes to the query parameters and the payload returned for the utilization reports has been kept at a minimum. Therefore, how you execute a specific report and then parse its results remains largely consistent.
The notable differences between v1 and v3 for cost reports are:
- The sort_by parameter is now named sort to match the v3 standard
- There is no longer an order Instead DESC or ASC is appended to the sort value
- The max_results parameter is now named limit to match the v3 standard
- v3 offers an automated pagination system, navigated via tokens, for when rows exceed 10,000
Example request
To run a utilization report that returns a JSON based response simply run a GET request at curl https://api.cloudability.com/v3/reporting/util/run with query parameters matching the dates, dimensions, and filters relevant to you.
Figure 1: example utilization report made via curl
General considerations when moving from v1 to v3 API end points
Individual API documents have been added to the v3 user documentation for each endpoint. Changes at the endpoint interface level between v1 and v3 are reflected within the endpoint documentation.
Some general differences between the v1 and v3 APIs:
Stay tuned as the complete set of end points becomes available on the v3 API
Look out for further updates as our engineering team launches the complete set of endpoints on the v3 API. Announcements will also be made regarding the future of the v1 API.
#API#Reports#Cloudability