Obtenir la liste d’informations de partition chargée

Article
08/05/2023

Obtient la liste triée des partitions.

Récupère les partitions les plus/moins chargées en fonction de la métrique spécifiée.

Requête

Méthode	URI de demande
GET	`/$/GetLoadedPartitionInfoList?api-version=8.0&MetricName={MetricName}&ServiceName={ServiceName}&Ordering={Ordering}&MaxResults={MaxResults}&ContinuationToken={ContinuationToken}`

Paramètres

Nom	Type	Obligatoire	Emplacement
`api-version`	string	Oui	Requête
`MetricName`	string	Oui	Requête
`ServiceName`	string	Non	Requête
`Ordering`	string (énumération)	Non	Requête
`MaxResults`	entier (int64)	Non	Requête
`ContinuationToken`	string	Non	Requête

`api-version`

Type : chaîne
Obligatoire : Oui
Par défaut : 8.0

Version de l’API. Ce paramètre est obligatoire et sa valeur doit être « 8.0 ».

La version de l’API REST Service Fabric est basée sur la version du runtime dans laquelle l’API a été introduite ou a été modifiée. Le runtime Service Fabric prend en charge plusieurs versions de l’API. Cette version est la dernière version prise en charge de l’API. Si une version d’API inférieure est transmise, la réponse retournée peut être différente de celle documentée dans cette spécification.

En outre, le runtime accepte toute version supérieure à la dernière version prise en charge jusqu’à la version actuelle du runtime. Par conséquent, si la dernière version de l’API est 6.0 et que le runtime est 6.1, le runtime accepte la version 6.1 pour cette API. Toutefois, le comportement de l’API sera en fonction de la version 6.0 documentée.

`MetricName`

Type : chaîne
Obligatoire : Oui

Nom de la métrique en fonction de laquelle obtenir la liste triée des partitions.

`ServiceName`

Type : chaîne
Obligatoire : Non

Nom d’un service.

`Ordering`

Type : chaîne (énumération)
Obligatoire : Non
Par défaut : Desc

Ordre de charge des partitions. Les valeurs possibles sont les suivantes : 'Desc', 'Asc'

`MaxResults`

Type : integer (int64)
Obligatoire : Non
Par défaut : 0
InclusiveMinimum : 0

Nombre maximal de résultats à renvoyer dans le cadre des requêtes paginées. Ce paramètre définit la limite supérieure du nombre de résultats renvoyés. Le nombre de résultats renvoyés peut être inférieur au nombre maximal de résultats spécifié s’ils ne tiennent pas dans le message conformément aux restrictions de taille maximale définies dans la configuration. Si ce paramètre est défini sur zéro ou n’est pas spécifié, la requête paginée comprend le nombre maximal de résultats pouvant tenir dans le message renvoyé.

`ContinuationToken`

Type : chaîne
Obligatoire : Non

Le paramètre de jeton de liaison permet d’obtenir le jeu de résultats suivant. Un jeton de liaison avec une valeur non vide est inclus dans la réponse de l’API quand les résultats du système ne tiennent pas dans une seule réponse. Lorsque cette valeur est transmise à l’appel d’API suivant, l’API retourne le jeu de résultats suivant. S’il n’existe pas de résultats supplémentaires, le jeton de liaison ne contient pas de valeur. La valeur de ce paramètre ne doit pas être codée URL.

Réponses

Code d’état HTTP	Description	Schéma de réponse
200 (OK)	Une opération réussie retourne 200 status code et les informations de chargement de cluster demandées.	LoadedPartitionInformationResultList
Tous les autres codes status	Réponse d’erreur détaillée.	FabricError

Partager via