Ottenere integrità del servizio

Articolo
08/05/2023

Mostra l'integrità del servizio di Service Fabric specificato.

Mostra le informazioni di integrità del servizio specificato. Usare EventsHealthStateFilter per filtrare la raccolta di eventi di stato riportati nel servizio in base allo stato di integrità. Usare PartitionsHealthStateFilter per filtrare la raccolta di partizioni restituita. Se si specifica un servizio che non esiste nell'archivio integrità, questa richiesta restituisce un errore.

Richiesta

Metodo	URI richiesta
GET	`/Services/{serviceId}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&PartitionsHealthStateFilter={PartitionsHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&timeout={timeout}`

Parametri

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

`serviceId`

Tipo: stringa
Obbligatorio: Sì

L'identità del servizio. Questo ID è in genere il nome completo del servizio senza lo schema URI 'fabric:'. A partire dalla versione 6.0, i nomi gerarchici sono delimitati dal carattere "~". Ad esempio, se il nome del servizio è "fabric:/myapp/app1/svc1", l'identità del servizio sarà "myapp~app1~svc1" in 6.0+ e "myapp/app1/svc1" nelle versioni precedenti.

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

`PartitionsHealthStateFilter`

Tipo: integer
Obbligatorio: No
Impostazione predefinita: 0

Filtra gli oggetti dello stato di integrità delle partizioni restituiti nel risultato della query sull'integrità del servizio 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 restituite solo partizioni che corrispondono al filtro. Tutte le partizioni 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 specificato è 6, vengono restituite le partizioni 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.

`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 di attesa 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à del servizio specificato.	Servicehealth
Tutti gli altri codici di stato	Risposta dettagliata all'errore.	FabricError

Condividi tramite