Ottenere l'integrità dell'applicazione

Articolo
07/19/2023

Mostra l'integrità dell'applicazione di Service Fabric.

Restituisce lo stato di integrità dell'applicazione di Service Fabric. La risposta indica lo stato di integrità com OK, Errore o Avviso. Se l'entità non viene trovata nell'archivio integrità, verrà restituito Error.

Richiesta

Metodo	URI richiesta
GET	`/Applications/{applicationId}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&DeployedApplicationsHealthStateFilter={DeployedApplicationsHealthStateFilter}&ServicesHealthStateFilter={ServicesHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&timeout={timeout}`

Parametri

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

`applicationId`

Tipo: string
Obbligatorio: Sì

Identità dell'applicazione. Si tratta in genere del nome completo dell'applicazione senza lo schema URI "fabric:". A partire dalla versione 6.0, i nomi gerarchici sono delimitati dal carattere "~". Ad esempio, se il nome dell'applicazione è "fabric:/myapp/app1", l'identità dell'applicazione sarà "myapp~app1" nella versione 6.0 e successive e "myapp/app1" nelle versioni precedenti.

`api-version`

Tipo: string
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 precedente dell'API, 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. Se quindi la versione più recente dell'API è 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 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.

`DeployedApplicationsHealthStateFilter`

Tipo: integer
Obbligatorio: No
Impostazione predefinita: 0

Consente di filtrare gli oggetti dello stato di integrità delle applicazioni distribuite restituiti nel risultato della query di integrità dell'applicazione in base al relativo stato di integrità. I valori possibili per questo parametro includono il valore intero di uno dei seguenti stati di integrità. Verranno restituite solo le applicazioni distribuite che corrispondono al filtro. Tutte le applicazioni distribuite 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 distribuite il cui valore di HealthState è OK (2) e 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.
Tutto: filtra che corrisponde all'input con qualsiasi valore HealthState. Il valore è 65535.

`ServicesHealthStateFilter`

Tipo: integer
Obbligatorio: No
Impostazione predefinita: 0

Consente di filtrare gli oggetti dello stato di integrità del servizio 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 restituiti solo i servizi che corrispondono al filtro. Tutti i servizi 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 indicato è 6, viene restituito lo stato di integrità dei servizi con valore 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.

`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 riuscita restituirà il codice di stato 200 e le informazioni sull'integrità dell'applicazione richieste.	ApplicationHealth
Tutti gli altri codici di stato	Risposta dettagliata all'errore.	FabricError

Condividi tramite