Sdílet prostřednictvím

Získání informací o aplikaci

  • Článek

Získá informace o aplikaci Service Fabric.

Vrátí informace o aplikaci, která byla vytvořena nebo v procesu vytváření v clusteru Service Fabric a jejíž název odpovídá názvu zadanému jako parametr. Odpověď obsahuje název, typ, stav, parametry a další podrobnosti o aplikaci.

Žádost

Metoda Identifikátor URI žádosti
GET /Applications/{applicationId}?api-version=6.0&ExcludeApplicationParameters={ExcludeApplicationParameters}&timeout={timeout}

Parametry

Název Typ Vyžadováno Umístění
applicationId řetězec Yes Cesta
api-version řetězec Ano Dotaz
ExcludeApplicationParameters boolean No Dotaz
timeout integer (int64) No Dotaz

applicationId

Typ: řetězec
Povinné: Ano

Identita aplikace. Obvykle se jedná o úplný název aplikace bez schématu identifikátoru URI fabric:. Od verze 6.0 jsou hierarchické názvy oddělené znakem ~. Pokud je například název aplikace "fabric:/myapp/app1", identita aplikace bude ve verzi 6.0 nebo novější "myapp~app1" a v předchozích verzích "myapp/app1".

api-version

Typ: řetězec
Povinné: Ano
Výchozí:6.0

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

Verze rozhraní REST API Service Fabric 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 se předá nižší verze rozhraní API, může se vrácená odpověď 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.

ExcludeApplicationParameters

Typ: boolean
Povinné: Ne
Výchozí:false

Příznak, který určuje, jestli budou parametry aplikace vyloučeny z výsledku.

timeout

Typ: integer (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.

Odpovědi

Stavový kód HTTP Description Schéma odpovědi
200 (OK) Informace o aplikaci.
 Applicationinfo
204 (bez obsahu) Pokud se v clusteru nenajde zadané applicationId, vrátí se prázdná odpověď.
Všechny ostatní stavové kódy Podrobná chybová odpověď.
 Chyba infrastruktury

Příklady

Získání konkrétní aplikace podle ID aplikace

Tento příklad ukazuje, jak získat informace o aplikaci pomocí identifikátoru. Pokud se aplikace najde, vrátí se informace o ní se stavovým kódem 200. Pokud se aplikace nenajde, vrátí se prázdný obsah se stavovým kódem 204.

Žádost

GET http://localhost:19080/Applications/samples~CalculatorApp?api-version=6.0

Odpověď 200

Text
{
  "Id": "samples~CalculatorApp",
  "Name": "fabric:/samples/CalculatorApp",
  "TypeName": "CalculatorApp",
  "TypeVersion": "1.0",
  "Status": "Ready",
  "Parameters": [
    {
      "Key": "CalculatorAppParameter1",
      "Value": "314"
    },
    {
      "Key": "CalculatorAppParameter2",
      "Value": "271"
    }
  ],
  "HealthState": "Ok",
  "ApplicationDefinitionKind": "ServiceFabricApplicationDescription"
}

Odpověď 204

Text

Text odpovědi je prázdný.