Clusterstatus ophalen met behulp van beleid
Hiermee haalt u de status van een Service Fabric-cluster op met behulp van het opgegeven beleid.
Gebruik EventsHealthStateFilter om de verzameling statusgebeurtenissen te filteren die op het cluster zijn gerapporteerd op basis van de status. Gebruik op dezelfde manier NodesHealthStateFilter en ApplicationsHealthStateFilter om de verzameling knooppunten en toepassingen te filteren die worden geretourneerd op basis van hun geaggregeerde status. Gebruik ClusterHealthPolicies om het statusbeleid te overschrijven dat wordt gebruikt om de status te evalueren.
Aanvraag
| Methode | Aanvraag-URI |
|---|---|
| POST | /$/GetClusterHealth?api-version=6.0&NodesHealthStateFilter={NodesHealthStateFilter}&ApplicationsHealthStateFilter={ApplicationsHealthStateFilter}&EventsHealthStateFilter={EventsHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&IncludeSystemApplicationHealthStatistics={IncludeSystemApplicationHealthStatistics}&timeout={timeout} |
Parameters
| Naam | Type | Vereist | Locatie |
|---|---|---|---|
api-version |
tekenreeks | Ja | Query’s uitvoeren |
NodesHealthStateFilter |
geheel getal | Nee | Query’s uitvoeren |
ApplicationsHealthStateFilter |
geheel getal | Nee | Query’s uitvoeren |
EventsHealthStateFilter |
geheel getal | Nee | Query’s uitvoeren |
ExcludeHealthStatistics |
booleaans | No | Query’s uitvoeren |
IncludeSystemApplicationHealthStatistics |
booleaans | No | Query’s uitvoeren |
timeout |
geheel getal (int64) | Nee | Query’s uitvoeren |
ClusterHealthPolicies |
ClusterHealthPolicies | Nee | Hoofdtekst |
api-version
Type: tekenreeks
Vereist: Ja
Standaardinstelling: 6.0
De versie van de API. Deze parameter is vereist en de waarde moet '6.0' zijn.
Service Fabric REST API-versie is gebaseerd op de runtimeversie waarin de API is geïntroduceerd of gewijzigd. Service Fabric-runtime ondersteunt meer dan één versie van de API. Dit is de nieuwste ondersteunde versie van de API. Als een lagere API-versie wordt doorgegeven, kan het geretourneerde antwoord afwijken van het antwoord dat in deze specificatie wordt beschreven.
Daarnaast accepteert de runtime elke versie die hoger is dan de meest recente ondersteunde versie tot de huidige versie van de runtime. Dus als de nieuwste API-versie 6.0 is, maar als de runtime 6.1 is, accepteert de runtime versie 6.1 voor die API om het eenvoudiger te maken om de clients te schrijven. Het gedrag van de API is echter volgens de gedocumenteerde versie 6.0.
NodesHealthStateFilter
Type: geheel getal
Vereist: Nee
Standaardinstelling: 0
Hiermee kunt u filteren van de statusobjecten van het knooppunt die worden geretourneerd in het resultaat van de clusterstatusquery op basis van hun status. De mogelijke waarden voor deze parameter omvatten een geheel getal van een van de volgende statussen. Alleen knooppunten die overeenkomen met het filter worden geretourneerd. Alle knooppunten worden gebruikt om de geaggregeerde status te evalueren.
Als dit niet is opgegeven, worden alle vermeldingen geretourneerd.
De statuswaarden zijn opsomming op basis van vlaggen, dus de waarde kan een combinatie zijn van deze waarden die zijn verkregen met behulp van de bitsgewijze 'OR'-operator.
Als de opgegeven waarde bijvoorbeeld 6 is, wordt de status van knooppunten met de HealthState-waarde OK (2) en Waarschuwing (4) geretourneerd.
- Standaardwaarde: standaardwaarde. Komt overeen met elke HealthState. De waarde is nul.
- Geen: filter dat niet overeenkomt met een HealthState-waarde. Wordt gebruikt om geen resultaten te retourneren voor een bepaalde verzameling statussen. De waarde is 1.
- Ok: filter dat overeenkomt met invoer met healthState-waarde OK. De waarde is 2.
- Waarschuwing: filter dat overeenkomt met invoer met HealthState-waarde Waarschuwing. De waarde is 4.
- Fout: filter dat overeenkomt met invoer met healthstate-waarde Fout. De waarde is 8.
- Alle: filter dat overeenkomt met invoer met een HealthState-waarde. De waarde is 65535.
ApplicationsHealthStateFilter
Type: geheel getal
Vereist: Nee
Standaardinstelling: 0
Hiermee kunt u filteren van de statusobjecten van de toepassing die worden geretourneerd in het resultaat van de clusterstatusquery op basis van hun status.
De mogelijke waarden voor deze parameter zijn een geheel getal dat is verkregen van leden of bitsgewijze bewerkingen op leden van de opsomming HealthStateFilter. Alleen toepassingen die overeenkomen met het filter worden geretourneerd.
Alle toepassingen worden gebruikt om de geaggregeerde status te evalueren. Als dit niet is opgegeven, worden alle vermeldingen geretourneerd.
De statuswaarden zijn opsomming op basis van vlaggen, dus de waarde kan een combinatie zijn van deze waarden die zijn verkregen met behulp van de bitsgewijze 'OR'-operator.
Als de opgegeven waarde bijvoorbeeld 6 is, worden de status van toepassingen met de HealthState-waarde OK (2) en Waarschuwing (4) geretourneerd.
- Standaardwaarde: standaardwaarde. Komt overeen met elke HealthState. De waarde is nul.
- Geen: filter dat niet overeenkomt met een HealthState-waarde. Wordt gebruikt om geen resultaten te retourneren voor een bepaalde verzameling statussen. De waarde is 1.
- Ok: filter dat overeenkomt met invoer met healthState-waarde OK. De waarde is 2.
- Waarschuwing: filter dat overeenkomt met invoer met HealthState-waarde Waarschuwing. De waarde is 4.
- Fout: filter dat overeenkomt met invoer met healthstate-waarde Fout. De waarde is 8.
- Alle: filter dat overeenkomt met invoer met een HealthState-waarde. De waarde is 65535.
EventsHealthStateFilter
Type: geheel getal
Vereist: Nee
Standaardinstelling: 0
Hiermee kunt u de verzameling HealthEvent-objecten filteren die worden geretourneerd op basis van de status.
De mogelijke waarden voor deze parameter omvatten een geheel getal van een van de volgende statussen.
Alleen gebeurtenissen die overeenkomen met het filter worden geretourneerd. Alle gebeurtenissen worden gebruikt om de geaggregeerde status te evalueren.
Als dit niet is opgegeven, worden alle vermeldingen geretourneerd. De statuswaarden zijn op vlaggen gebaseerde opsomming, dus de waarde kan een combinatie van deze waarden zijn, verkregen met behulp van de bitwise operator 'OR'. Als de opgegeven waarde bijvoorbeeld 6 is, worden alle gebeurtenissen met de HealthState-waarde OK (2) en Waarschuwing (4) geretourneerd.
- Standaard - Standaardwaarde. Komt overeen met elke HealthState. De waarde is nul.
- Geen: filter dat niet overeenkomt met een HealthState-waarde. Wordt gebruikt om geen resultaten te retourneren voor een bepaalde verzameling statussen. De waarde is 1.
- Ok: filter dat overeenkomt met invoer met HealthState-waarde Ok. De waarde is 2.
- Waarschuwing: filter dat overeenkomt met invoer met HealthState-waarde Waarschuwing. De waarde is 4.
- Fout: filter dat overeenkomt met invoer met HealthState-waarde Fout. De waarde is 8.
- Alle: filter dat invoer overeenkomt met een HealthState-waarde. De waarde is 65535.
ExcludeHealthStatistics
Type: Booleaanse waarde
Vereist: Nee
Standaardinstelling: false
Geeft aan of de statusstatistieken moeten worden geretourneerd als onderdeel van het queryresultaat. Standaard onwaar.
De statistieken tonen het aantal onderliggende entiteiten met de status Ok, Waarschuwing en Fout.
IncludeSystemApplicationHealthStatistics
Type: Booleaanse waarde
Vereist: Nee
Standaardinstelling: false
Geeft aan of de statusstatistieken de statusstatistieken van de infrastructuur:/systeemtoepassing moeten bevatten. Standaard onwaar.
Als IncludeSystemApplicationHealthStatistics is ingesteld op true, bevatten de statusstatistieken de entiteiten die deel uitmaken van de toepassing fabric:/System.
Anders bevat het queryresultaat alleen statusstatistieken voor gebruikerstoepassingen.
De statusstatistieken moeten worden opgenomen in het queryresultaat om deze parameter toe te passen.
timeout
Type: geheel getal (int64)
Vereist: Nee
Standaardinstelling: 60
InclusiefMaximum: 4294967295
InclusiefMinimum: 1
De servertime-out voor het uitvoeren van de bewerking in seconden. Deze time-out geeft de tijdsduur aan die de client bereid is te wachten tot de aangevraagde bewerking is voltooid. De standaardwaarde voor deze parameter is 60 seconden.
ClusterHealthPolicies
Type: ClusterHealthPolicies
Vereist: Nee
Hierin worden de statusbeleidsregels beschreven die worden gebruikt om de clusterstatus te evalueren.
Als deze niet aanwezig is, gebruikt de statusevaluatie het clusterstatusbeleid dat is gedefinieerd in het clustermanifest of het standaardstatusbeleid voor het cluster.
Standaard wordt elke toepassing geëvalueerd met behulp van het specifieke toepassingsstatusbeleid, gedefinieerd in het toepassingsmanifest, of het standaardstatusbeleid, als er geen beleid is gedefinieerd in het manifest.
Als de toepassingsstatusbeleidstoewijzing is opgegeven en deze een vermelding voor een toepassing heeft, wordt het opgegeven toepassingsstatusbeleid gebruikt om de toepassingsstatus te evalueren.
Antwoorden
| HTTP-statuscode | Beschrijving | Antwoordschema |
|---|---|---|
| 200 (OK) | Een geslaagde bewerking retourneert de statuscode 200 en de aangevraagde statusgegevens van het cluster. |
ClusterHealth |
| Alle andere statuscodes | Het gedetailleerde foutantwoord. |
FabricError |