Skip to content

Enhance getAllInstances API to provide detailed instance operation state categorization#75

Merged
LZD-PratyushBhatt merged 1 commit intodevfrom
lzd/getAllInstancesV2
Dec 8, 2025
Merged

Enhance getAllInstances API to provide detailed instance operation state categorization#75
LZD-PratyushBhatt merged 1 commit intodevfrom
lzd/getAllInstancesV2

Conversation

@LZD-PratyushBhatt
Copy link
Collaborator

@LZD-PratyushBhatt LZD-PratyushBhatt commented Nov 19, 2025

Issues

  • My PR addresses the following Helix issues and references them in the PR description:
    Enhanced the clusters/{clusterId}/instances REST API endpoint to provide detailed categorization of instances based on their InstanceOperation states (ENABLE, DISABLE, EVACUATE, SWAP_IN, UNKNOWN) instead of grouping all non-enabled instances into a single "disabled" list.

(apache#200 - Link your issue number here: You can write "Fixes #XXX". Please use the proper keyword so that the issue gets closed automatically. See https://docs.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue
Any of the following keywords can be used: close, closes, closed, fix, fixes, fixed, resolve, resolves, resolved)

Description

  • Here are some details about my PR, including screenshots of any UI changes:

(Write a concise description including what, why, how)
Old API response:

{
  "id" : "TestCluster",
  "instances" : [ "localhost_12212", "localhost_12213", "localhost_12214", "localhost_12215", "localhost_12216", "localhost_12217", "localhost_12218", "localhost_12219", "localhost_12221", "localhost_12222" ],
  "online" : [ "localhost_12212", "localhost_12213", "localhost_12214", "localhost_12215", "localhost_12216", "localhost_12217", "localhost_12218", "localhost_12219", "localhost_12221", "localhost_12222" ],
  "enabled" : [ "localhost_12213", "localhost_12214", "localhost_12215", "localhost_12216", "localhost_12217", "localhost_12218", "localhost_12219", "localhost_12221", "localhost_12222" ],
  "disabled" : ["localhost_12212" ]
}

New enhanced response:

{
  "id" : "TestCluster",
  "instances" : [ "localhost_12212", "localhost_12213", "localhost_12214", "localhost_12215", "localhost_12216", "localhost_12217", "localhost_12218", "localhost_12219", "localhost_12221", "localhost_12222" ],
  "online" : [ "localhost_12212", "localhost_12213", "localhost_12214", "localhost_12215", "localhost_12216", "localhost_12217", "localhost_12218", "localhost_12219", "localhost_12221", "localhost_12222" ],
  "enabled" : [ "localhost_12213", "localhost_12214", "localhost_12215", "localhost_12216", "localhost_12217", "localhost_12218", "localhost_12219", "localhost_12221", "localhost_12222" ],
  "disabled" : [ ],
  "evacuated" : [ "localhost_12212" ],
  "swap_in" : [ ],
  "unknown" : [ ]
}

Tests

UT added + Manually tested in actual Helix cluster.

  • The following tests are written for this issue:

(List the names of added unit/integration tests)

  • The following is the result of the "mvn test" command on the appropriate module:

(If CI test fails due to known issue, please specify the issue and test PR locally. Then copy & paste the result of "mvn test" to here.)

Changes that Break Backward Compatibility (Optional)

  • My PR contains changes that break backward compatibility or previous assumptions for certain methods or API. They include:

(Consider including all behavior changes for public methods or API. Also include these changes in merge description so that other developers are aware of these changes. This allows them to make relevant code changes in feature branches accounting for the new method/API behavior.)

Documentation (Optional)

  • In case of new functionality, my PR adds documentation in the following wiki page:

(Link the GitHub wiki you added)

Commits

  • My commits all reference appropriate Apache Helix GitHub issues in their subject lines. In addition, my commits follow the guidelines from "How to write a good git commit message":
    1. Subject is separated from body by a blank line
    2. Subject is limited to 50 characters (not including Jira issue reference)
    3. Subject does not end with a period
    4. Subject uses the imperative mood ("add", not "adding")
    5. Body wraps at 72 characters
    6. Body explains "what" and "why", not "how"

Code Quality

  • My diff has been formatted using helix-style.xml
    (helix-style-intellij.xml if IntelliJ IDE is used)

Copy link
Collaborator

@ngngwr ngngwr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@LZD-PratyushBhatt LZD-PratyushBhatt merged commit 920c21c into dev Dec 8, 2025
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants