---
title: "Update the loads of provided partitions for specific metrics."
method: POST
path: "/$/UpdatePartitionLoad"
tags: ["Partition"]
---

# Update the loads of provided partitions for specific metrics.

`POST /$/UpdatePartitionLoad`

Updates the load value and predicted load value for all the partitions provided for specified metrics.

## Query parameters

- `api-version` '7.2', required
- `ContinuationToken` string
- `MaxResults` integer
- `timeout` integer

## Request body

- PartitionMetricLoadDescription[] — List that contains load descriptions of each partition.
  - `PartitionId` string, uuid — An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
  - `PrimaryReplicaLoadEntries` MetricLoadDescription[] — Partition's load information for primary replica, in case partition is from a stateful service.
    - `MetricName` string — The name of the reported metric.
    - `CurrentLoad` integer — The current value of the metric load.
    - `PredictedLoad` integer — The predicted value of the metric load. Predicted metric load values is currently a preview feature. It allows predicted load values to be reported and used at the Service Fabric side, but that feature is currently not enabled.
  - `SecondaryReplicasOrInstancesLoadEntries` MetricLoadDescription[] — Partition's load information for all secondary replicas or instances.
    - `MetricName` string — The name of the reported metric.
    - `CurrentLoad` integer — The current value of the metric load.
    - `PredictedLoad` integer — The predicted value of the metric load. Predicted metric load values is currently a preview feature. It allows predicted load values to be reported and used at the Service Fabric side, but that feature is currently not enabled.
  - `SecondaryReplicaOrInstanceLoadEntriesPerNode` ReplicaMetricLoadDescription[] — Partition's load information for a specific secondary replica or instance located on a specific node.
    - `NodeName` string — Node name of a specific secondary replica or instance.
    - `ReplicaOrInstanceLoadEntries` MetricLoadDescription[] — Loads of a different metrics for a partition's secondary replica or instance.
      - `MetricName` string — The name of the reported metric.
      - `CurrentLoad` integer — The current value of the metric load.
      - `PredictedLoad` integer — The predicted value of the metric load. Predicted metric load values is currently a preview feature. It allows predicted load values to be reported and used at the Service Fabric side, but that feature is currently not enabled.
  - `AuxiliaryReplicasLoadEntries` MetricLoadDescription[] — Partition's load information for all auxiliary replicas.
    - `MetricName` string — The name of the reported metric.
    - `CurrentLoad` integer — The current value of the metric load.
    - `PredictedLoad` integer — The predicted value of the metric load. Predicted metric load values is currently a preview feature. It allows predicted load values to be reported and used at the Service Fabric side, but that feature is currently not enabled.
  - `AuxiliaryReplicaLoadEntriesPerNode` ReplicaMetricLoadDescription[] — Partition's load information for a specific auxiliary replica located on a specific node.
    - `NodeName` string — Node name of a specific secondary replica or instance.
    - `ReplicaOrInstanceLoadEntries` MetricLoadDescription[] — Loads of a different metrics for a partition's secondary replica or instance.
      - `MetricName` string — The name of the reported metric.
      - `CurrentLoad` integer — The current value of the metric load.
      - `PredictedLoad` integer — The predicted value of the metric load. Predicted metric load values is currently a preview feature. It allows predicted load values to be reported and used at the Service Fabric side, but that feature is currently not enabled.

## Response `200`

List UpdatePartitionLoadResults.

- PagedUpdatePartitionLoadResultList — The list of results of the call UpdatePartitionLoad. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
  - `ContinuationToken` string — The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.
  - `Items` UpdatePartitionLoadResult[] — List of partition load update information.
    - `PartitionId` string, uuid — An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
    - `PartitionErrorCode` integer — If OperationState is Completed - this is 0. If OperationState is Faulted - this is an error code indicating the reason.

## Other responses

- `default` — The error code response per specified partition.

---

[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/versions/6ebed3032b57/schema)