---
title: "Gets the load of a Service Fabric cluster."
method: GET
path: "/$/GetLoadInformation"
tags: ["Cluster"]
---

# Gets the load of a Service Fabric cluster.

`GET /$/GetLoadInformation`

Retrieves the load information of a Service Fabric cluster for all the metrics that have load or capacity defined.

## Query parameters

- `api-version` '6.0', required
- `timeout` integer

## Response `200`

A successful operation will return 200 status code and the requested cluster load information.

- ClusterLoadInfo — Information about load in a Service Fabric cluster. It holds a summary of all metrics and their load in a cluster.
  - `LastBalancingStartTimeUtc` string, date-time — The starting time of last resource balancing run.
  - `LastBalancingEndTimeUtc` string, date-time — The end time of last resource balancing run.
  - `LoadMetricInformation` LoadMetricInformation[] — List that contains metrics and their load information in this cluster.
    - `Name` string — Name of the metric for which this load information is provided.
    - `IsBalancedBefore` boolean — Value that indicates whether the metrics is balanced or not before resource balancer run
    - `IsBalancedAfter` boolean — Value that indicates whether the metrics is balanced or not after resource balancer run.
    - `DeviationBefore` string, double — The standard average deviation of the metrics before resource balancer run.
    - `DeviationAfter` string, double — The standard average deviation of the metrics after resource balancer run.
    - `BalancingThreshold` string, double — The balancing threshold for a certain metric.
    - `Action` string — The current action being taken with regard to this metric
    - `ActivityThreshold` string, double — The Activity Threshold specified for this metric in the system Cluster Manifest.
    - `ClusterCapacity` string — The total cluster capacity for a given metric
    - `ClusterLoad` string — The total cluster load. In future releases of Service Fabric this parameter will be deprecated in favor of CurrentClusterLoad.
    - `CurrentClusterLoad` string, double — The total cluster load.
    - `ClusterRemainingCapacity` string — The remaining capacity for the metric in the cluster. In future releases of Service Fabric this parameter will be deprecated in favor of ClusterCapacityRemaining.
    - `ClusterCapacityRemaining` string — The remaining capacity for the metric in the cluster.
    - `IsClusterCapacityViolation` boolean — Indicates that the metric is currently over capacity in the cluster.
    - `NodeBufferPercentage` string, double — The reserved percentage of total node capacity for this metric.
    - `ClusterBufferedCapacity` string — Remaining capacity in the cluster excluding the reserved space. In future releases of Service Fabric this parameter will be deprecated in favor of BufferedClusterCapacityRemaining.
    - `BufferedClusterCapacityRemaining` string, double — Remaining capacity in the cluster excluding the reserved space.
    - `ClusterRemainingBufferedCapacity` string — The remaining percentage of cluster total capacity for this metric.
    - `MinNodeLoadValue` string — The minimum load on any node for this metric. In future releases of Service Fabric this parameter will be deprecated in favor of MinimumNodeLoad.
    - `MinimumNodeLoad` string, double — The minimum load on any node for this metric.
    - `MinNodeLoadNodeId` NodeId — An internal ID used by Service Fabric to uniquely identify a node. Node Id is deterministically generated from node name.
      - `Id` string — Value of the node Id. This is a 128 bit integer.
    - `MaxNodeLoadValue` string — The maximum load on any node for this metric. In future releases of Service Fabric this parameter will be deprecated in favor of MaximumNodeLoad.
    - `MaximumNodeLoad` string, double — The maximum load on any node for this metric.
    - `MaxNodeLoadNodeId` NodeId — An internal ID used by Service Fabric to uniquely identify a node. Node Id is deterministically generated from node name.
      - `Id` string — Value of the node Id. This is a 128 bit integer.
    - `PlannedLoadRemoval` string, double — This value represents the load of the replicas that are planned to be removed in the future within the cluster. This kind of load is reported for replicas that are currently being moving to other nodes and for replicas that are currently being dropped but still use the load on the source node.

## Other responses

- `default` — The detailed error response.

---

[API](https://skmtc.net/azure/apis/servicefabric-servicefabric.md) · [All operations](https://skmtc.net/azure/apis/servicefabric-servicefabric/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/azure/servicefabric-servicefabric/revisions/8fd479ce0f16/schema)