Ottenere integrità partizione

Articolo
08/05/2023

Mostra l'integrità della partizione di Service Fabric specificata.

Usare EventsHealthStateFilter per filtrare la raccolta di eventi di stato riportati nel servizio in base allo stato di integrità. Utilizzare ReplicasHealthStateFilter per filtrare la raccolta di oggetti ReplicaHealthState nella partizione. Se si specifica una partizione che non esiste nell'archivio integrità, questa richiesta restituisce un errore.

Richiesta

Metodo	URI richiesta
GET	`/Partitions/{partitionId}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&ReplicasHealthStateFilter={ReplicasHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&timeout={timeout}`

Parametri

Nome	Tipo	Necessario	Posizione
`partitionId`	string (uuid)	Sì	Percorso
`api-version`	string	Sì	Query
`EventsHealthStateFilter`	numero intero	No	Query
`ReplicasHealthStateFilter`	numero intero	No	Query
`ExcludeHealthStatistics`	boolean	No	Query
`timeout`	integer (int64)	No	Query

`partitionId`

Tipo: stringa (uuid)
Obbligatorio: Sì

L'identità della partizione.

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

`ReplicasHealthStateFilter`

Tipo: integer
Obbligatorio: No
Impostazione predefinita: 0

Consente di filtrare la raccolta di oggetti ReplicaHealthState nella partizione. Il valore può essere ottenuto da membri o da operazioni bit per bit sui membri di HealthStateFilter. Verranno restituite solo repliche che corrispondono al filtro. Verranno usate tutte le repliche per valutare lo stato di integrità aggregato. Se non specificato diversamente, verranno 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 specificato è 6, verranno restituiti tutti gli eventi con valore dello stato di integrità OK (2) e di Avviso (4). I valori possibili per questo parametro includono il valore intero di uno dei seguenti stati di integrità.

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.

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

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

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à sulla partizione specificata.	PartitionHealth
Tutti gli altri codici di stato	Risposta dettagliata all'errore.	FabricError

Condividi tramite