Abrufen der Clusterkonfiguration
Ruft die Konfiguration eines eigenständigen Service Fabric-Clusters ab.
Die Clusterkonfiguration enthält Eigenschaften des Clusters wie z.B. die unterschiedlichen Knotentypen im Cluster, Sicherheitskonfigurationen, Fehler- und Upgradedomänentopologien usw.
Anforderung
| Methode | Anforderungs-URI |
|---|---|
| GET | /$/GetClusterConfiguration?api-version=6.0&ConfigurationApiVersion={ConfigurationApiVersion}&timeout={timeout} |
Parameter
| Name | type | Erforderlich | Standort |
|---|---|---|---|
api-version |
Zeichenfolge | Ja | Abfrage |
ConfigurationApiVersion |
Zeichenfolge | Ja | 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 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.
ConfigurationApiVersion
Typ: Zeichenfolge
Erforderlich: Ja
Die API-Version der JSON-Konfiguration des eigenständigen Clusters.
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) | Bei einem erfolgreichen Vorgang werden 200 status Code und die angeforderten Clusterkonfigurationsinformationen zurückgegeben. |
ClusterKonfiguration |
| Alle anderen status Codes | Die detaillierte Fehlerantwort. |
FabricError |