Service health ophalen met behulp van beleid
Hiermee haalt u de status van de opgegeven Service Fabric-service op met behulp van het opgegeven statusbeleid.
Hiermee haalt u de statusgegevens van de opgegeven service op. Als het toepassingsstatusbeleid is opgegeven, wordt dit door de statusevaluatie gebruikt om de geaggregeerde status op te halen. Als het beleid niet is opgegeven, gebruikt de statusevaluatie het statusbeleid van de toepassing dat is gedefinieerd in het toepassingsmanifest, of het standaardstatusbeleid, als er geen beleid is gedefinieerd in het manifest. Gebruik EventsHealthStateFilter om de verzameling statusgebeurtenissen die zijn gerapporteerd op de service te filteren op basis van de status. Gebruik PartitionsHealthStateFilter om de verzameling geretourneerde partities te filteren. Als u een service opgeeft die niet bestaat in het statusarchief, retourneert deze aanvraag een fout.
Aanvraag
| Methode | Aanvraag-URI |
|---|---|
| POST | /Services/{serviceId}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&PartitionsHealthStateFilter={PartitionsHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&timeout={timeout} |
Parameters
| Naam | Type | Vereist | Locatie |
|---|---|---|---|
serviceId |
tekenreeks | Ja | Pad |
api-version |
tekenreeks | Ja | Query’s uitvoeren |
EventsHealthStateFilter |
geheel getal | Nee | Query’s uitvoeren |
PartitionsHealthStateFilter |
geheel getal | Nee | Query’s uitvoeren |
ExcludeHealthStatistics |
booleaans | No | Query’s uitvoeren |
timeout |
geheel getal (int64) | Nee | Query’s uitvoeren |
ApplicationHealthPolicy |
ApplicationHealthPolicy | Nee | Hoofdtekst |
serviceId
Type: tekenreeks
Vereist: Ja
De identiteit van de service. Deze id is doorgaans de volledige naam van de service zonder het URI-schema 'fabric:'.
Vanaf versie 6.0 worden hiërarchische namen gescheiden door het teken '~'.
Als de servicenaam bijvoorbeeld 'fabric:/myapp/app1/svc1' is, is de service-identiteit 'myapp~app1~svc1' in 6.0+ en 'myapp/app1/svc1' in eerdere versies.
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 is gewijzigd. Service Fabric-runtime ondersteunt meer dan één versie van de API. Dit is de meest recente 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.
Bovendien 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 schrijven van de clients gemakkelijker te maken. Het gedrag van de API is echter volgens de gedocumenteerde versie 6.0.
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.
PartitionsHealthStateFilter
Type: geheel getal
Vereist: Nee
Standaardinstelling: 0
Hiermee kunt u filteren op de statusobjecten van partities die worden geretourneerd in het resultaat van de servicestatusquery op basis van hun status.
De mogelijke waarden voor deze parameter omvatten een geheel getal van een van de volgende statussen.
Alleen partities die overeenkomen met het filter worden geretourneerd. Alle partities 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 waarde zijn die is verkregen met behulp van de bitwise 'OR'-operator. Als de opgegeven waarde bijvoorbeeld 6 is, wordt de status van partities met 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.
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.
ApplicationHealthPolicy
Type: ApplicationHealthPolicy
Vereist: Nee
Hierin worden de statusbeleidsregels beschreven die worden gebruikt om de status van een toepassing of een van de onderliggende elementen te evalueren.
Als deze niet aanwezig is, gebruikt de statusevaluatie het statusbeleid van het toepassingsmanifest of het standaardstatusbeleid.
Antwoorden
| HTTP-statuscode | Beschrijving | Antwoordschema |
|---|---|---|
| 200 (OK) | Een geslaagde bewerking retourneert de statuscode 200 en de statusgegevens van de opgegeven service. |
ServiceHealth |
| Alle andere statuscodes | Het gedetailleerde foutantwoord. |
FabricError |