Partitiestatus ophalen met behulp van beleid
Hiermee wordt de status van de opgegeven Service Fabric-partitie opgehaald met behulp van het opgegeven statusbeleid.
Hiermee haalt u de statusgegevens van de opgegeven partitie 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 toepassingsstatusbeleid dat is gedefinieerd in het toepassingsmanifest, of het standaardstatusbeleid, als er geen beleid is gedefinieerd in het manifest. Gebruik EventsHealthStateFilter om de verzameling statusgebeurtenissen te filteren die op de partitie zijn gerapporteerd op basis van de status. Gebruik ReplicasHealthStateFilter om de verzameling ReplicaHealthState-objecten op de partitie te filteren. Gebruik ApplicationHealthPolicy in de POST-hoofdtekst om het statusbeleid te overschrijven dat wordt gebruikt om de status te evalueren. Als u een partitie opgeeft die niet bestaat in het statusarchief, retourneert deze aanvraag een fout.
Aanvraag
| Methode | Aanvraag-URI |
|---|---|
| POST | /Partitions/{partitionId}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&ReplicasHealthStateFilter={ReplicasHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&timeout={timeout} |
Parameters
| Naam | Type | Vereist | Locatie |
|---|---|---|---|
partitionId |
tekenreeks (uuid) | Ja | Pad |
api-version |
tekenreeks | Ja | Query’s uitvoeren |
EventsHealthStateFilter |
geheel getal | Nee | Query’s uitvoeren |
ReplicasHealthStateFilter |
geheel getal | Nee | Query’s uitvoeren |
ExcludeHealthStatistics |
booleaans | No | Query’s uitvoeren |
timeout |
geheel getal (int64) | Nee | Query’s uitvoeren |
ApplicationHealthPolicy |
ApplicationHealthPolicy | Nee | Hoofdtekst |
partitionId
Type: tekenreeks (uuid)
Vereist: Ja
De identiteit van de partitie.
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.
ReplicasHealthStateFilter
Type: geheel getal
Vereist: Nee
Standaardinstelling: 0
Hiermee kunt u de verzameling ReplicaHealthState-objecten op de partitie filteren. De waarde kan worden verkregen van leden of bitsgewijze bewerkingen op leden van HealthStateFilter. Alleen replica's die overeenkomen met het filter worden geretourneerd. Alle replica's 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 alle gebeurtenissen met de HealthState-waarde OK (2) en Waarschuwing (4) geretourneerd. De mogelijke waarden voor deze parameter omvatten een geheel getal van een van de volgende statussen.
- 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 statusinformatie over de opgegeven partitie. |
PartitionHealth |
| Alle andere statuscodes | Het gedetailleerde foutantwoord. |
FabricError |