Aufrufen der Infrastrukturabfrage

  • Artikel

Ruft eine schreibgeschützte Abfrage für die angegebene Infrastrukturdienstinstanz auf.

Für Cluster, für die mindestens eine Instanz des Infrastrukturdiensts konfiguriert ist, bietet diese API eine Möglichkeit, infrastrukturspezifische Abfragen an eine bestimmte Instanz des Infrastrukturdiensts zu senden.

Die verfügbaren Befehle und ihre entsprechenden Antwortformate variieren je nach der Infrastruktur, auf der der Cluster ausgeführt wird.

Diese API unterstützt die Service Fabric-Plattform. Sie ist nicht dazu vorgesehen, direkt aus Ihrem Code verwendet zu werden.

Anforderung

Methode Anforderungs-URI
GET /$/InvokeInfrastructureQuery?api-version=6.0&Command={Command}&ServiceId={ServiceId}&timeout={timeout}

Parameter

Name type Erforderlich Standort
api-version Zeichenfolge Ja Abfrage
Command Zeichenfolge Ja Abfrage
ServiceId Zeichenfolge 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 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.

Command

Typ: Zeichenfolge
Erforderlich: Ja

Der Text des Befehls, der aufgerufen werden soll. Der Inhalt des Befehls ist infrastrukturspezifisch.

ServiceId

Typ: Zeichenfolge
Erforderlich: Nein

Die Identität des Infrastrukturdiensts. Dies ist der vollständige Name des Infrastrukturdiensts ohne das URI-Schema „fabric:“. Dieser Parameter ist nur für den Cluster erforderlich, in dem mehrere Instanzen des Infrastrukturdiensts ausgeführt werden.

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) Die Antwort des Infrastrukturdiensts. Das Antwortformat ist ein JSON-Stream.
Der Inhalt der Antwort hängt davon ab, welcher Befehl ausgegeben wurde.
 Zeichenfolge
Alle anderen status Codes Die detaillierte Fehlerantwort.
 FabricError