Ottenere l'integrità del cluster usando i criteri

Articolo
07/19/2023

Ottiene l'integrità di un cluster di Service Fabric usando i criteri specificati.

Usare EventsHealthStateFilter per filtrare la raccolta di eventi di stato riportati nel cluster in base allo stato di integrità. Analogamente, usare NodesHealthStateFilter e ApplicationsHealthStateFilter per filtrare la raccolta di nodi e applicazioni restituito in base al relativo stato di integrità aggregato. Usare ClusterHealthPolicies per eseguire l'override dei criteri di integrità usati per valutare l'integrità.

Richiesta

Metodo	URI richiesta
POST	`/$/GetClusterHealth?api-version=6.0&NodesHealthStateFilter={NodesHealthStateFilter}&ApplicationsHealthStateFilter={ApplicationsHealthStateFilter}&EventsHealthStateFilter={EventsHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&IncludeSystemApplicationHealthStatistics={IncludeSystemApplicationHealthStatistics}&timeout={timeout}`

Parametri

Nome	Tipo	Necessario	Posizione
`api-version`	string	Sì	Query
`NodesHealthStateFilter`	numero intero	No	Query
`ApplicationsHealthStateFilter`	numero intero	No	Query
`EventsHealthStateFilter`	numero intero	No	Query
`ExcludeHealthStatistics`	boolean	No	Query
`IncludeSystemApplicationHealthStatistics`	boolean	No	Query
`timeout`	integer (int64)	No	Query
`ClusterHealthPolicies`	ClusterHealthPolicies	No	Corpo

`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.

`NodesHealthStateFilter`

Tipo: integer
Obbligatorio: No
Impostazione predefinita: 0

Consente di filtrare gli oggetti dello stato di integrità dei nodi restituiti nel risultato della query sull'integrità dei cluster in base al relativo stato di integrità. I valori possibili per questo parametro includono il valore intero di uno dei seguenti stati di integrità. Vengono restituiti solo i nodi che corrispondono al filtro. Tutti i nodi 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, viene restituito lo stato di integrità dei nodi con valore di HealthState OK (2) e Warning (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.

`ApplicationsHealthStateFilter`

Tipo: integer
Obbligatorio: No
Impostazione predefinita: 0

Consente di filtrare gli oggetti dello stato di integrità delle applicazioni restituiti nel risultato della query sull'integrità dei cluster in base al relativo stato di integrità. I valori possibili per questo parametro includono il valore intero ottenuto da membri o operazioni bit per bit sui membri dell'enumerazione HealthStateFilter. Vengono restituite solo le applicazioni che corrispondono al filtro. Tutte le applicazioni vengono usate 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 indicato è 6, viene restituito lo stato di integrità delle applicazioni il cui valore di HealthState è OK (2) e Warning (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.

`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 ad alcun valore di 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 valore healthState Avviso. Il valore è 4.
Errore: filtro che corrisponde all'input con valore healthState Error. Il valore è 8.
All: filtro che corrisponde all'input con qualsiasi valore di HealthState. Il valore è 65535.

`ExcludeHealthStatistics`

Tipo: booleano
Obbligatorio: No
Impostazione predefinita: false

Indica se le statistiche di integrità devono essere restituite come parte del risultato della query. False per impostazione predefinita. Le statistiche indicano il numero di entità figlio il cui stato di integrità è Ok, Avviso ed Errore.

`IncludeSystemApplicationHealthStatistics`

Tipo: booleano
Obbligatorio: No
Impostazione predefinita: false

Indica se le statistiche di integrità devono includere le statistiche di integrità dell'applicazione fabric:/System. False per impostazione predefinita. Se IncludeSystemApplicationHealthStatistics è impostato su true, le statistiche di integrità includono le entità che appartengono all'applicazione fabric:/System. In caso contrario, il risultato della query includerà soltanto le statistiche di integrità per le applicazioni utente. Per applicare questo parametro, è necessario includere le statistiche di integrità nel risultato della query.

`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 di attesa che il client è disposto a attendere il completamento dell'operazione richiesta. Il valore predefinito per questo parametro è 60 secondi.

`ClusterHealthPolicies`

Tipo: ClusterHealthPolicies
Obbligatorio: No

Descrive i criteri di integrità usati per valutare l'integrità del cluster. Se non è presente, la valutazione dell'integrità usa i criteri di integrità del cluster definiti nel manifesto del cluster o i criteri di integrità predefiniti del cluster. Per impostazione predefinita, ogni applicazione viene valutata usando i criteri di integrità specifici dell'applicazione, definiti nel manifesto dell'applicazione o i criteri di integrità predefiniti, se nel manifesto non è definito alcun criterio. Se viene specificata la mappa dei criteri di integrità dell'applicazione e include una voce per un'applicazione, i criteri di integrità dell'applicazione specificati vengono usati per valutare l'integrità dell'applicazione.

Risposte

Codice di stato HTTP	Descrizione	Schema di risposta
200 (OK)	Un'operazione completata restituirà il codice di stato 200 e le informazioni sull'integrità del cluster richieste.	ClusterHealth
Tutti gli altri codici di stato	Risposta dettagliata all'errore.	FabricError

Condividi tramite