Abrufen von Anwendungsinformationen

  • Artikel

Ruft Informationen zu einer Service Fabric-Anwendung ab.

Gibt die Informationen zu der Anwendung zurück, die im Service Fabric-Cluster erstellt wurde oder gerade erstellt wird und deren Name mit dem übereinstimmt, der als Parameter angegebenen wurde. Die Antwort enthält den Namen, den Typ, den Status, die Parameter und weitere Details über die Anwendung.

Anforderung

Methode Anforderungs-URI
GET /Applications/{applicationId}?api-version=6.0&ExcludeApplicationParameters={ExcludeApplicationParameters}&timeout={timeout}

Parameter

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

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.0" 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.

ExcludeApplicationParameters

Typ: boolesch
Erforderlich: Nein
Standard:

Das Flag, das angibt, ob die Anwendungsparameter aus dem Ergebnis ausgeschlossen werden sollen.

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.

Antworten

HTTP-Statuscode BESCHREIBUNG Antwortschema
200 (OK) Informationen zur Anwendung.
 ApplicationInfo
204 (NoContent) Eine leere Antwort wird zurückgegeben, wenn die angegebene applicationId nicht im Cluster gefunden wird.
Alle anderen status Codes Die detaillierte Fehlerantwort.
 FabricError

Beispiele

Abrufen einer bestimmten Anwendung nach Anwendungs-ID

In diesem Beispiel wird gezeigt, wie Sie Mithilfe des Bezeichners Informationen zu einer Anwendung abrufen. Wenn die Anwendung gefunden wird, werden Informationen dazu mit 200 status Code zurückgegeben. Wenn die Anwendung nicht gefunden wird, wird leerer Inhalt mit 204 status Code zurückgegeben.

Anforderung

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

Antwort 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"
}

Antwort 204

Text

Der Antworttext ist leer.