Get Loaded Partition Info List v82

Ruft die sortierte Liste der Partitionen ab.

Ruft Partitionen ab, die am meisten/am wenigsten gemäß der angegebenen Metrik geladen werden.

Anforderung

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

Parameter

Name Typ Erforderlich Standort
api-version Zeichenfolge Ja Abfrage
MetricName Zeichenfolge Ja Abfrage
ServiceName Zeichenfolge Nein Abfrage
Ordering Zeichenfolge (Enumeration) Nein Abfrage
MaxResults ganze Zahl (int64) Nein Abfrage
ContinuationToken Zeichenfolge Nein Abfrage

api-version

Typ: Zeichenfolge
Erforderlich: Ja
Standard:

Die Version der API. Dieser Parameter ist erforderlich, und sein Wert muss '8.0' sein.

Service Fabric REST-API-Version basiert auf der Laufzeitversion, in der die API eingeführt oder geändert wurde. Service Fabric Laufzeit unterstützt mehrere Versionen der API. Diese Version ist die neueste unterstützte Version der API. Wenn eine niedrigere API-Version übergeben wird, unterscheidet sich die zurückgegebene Antwort möglicherweise von der in dieser Spezifikation dokumentierten.

Darüber hinaus akzeptiert die Laufzeit alle Versionen, die höher als die neueste unterstützte Version bis zur aktuellen Version der Laufzeit sind. Wenn also die neueste API-Version 6.0 ist und die Laufzeit 6.1 ist, akzeptiert die Laufzeit Version 6.1 für diese API. Das Verhalten der API entspricht jedoch der dokumentierten Version 6.0.


MetricName

Typ: Zeichenfolge
Erforderlich: Ja

Name der Metrik, basierend auf der die sortierte Liste der Partitionen abgerufen werden soll.


ServiceName

Typ: Zeichenfolge
Erforderlich: Nein

Der Name eines Diensts.


Ordering

Typ: Zeichenfolge (Enumeration)
Erforderlich: Nein
Standard:

Sortierung der Partitionenlade. Mögliche Werte sind: 'Desc', 'Asc'


MaxResults

Typ: ganze Zahl (int64)
Erforderlich: Nein
Standard:
InclusiveMinimum: 0

Die maximale Anzahl von Ergebnissen, die als Teil der seitenweisen Abfragen zurückgegeben werden sollen. Dieser Parameter definiert die obere Grenze für die Anzahl von zurückgegebenen Ergebnissen. Es können weniger Ergebnisse zurückgegeben werden, als dieser maximalen Anzahl entspricht. Dies ist der Fall, wenn die Ergebnisse wegen der Größenbeschränkungen, die für Meldungen in der Konfiguration definiert sind, nicht in die jeweilige Meldung passen. Ist dieser Parameter gleich null oder nicht angegeben, enthält die seitenweise Abfrage so viele Ergebnisse, wie in die Rückgabemeldung passen.


ContinuationToken

Typ: Zeichenfolge
Erforderlich: Nein

Der Parameter „continuation-token“ (Fortsetzungstoken) wird dazu verwendet, den nächsten Satz von Ergebnissen abzurufen. Ein Fortsetzungstoken mit einem nicht leeren Wert wird in die Antwort der API eingefügt, wenn die Ergebnisse aus dem System nicht in eine einzige Antwort passen. Wird dieser Wert an den nächsten API-Aufruf übergeben, gibt die API den nächsten Satz von Ergebnissen zurück. Gibt es keine weiteren Ergebnisse, enthält das Fortsetzungstoken keinen Wert. Der Wert dieses Parameters darf nicht als URL codiert sein.

Antworten

HTTP-Statuscode BESCHREIBUNG Antwortschema
200 (OK) Ein erfolgreicher Vorgang gibt den Statuscode 200 und die angeforderten Clusterladeinformationen zurück.
LoadedPartitionInformationResultList
Alle anderen Statuscodes Die detaillierte Fehlerantwort.
FabricError