Segnalare l'integrità dell'applicazione distribuita
Invia un report sull'integrità nell'applicazione di Service Fabric distribuita in un nodo di Service Fabric.
Segnala lo stato di integrità dell'applicazione distribuita in un nodo di Service Fabric. Il report deve contenere le informazioni relative all'origine del report sull'integrità e alla proprietà in cui viene segnalato. Il report viene inviato a un servizio del gateway di Service Fabric, che lo inoltra all'archivio integrità. Il report può essere accettato dal gateway, ma rifiutato dall'archivio integrità dopo la convalida aggiuntiva. L'archivio integrità, ad esempio, può rifiutare il report a causa di un parametro non valido, come un numero di sequenza non aggiornato. Per verificare se il report è stato applicato nell'archivio integrità, ottenere l'integrità dell'applicazione distribuita e verificare che il report venga visualizzato nella sezione HealthEvents.
Richiesta
Metodo | URI richiesta |
---|---|
POST | /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/ReportHealth?api-version=6.0&Immediate={Immediate}&timeout={timeout} |
Parametri
Nome | Tipo | Necessario | Posizione |
---|---|---|---|
nodeName |
string | Sì | Percorso |
applicationId |
string | Sì | Percorso |
api-version |
string | Sì | Query |
Immediate |
boolean | No | Query |
timeout |
integer (int64) | No | Query |
HealthInformation |
HealthInformation | sì | Corpo |
nodeName
Tipo: string
Obbligatorio: Sì
Il nome del nodo.
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.
Immediate
Tipo: booleano
Obbligatorio: No
Impostazione predefinita: false
Flag che indica se il report deve essere inviato immediatamente.
Un report sull'integrità viene inviato a un'applicazione del gateway di Service Fabric, che lo inoltra all'archivio integrità.
Se Immediate è impostato su True, il report viene inviato immediatamente dal gateway HTTP all'archivio integrità, indipendentemente dalle impostazioni del client Fabric usate dall'applicazione gateway HTTP.
Questo è utile per i report critici che devono essere inviati appena possibile.
A seconda della tempistica e di altre condizioni, l'invio del report può tuttavia avere esito negativo, ad esempio se il gateway HTTP è chiuso o il messaggio non raggiunge il gateway.
Se Immediate è impostato su False, il report viene inviato in base alle impostazioni del client di integrità dal gateway HTTP. Verrà quindi inviato in batch in base alla configurazione di HealthReportSendInterval.
Questa è l'impostazione consigliata perché consente al client di integrità di ottimizzare la segnalazione di messaggi sull'integrità all'archivio integrità e l'elaborazione di report sull'integrità.
Per impostazione predefinita, i report non vengono inviati immediatamente.
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.
HealthInformation
Tipo: HealthInformation
Obbligatorio: Sì
Descrive le informazioni sull'integrità per il report sull'integrità. Queste informazioni devono essere presenti in tutti i report sull'integrità inviati al responsabile dell'integrità.
Risposte
Codice di stato HTTP | Descrizione | Schema di risposta |
---|---|---|
200 (OK) | Un'operazione completata restituirà il codice di stato 200. |
|
Tutti gli altri codici di stato | Risposta dettagliata all'errore. |
FabricError |