Get Loaded Partition Info List

  • Article

Gets ordered list of partitions.

Retrieves partitions which are most/least loaded according to specified metric.

Request

Method Request URI
GET /$/GetLoadedPartitionInfoList?api-version=8.0&MetricName={MetricName}&ServiceName={ServiceName}&Ordering={Ordering}&MaxResults={MaxResults}&ContinuationToken={ContinuationToken}

Parameters

Name Type Required Location
api-version string Yes Query
MetricName string Yes Query
ServiceName string No Query
Ordering string (enum) No Query
MaxResults integer (int64) No Query
ContinuationToken string No Query

api-version

Type: string
Required: Yes
Default: 8.0

The version of the API. This parameter is required and its value must be '8.0'.

Service Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.

Additionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.

MetricName

Type: string
Required: Yes

Name of the metric based on which to get ordered list of partitions.

ServiceName

Type: string
Required: No

The name of a service.

Ordering

Type: string (enum)
Required: No
Default: Desc

Ordering of partitions' load. Possible values include: 'Desc', 'Asc'

MaxResults

Type: integer (int64)
Required: No
Default: 0
InclusiveMinimum: 0

The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message.

ContinuationToken

Type: string
Required: No

The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value 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 does not contain a value. The value of this parameter should not be URL encoded.

Responses

HTTP Status Code Description Response Schema
200 (OK) A successful operation will return 200 status code and the requested cluster load information.
 LoadedPartitionInformationResultList
All other status codes The detailed error response.
 FabricError