Status van geïmplementeerde toepassing ophalen met behulp van beleid
Hiermee haalt u de informatie op over de status van een toepassing die is geïmplementeerd op een Service Fabric-knooppunt. met behulp van het opgegeven beleid.
Hiermee haalt u de informatie op over de status van een toepassing die is geïmplementeerd op een Service Fabric-knooppunt met behulp van het opgegeven beleid. Gebruik EventsHealthStateFilter om eventueel te filteren op de verzameling HealthEvent-objecten die zijn gerapporteerd in de geïmplementeerde toepassing op basis van de status. Gebruik DeployedServicePackagesHealthStateFilter om optioneel te filteren op DeployedServicePackageHealth-onderliggende items op basis van de status. Gebruik ApplicationHealthPolicy om eventueel het statusbeleid te overschrijven dat wordt gebruikt om de status te evalueren. Deze API maakt alleen gebruik van het veld ConsiderWarningAsError van de ApplicationHealthPolicy. De rest van de velden worden genegeerd tijdens het evalueren van de status van de geïmplementeerde toepassing.
Aanvraag
| Methode | Aanvraag-URI |
|---|---|
| POST | /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&DeployedServicePackagesHealthStateFilter={DeployedServicePackagesHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&timeout={timeout} |
Parameters
| Naam | Type | Vereist | Locatie |
|---|---|---|---|
nodeName |
tekenreeks | Ja | Pad |
applicationId |
tekenreeks | Ja | Pad |
api-version |
tekenreeks | Ja | Query’s uitvoeren |
EventsHealthStateFilter |
geheel getal | Nee | Query’s uitvoeren |
DeployedServicePackagesHealthStateFilter |
geheel getal | Nee | Query’s uitvoeren |
ExcludeHealthStatistics |
booleaans | No | Query’s uitvoeren |
timeout |
geheel getal (int64) | Nee | Query’s uitvoeren |
ApplicationHealthPolicy |
ApplicationHealthPolicy | Nee | Hoofdtekst |
nodeName
Type: tekenreeks
Vereist: Ja
De naam van het knooppunt.
applicationId
Type: tekenreeks
Vereist: Ja
De identiteit van de toepassing. Dit is doorgaans de volledige naam van de toepassing zonder het URI-schema 'fabric:'.
Vanaf versie 6.0 worden hiërarchische namen gescheiden door het teken '~'.
Als de toepassingsnaam bijvoorbeeld 'fabric:/myapp/app1' is, is de toepassingsidentiteit 'myapp~app1' in 6.0+ en 'myapp/app1' 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 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.
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 opsomming op basis van vlaggen, dus de waarde kan een combinatie van deze waarden zijn, verkregen met behulp van de bitsgewijze operator 'OR'. Als de opgegeven waarde bijvoorbeeld 6 is, worden alle gebeurtenissen 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.
DeployedServicePackagesHealthStateFilter
Type: geheel getal
Vereist: Nee
Standaardinstelling: 0
Hiermee kunt u filteren van de statusobjecten van het geïmplementeerde servicepakket die worden geretourneerd in het resultaat van de geïmplementeerde toepassingsstatusquery op basis van hun status.
De mogelijke waarden voor deze parameter omvatten een geheel getal van een van de volgende statussen.
Alleen geïmplementeerde servicepakketten die overeenkomen met het filter worden geretourneerd. Alle geïmplementeerde servicepakketten worden gebruikt om de geaggregeerde status van de geïmplementeerde toepassing 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 van deze waarden zijn, verkregen met behulp van de bitsgewijze operator 'OR'.
Als de opgegeven waarde bijvoorbeeld 6 is, worden de statusstatus van servicepakketten 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.
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
InclusiveMaximum: 4294967295
InclusiefMinimum: 1
De time-out van de server voor het uitvoeren van de bewerking in seconden. Deze time-out geeft de tijdsduur aan die de client bereid is te wachten totdat de aangevraagde bewerking is voltooid. De standaardwaarde voor deze parameter is 60 seconden.
ApplicationHealthPolicy
Type: ApplicationHealthPolicy
Vereist: Nee
Beschrijft het statusbeleid dat wordt gebruikt om de status van een toepassing of een van de onderliggende items te evalueren.
Als deze niet aanwezig is, gebruikt de statusevaluatie het statusbeleid uit het toepassingsmanifest of het standaardstatusbeleid.
Antwoorden
| HTTP-statuscode | Beschrijving | Antwoordschema |
|---|---|---|
| 200 (OK) | Een geslaagde bewerking retourneert de statuscode 200 en de statusgegevens van de geïmplementeerde toepassing. |
DeployedApplicationHealth |
| Alle andere statuscodes | Het gedetailleerde foutantwoord. |
FabricError |