Freigeben über

Abrufen der Anwendungsinformationsliste

  • Artikel

Ruft die Liste der Anwendungen ab, die in dem Service Fabric-Cluster erstellt wurden und mit den angegebenen Filtern übereinstimmen.

Ruft die Informationen zu den Anwendungen ab, die im Service Fabric-Cluster erstellt wurden oder gerade erstellt werden und mit den angegebenen Filtern übereinstimmen. Die Antwort enthält den Namen, den Typ, den Status, die Parameter und weitere Details über die Anwendung. Wenn die Anwendungen nicht auf eine Seite passen, werden sowohl eine Seite mit Ergebnissen als auch ein Fortsetzungstoken zurückgegeben, über das zur nächsten Seite gewechselt werden kann. Die Filter ApplicationTypeName und ApplicationDefinitionKindFilter können nicht gleichzeitig angegeben werden.

Anforderung

Methode Anforderungs-URI
GET /Applications?api-version=6.1&ApplicationDefinitionKindFilter={ApplicationDefinitionKindFilter}&ApplicationTypeName={ApplicationTypeName}&ExcludeApplicationParameters={ExcludeApplicationParameters}&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout}

Parameter

Name type Erforderlich Standort
api-version Zeichenfolge Ja Abfrage
ApplicationDefinitionKindFilter integer Nein Abfrage
ApplicationTypeName Zeichenfolge Nein Abfrage
ExcludeApplicationParameters boolean Nein Abfrage
ContinuationToken Zeichenfolge Nein Abfrage
MaxResults ganze Zahl (int64) Nein Abfrage
timeout ganze Zahl (int64) Nein Abfrage

api-version

Typ: Zeichenfolge
Erforderlich: Ja
Standard:

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

Die Rest-API-Version von Service Fabric 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 vereinfachen. Das Verhalten der API entspricht jedoch der dokumentierten Version 6.0.

ApplicationDefinitionKindFilter

Typ: integer
Erforderlich: Nein
Standard:

Wird zum Filtern nach ApplicationDefinitionKind verwendet, um eine Service Fabric-Anwendung zu definieren.

  • Standard: Standardwert, der dieselbe Funktion wie die Auswahl von "Alle" ausführt. Der Wert ist "0".
  • Alle: Filter, der eingaben mit einem beliebigen ApplicationDefinitionKind-Wert übereinstimmt. Der Wert ist gleich „65535“.
  • ServiceFabricApplicationDescription: Filter, der eingaben mit dem ApplicationDefinitionKind-Wert ServiceFabricApplicationDescription übereinstimmt. Der Wert ist "1".
  • Compose: Filter, der die Eingabe mit dem ApplicationDefinitionKind-Wert Compose abgleicht. Der Wert ist "2".

ApplicationTypeName

Typ: Zeichenfolge
Erforderlich: Nein

Der Anwendungstypname, der zum Filtern der Anwendungen verwendet wird, die abgefragt werden sollen. Dieser Wert darf nicht die Version des Anwendungstyps enthalten.

ExcludeApplicationParameters

Typ: boolean
Erforderlich: Nein
Standard:

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

ContinuationToken

Typ: Zeichenfolge
Erforderlich: Nein

Der Parameter „continuation-token“ (Fortsetzungstoken) wird dazu verwendet, den nächsten Satz von Ergebnissen abzurufen. Ein Fortsetzungstoken mit einem nicht leeren Wert wird in die Antwort der API eingefügt, wenn die Ergebnisse aus dem System nicht in eine einzige Antwort passen. Wird dieser Wert an den nächsten API-Aufruf übergeben, gibt die API den nächsten Satz von Ergebnissen zurück. Gibt es keine weiteren Ergebnisse, enthält das Fortsetzungstoken keinen Wert. Der Wert dieses Parameters darf nicht als URL codiert sein.

MaxResults

Typ: integer (int64)
Erforderlich: Nein
Standard:
InklusiveMinimum: 0

Die maximale Anzahl von Ergebnissen, die als Teil der seitenweisen Abfragen zurückgegeben werden sollen. Dieser Parameter definiert die obere Grenze für die Anzahl von zurückgegebenen Ergebnissen. Es können weniger Ergebnisse zurückgegeben werden, als dieser maximalen Anzahl entspricht. Dies ist der Fall, wenn die Ergebnisse wegen der Größenbeschränkungen, die für Meldungen in der Konfiguration definiert sind, nicht in die jeweilige Meldung passen. Ist dieser Parameter gleich null oder nicht angegeben, enthält die seitenweise Abfrage so viele Ergebnisse, wie in die Rückgabemeldung passen.

timeout

Typ: integer (int64)
Erforderlich: Nein
Standard:
InclusiveMaximum: 4294967295
InklusiveMinimum: 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) Liste der im Cluster erstellten Anwendungen.
 PagedApplicationInfoList
Alle anderen status Codes Die detaillierte Fehlerantwort.
 FabricError

Beispiele

Begrenzen der maximalen Ergebnisse

In diesem Beispiel wird gezeigt, wie Sie Informationen zu Anwendungen im Cluster abrufen. Die Anzahl der Ergebnisse auf einer Seite ist mit dem MaxResult-Parameter auf maximal zwei beschränkt.

Anforderung

GET http://localhost:19080/Applications?api-version=6.1&MaxResults=2

Antwort 200

Text
{
  "ContinuationToken": "fabric:/samples/PQueueApp1",
  "Items": [
    {
      "Id": "samples~CalculatorApp",
      "Name": "fabric:/samples/CalculatorApp",
      "TypeName": "CalculatorApp",
      "TypeVersion": "1.0",
      "Status": "Ready",
      "Parameters": [],
      "HealthState": "Ok",
      "ApplicationDefinitionKind": "ServiceFabricApplicationDescription"
    },
    {
      "Id": "samples~PQueueApp1",
      "Name": "fabric:/samples/PQueueApp1",
      "TypeName": "PersistentQueueApp",
      "TypeVersion": "1.0",
      "Status": "Ready",
      "Parameters": [],
      "HealthState": "Ok",
      "ApplicationDefinitionKind": "ServiceFabricApplicationDescription"
    }
  ]
}

Seite mit Fortsetzungstoken

In diesem Beispiel wird gezeigt, wie Sie die Informationen zu Anwendungen im Cluster mithilfe des Parameters ContinuationToken durchlaufen. Der Wert dieses Parameters wird aus der vorherigen Abfrage bereitgestellt, in diesem Fall im oben gezeigten Beispiel. Die Antwort enthält das verbleibende Ergebnis und ein leeres ContinuationToken. Das leere ContinuationToken gibt an, dass keine zusätzlichen Ergebnisse verfügbar sind.

Anforderung

GET http://localhost:19080/Applications?api-version=6.1&ContinuationToken=fabric:/samples/PQueueApp1&MaxResults=2

Antwort 200

Text
{
  "ContinuationToken": "",
  "Items": [
    {
      "Id": "samples~VQueueApp1",
      "Name": "fabric:/samples/VQueueApp1",
      "TypeName": "VolatileQueueApp",
      "TypeVersion": "1.0",
      "Status": "Ready",
      "Parameters": [],
      "HealthState": "Ok",
      "ApplicationDefinitionKind": "ServiceFabricApplicationDescription"
    }
  ]
}