Condividi tramite

Ottenere l'integrità della partizione tramite i criteri

  • Articolo

Ottiene l'integrità della partizione di Service Fabric specificata utilizzando i criteri di integrità specificati.

Mostra le informazioni di integrità della partizione specificata. Se vengono specificati i criteri di integrità dell'applicazione, la valutazione dell'integrità lo usa per ottenere lo stato di integrità aggregato. Se il criterio non viene specificato, la valutazione dell'integrità usa i criteri di integrità dell'applicazione definiti nel manifesto dell'applicazione o i criteri di integrità predefiniti, se nel manifesto non è definito alcun criterio. Usare EventsHealthStateFilter per filtrare la raccolta di eventi di integrità segnalati sulla partizione in base allo stato di integrità. Utilizzare ReplicasHealthStateFilter per filtrare la raccolta di oggetti ReplicaHealthState nella partizione. Usare ApplicationHealthPolicy nel corpo POST per eseguire l'override dei criteri di integrità usati per valutare l'integrità. Se si specifica una partizione che non esiste nell'archivio integrità, questa richiesta restituisce un errore.

Richiesta

Metodo URI richiesta
POST /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
ApplicationHealthPolicy ApplicationHealthPolicy No Corpo

partitionId

Tipo: string (uuid)
Obbligatorio: Sì

L'identità della partizione.

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.

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

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.

ApplicationHealthPolicy

Tipo: ApplicationHealthPolicy
Obbligatorio: No

Descrive i criteri di integrità usati per valutare l'integrità di un'applicazione o di 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 riuscita restituirà il codice di stato 200 e le informazioni sull'integrità relative alla partizione specificata.
 PartitionHealth
Tutti gli altri codici di stato Risposta dettagliata all'errore.
 FabricError