Získat načtený seznam informací o oddílu

Článek
08/05/2023

Získá seřazený seznam oddílů.

Načte oddíly, které jsou načteny nejvíce nebo nejméně podle zadané metriky.

Žádost

Metoda	Identifikátor URI žádosti
GET	`/$/GetLoadedPartitionInfoList?api-version=8.0&MetricName={MetricName}&ServiceName={ServiceName}&Ordering={Ordering}&MaxResults={MaxResults}&ContinuationToken={ContinuationToken}`

Parametry

Název	Typ	Vyžadováno	Umístění
`api-version`	řetězec	Yes	Dotaz
`MetricName`	řetězec	Yes	Dotaz
`ServiceName`	řetězec	No	Dotaz
`Ordering`	string (výčet)	Ne	Dotaz
`MaxResults`	celé číslo (int64)	Ne	Dotaz
`ContinuationToken`	řetězec	No	Dotaz

`api-version`

Typ: string
Povinné: Ano
Výchozí:8.0

Verze rozhraní API Tento parametr je povinný a jeho hodnota musí být 8.0.

Verze rozhraní SERVICE Fabric REST API je založená na verzi modulu runtime, ve které bylo rozhraní API zavedeno nebo změněno. Modul runtime Service Fabric podporuje více než jednu verzi rozhraní API. Tato verze je nejnovější podporovanou verzí rozhraní API. Pokud je předána nižší verze rozhraní API, vrácená odpověď se může lišit od odpovědi popsané v této specifikaci.

Modul runtime navíc přijímá všechny verze, které jsou vyšší než nejnovější podporovaná verze až do aktuální verze modulu runtime. Pokud je tedy nejnovější verze rozhraní API 6.0 a modul runtime je 6.1, modul runtime pro toto rozhraní API přijme verzi 6.1. Chování rozhraní API však bude podle zdokumentované verze 6.0.

`MetricName`

Typ: string
Povinné: Ano

Název metriky, na základě které chcete získat seřazený seznam oddílů.

`ServiceName`

Typ: string
Povinné: Ne

Název služby.

`Ordering`

Typ: řetězec (výčet)
Povinné: Ne
Výchozí:Desc

Řazení zatížení oddílů. Mezi možné hodnoty patří: "Desc", "Asc"

`MaxResults`

Typ: celé číslo (int64)
Povinné: Ne
Výchozí:0
InclusiveMinimum: 0

Maximální počet výsledků, které se mají vrátit jako součást stránkovaných dotazů. Tento parametr definuje horní mez počtu vrácených výsledků. Vrácené výsledky můžou být menší než zadané maximální výsledky, pokud se nevejdou do zprávy podle omezení maximální velikosti zprávy definované v konfiguraci. Pokud je tento parametr nula nebo není zadaný, stránkovaný dotaz obsahuje co nejvíce výsledků, které se vejdou do návratové zprávy.

`ContinuationToken`

Typ: string
Povinné: Ne

Parametr pokračovacího tokenu se používá k získání další sady výsledků. Token pokračování s neprázdnou hodnotou je součástí odpovědi rozhraní API, pokud se výsledky ze systému nevejdou do jedné odpovědi. Když se tato hodnota předá dalšímu volání rozhraní API, vrátí rozhraní API další sadu výsledků. Pokud nejsou k dispozici žádné další výsledky, znamená to, že pokračovací token neobsahuje hodnotu. Hodnota tohoto parametru by neměla být kódovaná adresa URL.

Odpovědi

Stavový kód HTTP	Description	Schéma odpovědi
200 (OK)	Úspěšná operace vrátí stavový kód 200 a požadované informace o zatížení clusteru.	LoadedPartitionInformationResultList
Všechny ostatní stavové kódy	Podrobná odpověď na chybu.	Chyba infrastruktury

Sdílet prostřednictvím