helixml / helix

outcomes for API - helixml/helix

The HelixML API is a part of the Helix project, which is a configurable, extensible, and scalable framework for building microservices. The Helix API provides endpoints for interacting with the Helix manager and performing various operations related to managing and monitoring microservices.

Here are some of the possible options for interacting with the HelixML API and examples for each option:

  1. Querying the status of a cluster: You can use the /clusters endpoint to get information about the current state of a cluster, including the list of nodes, their status, and the distribution of resources. Here’s an example cURL request:
curl -X GET http://localhost:18273/clusters
  1. Getting the configuration of a cluster: You can use the /config endpoint to get the current configuration of a cluster, including the resource allocation and partitioning. Here’s an example cURL request:
curl -X GET http://localhost:18273/config
  1. Updating the configuration of a cluster: You can use the /config endpoint to update the current configuration of a cluster. Here’s an example cURL request that updates the configuration of a cluster with a new resource allocation:
curl -X PUT http://localhost:18273/config \
  -H 'Content-Type: application/json' \
-d '{
"resourceAllocation": {
"cpu": 2,
"memory": 4096
}
}'
  1. Monitoring the performance of a cluster: You can use the /metrics endpoint to get metrics about the performance of a cluster, including the resource usage and throughput. Here’s an example cURL request:
curl -X GET http://localhost:18273/metrics
  1. Managing the lifecycle of a microservice: You can use the /services endpoint to manage the lifecycle of a microservice, including starting, stopping, and scaling the service. Here’s an example cURL request that scales a microservice to 3 instances:
curl -X PUT http://localhost:18273/services/my-service/instances \
  -H 'Content-Type: application/json' \
-d '3'

These are just a few examples of the many options available in the HelixML API. For more information, you can refer to the official Helix documentation at https://helix-tech.github.io/helix/userguide/.

Sources: