Ottenere l'integrità della replica usando i criteri
Ottiene l'integrità di una replica del servizio con stato di Service Fabric o di un'istanza del servizio senza stato usando i criteri specificati.
Recupera l'integrità di una replica di un servizio con stato o di un'istanza di un servizio senza stato di Service Fabric. Usare EventsHealthStateFilter per filtrare la raccolta di eventi di stato riportati nel cluster in base allo stato di integrità. Usare ApplicationHealthPolicy per eseguire facoltativamente l'override dei criteri di integrità usati per valutare l'integrità. Questa API usa solo il campo 'ConsiderWarningAsError' dell'applicazioneHealthPolicy. Il resto dei campi viene ignorato durante la valutazione dell'integrità della replica.
Richiesta
Metodo | URI richiesta |
---|---|
POST | /Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&timeout={timeout} |
Parametri
Nome | Tipo | Necessario | Posizione |
---|---|---|---|
partitionId |
string (uuid) | Sì | Percorso |
replicaId |
string | Sì | Percorso |
api-version |
string | Sì | Query |
EventsHealthStateFilter |
numero intero | No | Query |
timeout |
integer (int64) | No | Query |
ApplicationHealthPolicy |
ApplicationHealthPolicy | No | Corpo |
partitionId
Tipo: stringa (uuid)
Obbligatorio: Sì
L'identità della partizione.
replicaId
Tipo: stringa
Obbligatorio: Sì
Identificatore della replica.
api-version
Tipo: stringa
Obbligatorio: Sì
Impostazione predefinita: 6.0
Versione dell'API. Questo parametro è obbligatorio e il relativo valore deve essere '6.0'.
La versione dell'API REST di Service Fabric è basata sulla versione di runtime in cui è stata introdotta o modificata l'API. Il runtime di Service Fabric supporta più versioni dell'API. Questa è la versione più recente supportata dell'API. Se viene passata una versione api inferiore, la risposta restituita può essere diversa da quella documentata in questa specifica.
Inoltre, il runtime accetta qualsiasi versione superiore alla versione supportata più recente fino alla versione corrente del runtime. Quindi, se la versione dell'API più recente è 6.0, ma se il runtime è 6.1, per semplificare la scrittura dei client, il runtime accetterà la versione 6.1 per tale API. Tuttavia, il comportamento dell'API sarà in base alla versione 6.0 documentata.
EventsHealthStateFilter
Tipo: integer
Obbligatorio: No
Impostazione predefinita: 0
Consente di filtrare la raccolta di oggetti HealthEvent restituiti in base allo stato di integrità.
I valori possibili per questo parametro includono il valore intero di uno dei seguenti stati di integrità.
Vengono restituiti solo gli eventi che corrispondono al filtro. Tutti gli eventi vengono usati per valutare lo stato di integrità aggregato.
Se non specificato diversamente, vengono restituite tutte le voci. I valori dello stato sono enumerati in base al flag, pertanto il valore potrebbe essere una combinazione di questi valori ottenuti usando l'operatore "OR" bit per bit. Ad esempio, se il valore fornito è 6, vengono restituiti tutti gli eventi con valore dello stato di integrità OK (2) e di Avviso (4).
- Impostazione predefinita: valore predefinito. Consente di ricercare qualsiasi stato di integrità. Il valore predefinito è zero.
- Nessuno: filtro che non corrisponde a alcun valore HealthState. Usato per non restituire alcun risultato in un determinato insieme di stati. Il valore è uguale a 1.
- Ok- Filtro che corrisponde all'input con il valore HealthState Ok. Il valore è 2.
- Avviso: filtro che corrisponde all'input con HealthState value Warning. Il valore è 4.
- Errore: filtro che corrisponde all'input con Errore del valore HealthState. Il valore è 8.
- Tutto: filtra che corrisponde all'input con qualsiasi valore HealthState. Il valore è 65535.
timeout
Tipo: integer (int64)
Obbligatorio: No
Impostazione predefinita: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1
Timeout del server per l'esecuzione dell'operazione in secondi. Questo timeout specifica la durata del tempo che il client è disposto a attendere il completamento dell'operazione richiesta. Il valore predefinito per questo parametro è 60 secondi.
ApplicationHealthPolicy
Tipo: ApplicationHealthPolicy
Obbligatorio: No
Descrive i criteri di integrità usati per valutare l'integrità di un'applicazione o uno dei relativi elementi figlio.
Se non presente, la valutazione dell'integrità usa i criteri di integrità dal manifesto dell'applicazione o dai criteri di integrità predefiniti.
Risposte
Codice di stato HTTP | Descrizione | Schema di risposta |
---|---|---|
200 (OK) | Un'operazione con esito positivo restituirà il codice di stato 200 e le informazioni sull'integrità della replica richieste. |
ReplicaHealth |
Tutti gli altri codici di stato | Risposta dettagliata all'errore. |
FabricError |