Abrufen bereitgestellter Anwendungsinformationen

  • Artikel

Ruft die Informationen zu einer Anwendung ab, die auf einem Service Fabric-Knoten bereitgestellt wird.

Diese Abfrage gibt Systemanwendungsinformationen zurück, wenn die angegebene Anwendungs-ID für eine Systemanwendung steht. Die Ergebnisse umfassen bereitgestellte Anwendungen mit den Status „Aktiv“, „Aktiviert“ und „Herunterladen“. Für diese Abfrage muss der Knotenname einem Knoten im Cluster entsprechen. Die Abfrage führt zu einem Fehler, wenn der angegebene Knotenname auf keinen aktiven Service Fabric-Knoten im Cluster verweist.

Anforderung

Methode Anforderungs-URI
GET /Nodes/{nodeName}/$/GetApplications/{applicationId}?api-version=6.1&timeout={timeout}&IncludeHealthState={IncludeHealthState}

Parameter

Name type Erforderlich Standort
nodeName Zeichenfolge Ja Pfad
applicationId Zeichenfolge Ja Pfad
api-version Zeichenfolge Ja Abfrage
timeout ganze Zahl (int64) Nein Abfrage
IncludeHealthState boolean Nein Abfrage

nodeName

Typ: Zeichenfolge
Erforderlich: Ja

Der Name des Knotens.

applicationId

Typ: Zeichenfolge
Erforderlich: Ja

Die Identität (ID) der Anwendung. Dies ist üblicherweise der vollständige Name der Anwendung ohne das URI-Schema „fabric:“. Ab Version 6.0 wird für hierarchische Namen das Zeichen „~“ als Trennzeichen verwendet. Hat eine Anwendung beispielsweise den Namen „fabric://meineapp/app1“, hat die Anwendungsidentität in 6.0 und höher den Wert „meineapp~app1“ und in früheren Versionen den Wert „meineapp/app1“.

api-version

Typ: Zeichenfolge
Erforderlich: Ja
Standard:

Die Version der API. Dieser Parameter ist erforderlich, und sein Wert muss "6.1" sein.

Die Service Fabric-REST-API-Version basiert auf der Laufzeitversion, in der die API eingeführt oder geändert wurde. Die Service Fabric-Runtime unterstützt mehrere Versionen der API. Dies 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 Runtime jede Version, die höher als die neueste unterstützte Version bis zur aktuellen Version der Runtime ist. Wenn also die neueste API-Version 6.0 ist, aber die Runtime 6.1 ist, akzeptiert die Runtime Version 6.1 für diese API, um das Schreiben der Clients zu erleichtern. Das Verhalten der API entspricht jedoch der dokumentierten Version 6.0.

timeout

Typ: integer (int64)
Erforderlich: Nein
Standard:
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

Der Servertimeout für die Ausführung des Vorgangs in Sekunden. Dieser Timeout gibt die Zeitdauer an, die der Client bereit ist, auf den Abschluss des angeforderten Vorgangs zu warten. Der Standardwert für diesen Parameter ist 60 Sekunden.

IncludeHealthState

Typ: boolesch
Erforderlich: Nein
Standard:

Schließen Sie den Integritätszustand einer Entität ein. Wenn dieser Parameter auf „false“ festgelegt oder nicht angegeben ist, wird der Integritätszustand „Unknown“ zurückgegeben. Bei „true“ wird die Abfrage parallel zum Knoten- und Integritätssystemdienst, bevor die Ergebnisse zusammengeführt werden. Daher ist die Abfrage teurer und kann längere Zeit in Anspruch nehmen.

Antworten

HTTP-Statuscode BESCHREIBUNG Antwortschema
200 (OK) Ein erfolgreicher Vorgang gibt 200 status Code und die Informationen zur bereitgestellten Anwendung zurück.
 BereitgestellteApplicationInfo
204 (NoContent) Eine leere Antwort wird zurückgegeben, wenn die angegebene Anwendung nicht auf dem Knoten bereitgestellt wird.
Alle anderen status Codes Die detaillierte Fehlerantwort.
 FabricError

Beispiele

Abrufen einer bestimmten bereitgestellten Anwendung nach Anwendungs-ID und Einschließen des Integritätszustands in das Ergebnis

In diesem Beispiel wird gezeigt, wie Mithilfe eines Anwendungsbezeichners Informationen zu einer Anwendung abgerufen werden, die auf einem angegebenen Knoten bereitgestellt wird. Wenn die Anwendung gefunden wird, werden ihre Informationen mit 200 status Code zurückgegeben. Eine leere Antwort mit status Code 204 wird zurückgegeben, wenn die angegebene Anwendung nicht auf dem Knoten bereitgestellt wird.

Anforderung

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

Antwort 200

Text
{
  "Id": "samples~CalculatorApp",
  "Name": "fabric:/samples/CalculatorApp",
  "TypeName": "CalculatorApp",
  "TypeVersion": "1.0.0",
  "Status": "Active",
  "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\work",
  "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\log",
  "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\temp",
  "HealthState": "Ok"
}

Antwort 204

Text

Der Antworttext ist leer.