Abrufen der Anwendungsintegrität
Ruft die Integrität der Service Fabric-Anwendung ab.
Gibt den Integritätsstatus der Service Fabric-Anwendung zurück. In der Antwort wird der Integritätsstatus als „Ok“, „Error“ oder „Warning“ gemeldet. Wird die Entität nicht im Integritätsspeicher gefunden, wird ein Fehler zurückgegeben.
Anforderung
| Methode | Anforderungs-URI |
|---|---|
| GET | /Applications/{applicationId}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&DeployedApplicationsHealthStateFilter={DeployedApplicationsHealthStateFilter}&ServicesHealthStateFilter={ServicesHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&timeout={timeout} |
Parameter
| Name | type | Erforderlich | Standort |
|---|---|---|---|
applicationId |
Zeichenfolge | Ja | Pfad |
api-version |
Zeichenfolge | Ja | Abfrage |
EventsHealthStateFilter |
integer | Nein | Abfrage |
DeployedApplicationsHealthStateFilter |
integer | Nein | Abfrage |
ServicesHealthStateFilter |
integer | Nein | Abfrage |
ExcludeHealthStatistics |
boolean | Nein | Abfrage |
timeout |
ganze Zahl (int64) | Nein | Abfrage |
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 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.
EventsHealthStateFilter
Typ: integer
Erforderlich: Nein
Standard:
Ermöglicht das Filtern der Collection zurückgegebener HealthEvent-Objekte anhand des Integritätsstatus.
Die möglichen Werte für diesen Parameter entsprechen dem jeweiligen ganzzahligen Wert von einem der folgenden Integritätsstatus.
Es werden nur Ereignisse zurückgegeben, die dem Filter entsprechen. Alle Ereignisse werden verwendet, um den aggregierten Integritätsstatus auszuwerten.
Ist kein Filter angegeben, werden alle Einträge zurückgegeben. Ein Statuswert ist eine flagbasierte Enumeration, sodass der Wert eine Kombination der Werte sein kann, die mit dem bitweisen OR-Operator abgerufen werden. Ist der angegebene Wert beispielsweise gleich „6“, werden alle Ereignisse zurückgegeben, für die „HealthState“ den Wert für OK (2) oder Warnung (4) hat.
- Standardwert: Standardwert. Stimmt mit jedem Integritätsstatus (HealthState) überein. Der Wert ist gleich null.
- None: Filter, der keinem HealthState-Wert entspricht. Wird verwendet, um keine Ergebnisse für eine angegebene Statussammlung zurückzugeben. Der Wert ist "1".
- Ok : Filter, der der Eingabe mit dem HealthState-Wert Ok entspricht. Der Wert ist "2".
- Warnung: Filter, der die Eingabe mit dem HealthState-Wert Warning übereinstimmt. Der Wert ist "4".
- Fehler: Filter, der die Eingabe mit dem HealthState-Wert Error abgleicht. Der Wert ist gleich „8“.
- Alle: Filter, der eingaben mit einem beliebigen HealthState-Wert übereinstimmt. Der Wert ist gleich „65535“.
DeployedApplicationsHealthStateFilter
Typ: integer
Erforderlich: Nein
Standard:
Ermöglicht es, die im Ergebnis der Anwendungsintegritätsabfrage zurückgegebenen Integritätsstatusobjekte der bereitgestellten Anwendungen anhand des Integritätsstatus zu filtern.
Die möglichen Werte für diesen Parameter entsprechen dem jeweiligen ganzzahligen Wert von einem der folgenden Integritätsstatus. Es werden nur bereitgestellte Anwendungen zurückgegeben, die dem Filter entsprechen.
Alle bereitgestellten Anwendungen werden verwendet, um den aggregierten Integritätsstatus auszuwerten. Ist kein Filter angegeben, werden alle Einträge zurückgegeben.
Ein Statuswert ist eine flagbasierte Enumeration, sodass der Wert eine Kombination der Werte sein kann, die mit dem bitweisen OR-Operator abgerufen werden.
Ist der angegebene Wert beispielsweise gleich „6“, wird der Integritätsstatus der bereitgestellten Anwendungen zurückgegeben, für die „HealthState“ den Wert für OK (2) oder Warning (4) hat.
- Standardwert: Standardwert. Stimmt mit jedem Integritätsstatus (HealthState) überein. Der Wert ist gleich null.
- None: Filter, der keinem HealthState-Wert entspricht. Wird verwendet, um keine Ergebnisse für eine angegebene Statussammlung zurückzugeben. Der Wert ist "1".
- Ok : Filter, der der Eingabe mit dem HealthState-Wert Ok entspricht. Der Wert ist "2".
- Warnung: Filter, der die Eingabe mit dem HealthState-Wert Warning übereinstimmt. Der Wert ist "4".
- Fehler: Filter, der die Eingabe mit dem HealthState-Wert Error abgleicht. Der Wert ist gleich „8“.
- Alle: Filter, der eingaben mit einem beliebigen HealthState-Wert übereinstimmt. Der Wert ist gleich „65535“.
ServicesHealthStateFilter
Typ: integer
Erforderlich: Nein
Standard:
Ermöglicht es, die Integritätsstatusobjekte der Dienste, die im Ergebnis einer Dienstintegritätsabfrage zurückgegeben werden, anhand des Integritätsstatus zu filtern.
Die möglichen Werte für diesen Parameter entsprechen dem jeweiligen ganzzahligen Wert von einem der folgenden Integritätsstatus.
Es werden nur Dienste zurückgegeben, die dem Filter entsprechen. Alle Dienste werden verwendet, um den aggregierten Integritätsstatus auszuwerten.
Ist kein Filter angegeben, werden alle Einträge zurückgegeben. Ein Statuswert ist eine flagbasierte Enumeration, sodass der Wert eine Kombination der Werte sein kann, die mit dem bitweisen OR-Operator abgerufen werden. Ist der angegebene Wert beispielsweise „6“, wird der Integritätsstatus der Dienste zurückgegeben, für die „HealthState“ den Wert für OK (2) oder Warning (4) hat.
- Standard: Standardwert. Stimmt mit jedem Integritätsstatus (HealthState) überein. Der Wert ist gleich null.
- None: Filter, der keinem HealthState-Wert entspricht. Wird verwendet, um keine Ergebnisse für eine angegebene Statussammlung zurückzugeben. Der Wert ist "1".
- Ok: Filter, der der Eingabe mit dem HealthState-Wert Ok entspricht. Der Wert ist "2".
- Warnung: Filter, der eingaben mit dem HealthState-Wert Warning übereinstimmt. Der Wert ist "4".
- Fehler: Filter, der die Eingabe mit dem HealthState-Wert Error übereinstimmt. Der Wert ist gleich „8“.
- Alle: Filter, der eingaben mit einem beliebigen HealthState-Wert übereinstimmt. Der Wert ist gleich „65535“.
ExcludeHealthStatistics
Typ: boolean
Erforderlich: Nein
Standard:
Gibt an, ob die Integritätsstatistiken als Bestandteil des Abfrageergebnisses zurückgegeben werden sollen. Der Standardwert ist gleich „False“.
Die Statistiken zeigen die Anzahl von untergeordneten Entitäten, die einen der Integritätszustände „Ok“, „Warning“ oder „Error“ aufweisen.
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 angeforderten Anwendungsintegritätsinformationen zurückgegeben. |
ApplicationHealth |
| Alle anderen status Codes | Die detaillierte Fehlerantwort. |
FabricError |