Získat seznam informací o nasazené aplikaci

Článek
08/05/2023

Získá seznam aplikací nasazených v uzlu Service Fabric.

Získá seznam aplikací nasazených v uzlu Service Fabric. Výsledky neobsahují informace o nasazených systémových aplikacích, pokud nejsou explicitně dotazovány podle ID. Výsledky zahrnují nasazené aplikace ve stavu aktivní, aktivace a stahování. Tento dotaz vyžaduje, aby název uzlu odpovídal uzlu v clusteru. Dotaz selže, pokud zadaný název uzlu neodkazuje na žádné aktivní uzly Service Fabric v clusteru.

Žádost

Metoda	Identifikátor URI žádosti
GET	`/Nodes/{nodeName}/$/GetApplications?api-version=6.1&timeout={timeout}&IncludeHealthState={IncludeHealthState}&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}`

Parametry

Název	Typ	Vyžadováno	Umístění
`nodeName`	řetězec	Yes	Cesta
`api-version`	řetězec	Ano	Dotaz
`timeout`	celé číslo (int64)	No	Dotaz
`IncludeHealthState`	boolean	Ne	Dotaz
`ContinuationToken`	řetězec	No	Dotaz
`MaxResults`	celé číslo (int64)	Ne	Dotaz

`nodeName`

Typ: string
Povinné: Ano

Název uzlu

`api-version`

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

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

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. Toto je nejnovější podporovaná verze 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, ale modul runtime je 6.1, aby se usnadnil zápis klientů, modul runtime pro toto rozhraní API přijme verzi 6.1. Chování rozhraní API však bude podle zdokumentované verze 6.0.

`timeout`

Typ: celé číslo (int64)
Povinné: Ne
Výchozí:60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

Časový limit serveru pro provedení operace v sekundách. Tento časový limit určuje dobu, po kterou je klient ochoten čekat na dokončení požadované operace. Výchozí hodnota tohoto parametru je 60 sekund.

`IncludeHealthState`

Typ: logická
Povinné: Ne
Výchozí:false

Uveďte stav entity. Pokud je tento parametr false nebo není zadaný, je vrácený stav Neznámý. Pokud je nastavená hodnota true, dotaz se před sloučením výsledků paralelně přesune do uzlu a služby health system. V důsledku toho je dotaz dražší a může trvat delší dobu.

`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.

`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.

Odpovědi

Stavový kód HTTP	Description	Schéma odpovědi
200 (OK)	Úspěšná operace vrátí stavový kód 200 a seznam informací o nasazené aplikaci.	PagedDeployedApplicationInfoList
Všechny ostatní stavové kódy	Podrobná odpověď na chybu.	Chyba infrastruktury

Příklady

Omezit maximální počet výsledků

Tento příklad ukazuje, jak určit počet aplikací vrácených dotazem při získávání informací o aplikacích nasazených na konkrétním uzlu. Počet výsledků na stránce je omezen maximálně na 2 pomocí parametru MaxResult. V tomto příkladu není požadován stav, takže vrácený stav bude Neznámý.

Žádost

GET http://localhost:19080/Nodes/_Node_0/$/GetApplications?api-version=6.1&MaxResults=2

Odpověď: 200

Text

{
  "ContinuationToken": "fabric:/samples/PQueueApp1",
  "Items": [
    {
      "Id": "samples~CalculatorApp",
      "Name": "fabric:/samples/CalculatorApp",
      "TypeName": "CalculatorApp",
      "TypeVersion": "1.0.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\temp",
      "HealthState": "Unknown"
    },
    {
      "Id": "samples~PQueueApp1",
      "Name": "fabric:/samples/PQueueApp1",
      "TypeName": "PersistentQueueApp",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\temp",
      "HealthState": "Unknown"
    }
  ]
}

Stránka pomocí pokračovacího tokenu

Tento příklad ukazuje funkce stránkování, které jsou k dispozici při získávání informací o aplikacích nasazených na konkrétním uzlu. Tento příklad používá parametr ContinuationToken. Hodnota tohoto parametru je zadaná z předchozího dotazu; v tomto případě výše uvedený příklad. Odpověď obsahuje zbývající výsledky a prázdný text ContinuationToken. Prázdný ContinuationToken označuje, že další výsledky nejsou k dispozici.

Žádost

GET http://localhost:19080/Nodes/_Node_0/$/GetApplications?api-version=6.1&ContinuationToken=fabric:/samples/PQueueApp1

Odpověď: 200

Text

{
  "ContinuationToken": "",
  "Items": [
    {
      "Id": "samples~VQueueApp1",
      "Name": "fabric:/samples/VQueueApp1",
      "TypeName": "VolatileQueueApp",
      "TypeVersion": "1.0.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\temp",
      "HealthState": "Unknown"
    }
  ]
}

Zahrnout do výsledku stav

Tento příklad ukazuje, jak zahrnout stav každé nasazené aplikace při získávání informací o aplikacích nasazených na konkrétním uzlu.

Žádost

GET http://localhost:19080/Nodes/_Node_0/$/GetApplications?api-version=6.1&IncludeHealthState=True

Odpověď: 200

Text

{
  "ContinuationToken": "",
  "Items": [
    {
      "Id": "samples~CalculatorApp",
      "Name": "fabric:/samples/CalculatorApp",
      "TypeName": "CalculatorApp",
      "TypeVersion": "1.0.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\temp",
      "HealthState": "Ok"
    },
    {
      "Id": "samples~PQueueApp1",
      "Name": "fabric:/samples/PQueueApp1",
      "TypeName": "PersistentQueueApp",
      "TypeVersion": "1.0.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\temp",
      "HealthState": "Ok"
    },
    {
      "Id": "samples~VQueueApp1",
      "Name": "fabric:/samples/VQueueApp1",
      "TypeName": "VolatileQueueApp",
      "TypeVersion": "1.0.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\temp",
      "HealthState": "Ok"
    }
  ]
}

Share via

Získat seznam informací o nasazené aplikaci

Žádost

Parametry

`nodeName`

`api-version`

`timeout`

`IncludeHealthState`

`ContinuationToken`

`MaxResults`

Odpovědi

Příklady

Omezit maximální počet výsledků

Žádost

Odpověď: 200

Text

Stránka pomocí pokračovacího tokenu

Žádost

Odpověď: 200

Text

Zahrnout do výsledku stav

Žádost

Odpověď: 200

Text

Další materiály