Abrufen der Integrität des bereitgestellten Dienstpakets mithilfe der Richtlinie
Ruft die Informationen zur Integrität des Dienstpakets für eine bestimmte Anwendung ab, die auf einem Service Fabric-Knoten mithilfe der angegebenen Richtlinie bereitgestellt wird.
Ruft die Informationen über die Integrität eines Dienstpakets für eine bestimmte Anwendung ab, die für einen Service Fabric-Knoten bereitgestellt wird. mithilfe der angegebenen Richtlinie. Verwenden Sie EventsHealthStateFilter, um optional basierend auf dem Integritätszustand nach der Sammlung von HealthEvent-Objekten zu filtern, die für das bereitgestellte Dienstpaket gemeldet wurden. Verwenden Sie ApplicationHealthPolicy, um optional die Integritätsrichtlinien zu überschreiben, die zum Auswerten der Integrität verwendet werden. Diese API verwendet nur das Feld "ConsiderWarningAsError" des ApplicationHealthPolicy-Felds. Die restlichen Felder werden ignoriert, während die Integrität des bereitgestellten Dienstpakets ausgewertet wird.
Anforderung
| Methode | Anforderungs-URI |
|---|---|
| POST | /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&timeout={timeout} |
Parameter
| Name | type | Erforderlich | Standort |
|---|---|---|---|
nodeName |
Zeichenfolge | Ja | Pfad |
applicationId |
Zeichenfolge | Ja | Pfad |
servicePackageName |
Zeichenfolge | Ja | Pfad |
api-version |
Zeichenfolge | Ja | Abfrage |
EventsHealthStateFilter |
integer | Nein | Abfrage |
timeout |
ganze Zahl (int64) | Nein | Abfrage |
ApplicationHealthPolicy |
ApplicationHealthPolicy | Nein | Text |
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“.
servicePackageName
Typ: Zeichenfolge
Erforderlich: Ja
Der Name des Dienstpakets.
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“.
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.
ApplicationHealthPolicy
Typ: ApplicationHealthPolicy
Erforderlich: Nein
Beschreibt die Integritätsrichtlinien, die zum Bewerten der Integrität einer Anwendung oder einer ihrer untergeordneten Elemente verwendet werden.
Falls nicht vorhanden, verwendet die Integritätsauswertung die Integritätsrichtlinie aus dem Anwendungsmanifest oder die Standardintegritätsrichtlinie.
Antworten
| HTTP-Statuscode | BESCHREIBUNG | Antwortschema |
|---|---|---|
| 200 (OK) | Bei einem erfolgreichen Vorgang werden 200 status Code und die Integritätsinformationen des bereitgestellten Dienstpakets für einen bestimmten Knoten und eine bestimmte Anwendung zurückgegeben. |
DeployedServicePackageHealth |
| Alle anderen status Codes | Die detaillierte Fehlerantwort. |
FabricError |