Overview

API References Overview of Cluster Optimizer.

This section provides reference information for the Cluster Optimizer API.

Overview

The Cluster Optimizer API is a powerful tool that allows users to interact with and automate their cloud-native cluster optimization processes programmatically. By exposing the core functionalities of the platform through RESTful endpoints, the API enables users to integrate the Cluster Optimizer with third-party applications, automate tasks, and retrieve detailed reports on resource utilization and cost-saving opportunities.

  1. Comprehensive Access to Functionality: The API grants users full access to key features of the Cluster Optimizer platform, such as:
    • Cluster Management: Users can import, update, or delete clusters and associated cloud accounts through the API.
    • Resource Optimization: The API provides endpoints for analyzing and optimizing resource usage, such as node groups, disks, and workloads.
    • Cost and Savings Insights: Users can programmatically access detailed reports on cost savings and optimization opportunities, tailored to their specific configurations.
  2. Flexibility and Customization: The API is highly customizable, allowing users to:
    • Create custom workflows that automate resource management and optimization based on real-time data.
    • Integrate optimization reports into internal dashboards or financial reporting systems, enabling better tracking of cloud costs.
  3. Support for Multiple Cloud Platforms: The API supports cloud-native environments across various platforms, such as AWS, Alibaba Cloud, and Kubernetes clusters. This cross-platform capability ensures seamless integration and control over distributed resources, regardless of the underlying cloud infrastructure.

Use Cases

  1. Automation of Optimization Tasks: DevOps teams can automate the application of optimization strategies (e.g., adjusting node groups, hibernating clusters) based on workload demands. This reduces manual intervention, increases operational efficiency, and ensures continuous resource management.
  2. Custom Monitoring and Alerting: Users can build custom monitoring systems that query the API for real-time resource utilization and optimization data. Alerts can be triggered based on specific thresholds or events, such as a sudden spike in cloud costs or resource underutilization.
  3. Integration with Financial Tools: Finance teams can use the API to pull detailed cost-saving reports and integrate them into their financial systems. This enables continuous monitoring of cloud spending and optimization efforts, which aligns with FinOps principles for financial accountability in cloud management.

API Overview

The REST API is the fundamental fabric of Cluster Optimizer. Cluster Optimizer provides a REST API that allows you to perform the following operations:

  • Management API: Manage clusters, cluster access accounts, access keys, notification channels, notification rules and so on.
  • Optimize API: Provider recommendation and optimization for kubernetes resources, such as node group, persistent volume, workload and so on.

NOTE:

  1. Cluster Optimizer API is available in the Commercial Edition with version 1.3.1 and above.
  2. Cluster Optimizer API is in alpha state. The api interface may be changed in the future.