Abrufen der Informationsliste für bereitgestellte Dienstreplikate

Artikel
07/19/2023

Ruft die Liste der Replikate ab, die auf einem Service Fabric-Knoten bereitgestellt werden.

Ruft die Liste mit den Informationen über die Replikate ab, die auf einem Service Fabric-Knoten bereitgestellt sind. Die Informationen umfassen Partitions-ID, Replikat-ID, Status des Replikats, Name des Diensts, Name des Diensttyps und andere Informationen. Verwenden Sie die Abfrageparameter „PartitionId“ oder „ServiceManifestName“, um Informationen über die bereitgestellte Replikate zurückzugeben, die den angegebenen Werten für diese Parameter entsprechen.

Anforderung

Methode	Anforderungs-URI
GET	`/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetReplicas?api-version=6.0&PartitionId={PartitionId}&ServiceManifestName={ServiceManifestName}&timeout={timeout}`

Parameter

Name	type	Erforderlich	Standort
`nodeName`	Zeichenfolge	Ja	Pfad
`applicationId`	Zeichenfolge	Ja	Pfad
`api-version`	Zeichenfolge	Ja	Abfrage
`PartitionId`	Zeichenfolge (uuid)	Nein	Abfrage
`ServiceManifestName`	Zeichenfolge	Nein	Abfrage
`timeout`	ganze Zahl (int64)	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.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.

`PartitionId`

Typ: string (uuid)
Erforderlich: Nein

Die Identität (ID) der Partition.

`ServiceManifestName`

Typ: Zeichenfolge
Erforderlich: Nein

Der Name eines Dienstmanifests, das als Bestandteil eines Anwendungstyps in einem Service Fabric-Cluster registriert ist.

`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)	Bei einem erfolgreichen Vorgang werden 200 status Code und die Liste der bereitgestellten Dienstreplikateinformationen zurückgegeben.	Array von DeployedServiceReplicaInfo
204 (NoContent)	Eine leere Antwort wird zurückgegeben, wenn die angegebene applicationId auf dem angegebenen Knoten nicht gefunden wird. Eine leere Antwort wird auch zurückgegeben, wenn keine Replikate vorhanden sind, die den angegebenen Filterwerten für die Abfrageparameter PartitionId oder ServiceManifestName entsprechen.
Alle anderen status Codes	Die detaillierte Fehlerantwort.	FabricError

Freigeben über