Abrufen der Anwendungstyp-Infoliste

Ruft die Liste der Anwendungstypen im Service Fabric-Cluster ab.

Gibt die Informationen über die Anwendungstypen zurück, die im Service Fabric-Cluster bereitgestellt oder zum Bereitstellen vorbereitet werden. Jede Version eines Anwendungstyps wird als ein Anwendungstyp zurückgegeben. Die Antwort enthält den Namen, die Version, den Status und weitere Details über den Anwendungstyp. Dies ist eine seitenweise Abfrage, d. h., wenn nicht alle Anwendungstypen 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. Wenn beispielsweise zehn Anwendungstypen vorhanden sind, aber auf eine Seite nur die ersten drei Anwendungstypen passen, oder die maximale Anzahl von Ergebnissen auf „3“ festgelegt ist, werden drei Ergebnisse zurückgegeben. Wenn Sie auf den Rest der Ergebnisse zugreifen möchten, rufen Sie die anschließenden Seiten ab, indem Sie in der nächsten Abfrage das zurückgegebene Fortsetzungstoken verwenden. Es wird ein leeres Fortsetzungstoken zurückgegeben, wenn keine anschließenden Seiten vorhanden sind.

Anforderung

Methode	Anforderungs-URI
GET	/ApplicationTypes?api-version=6.0&ApplicationTypeDefinitionKindFilter={ApplicationTypeDefinitionKindFilter}&ExcludeApplicationParameters={ExcludeApplicationParameters}&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout}

Parameter

Name	type	Erforderlich	Standort
api-version	Zeichenfolge	Ja	Abfrage
ApplicationTypeDefinitionKindFilter	integer	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.0" 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.

---

ApplicationTypeDefinitionKindFilter

Typ: integer
Erforderlich: Nein
Standard:

Wird zum Filtern nach ApplicationTypeDefinitionKind verwendet, um einen Service Fabric-Anwendungstyp zu definieren.

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

---

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 Anwendungstypen im Cluster.	PagedApplicationTypeInfoList
Alle anderen status Codes	Die detaillierte Fehlerantwort.	FabricError

Beispiele

Begrenzen der maximalen Ergebnisse

In diesem Beispiel wird gezeigt, wie Sie Informationen zu Anwendungstypen abrufen, die im Cluster bereitgestellt oder bereitgestellt werden. Die Anzahl der Ergebnisse auf einer Seite ist mit dem MaxResult-Parameter auf maximal fünf beschränkt.

Anforderung

GET http://localhost:19080/ApplicationTypes?api-version=6.0&MaxResults=5

Antwort 200

Text

{
  "ContinuationToken": "PersistentQueueApp+2.0",
  "Items": [
    {
      "Name": "CalculatorApp",
      "Version": "1.0",
      "DefaultParameterList": [
        {
          "Key": "ServiceInstanceCount",
          "Value": "3"
        }
      ],
      "Status": "Available"
    },
    {
      "Name": "CalculatorApp",
      "Version": "2.0",
      "DefaultParameterList": [
        {
          "Key": "ServiceInstanceCount",
          "Value": "3"
        }
      ],
      "Status": "Available"
    },
    {
      "Name": "GatewayApp",
      "Version": "1.0",
      "DefaultParameterList": [
        {
          "Key": "GatewayPort",
          "Value": "8505"
        },
        {
          "Key": "ServiceInstanceCount",
          "Value": "1000"
        }
      ],
      "Status": "Available"
    },
    {
      "Name": "PersistentQueueApp",
      "Version": "1.0",
      "DefaultParameterList": [
        {
          "Key": "MinReplicaSetSize",
          "Value": "2"
        },
        {
          "Key": "TargetReplicaSetSize",
          "Value": "3"
        }
      ],
      "Status": "Available"
    },
    {
      "Name": "PersistentQueueApp",
      "Version": "2.0",
      "DefaultParameterList": [
        {
          "Key": "MinReplicaSetSize",
          "Value": "2"
        },
        {
          "Key": "TargetReplicaSetSize",
          "Value": "3"
        }
      ],
      "Status": "Available"
    }
  ]
}

Seite mit Fortsetzungstoken

In diesem Beispiel wird gezeigt, wie Sie die Informationen zu Anwendungstypen, die im Cluster bereitgestellt oder bereitgestellt werden, 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 die verbleibenden beiden Ergebnisse und ein leeres ContinuationToken. Das leere ContinuationToken gibt an, dass keine zusätzlichen Ergebnisse verfügbar sind.

Anforderung

GET http://localhost:19080/ApplicationTypes?api-version=6.0&ContinuationToken=PersistentQueueApp+2.0&MaxResults=5

Antwort 200

Text

{
  "ContinuationToken": "",
  "Items": [
    {
      "Name": "VolatileQueueApp",
      "Version": "1.0",
      "DefaultParameterList": [
        {
          "Key": "MinReplicaSetSize",
          "Value": "2"
        },
        {
          "Key": "TargetReplicaSetSize",
          "Value": "3"
        }
      ],
      "Status": "Available"
    },
    {
      "Name": "VolatileQueueApp",
      "Version": "2.0",
      "DefaultParameterList": [
        {
          "Key": "MinReplicaSetSize",
          "Value": "2"
        },
        {
          "Key": "TargetReplicaSetSize",
          "Value": "3"
        }
      ],
      "Status": "Available"
    }
  ]
}

Ausschließen von Anwendungsparametern aus dem Ergebnis

In diesem Beispiel wird gezeigt, wie Sie den Anwendungsparameter im Ergebnis ausschließen, wenn Sie informationen zu Anwendungstypen abrufen, die im Cluster bereitgestellt oder bereitgestellt werden.

Anforderung

GET http://localhost:19080/ApplicationTypes?api-version=6.0&ExcludeApplicationParameters=True

Antwort 200

Text

{
  "ContinuationToken": "",
  "Items": [
    {
      "Name": "CalculatorApp",
      "Version": "1.0",
      "DefaultParameterList": [],
      "Status": "Available"
    },
    {
      "Name": "CalculatorApp",
      "Version": "2.0",
      "DefaultParameterList": [],
      "Status": "Available"
    },
    {
      "Name": "GatewayApp",
      "Version": "1.0",
      "DefaultParameterList": [],
      "Status": "Available"
    },
    {
      "Name": "PersistentQueueApp",
      "Version": "1.0",
      "DefaultParameterList": [],
      "Status": "Available"
    },
    {
      "Name": "PersistentQueueApp",
      "Version": "2.0",
      "DefaultParameterList": [],
      "Status": "Available"
    },
    {
      "Name": "VolatileQueueApp",
      "Version": "1.0",
      "DefaultParameterList": [],
      "Status": "Available"
    },
    {
      "Name": "VolatileQueueApp",
      "Version": "2.0",
      "DefaultParameterList": [],
      "Status": "Available"
    }
  ]
}