Condividi tramite

Ottenere informazioni sull'applicazione distribuite

  • Articolo

Recupera le informazioni relative a un'applicazione distribuita in un nodo di Service Fabric.

Questa query restituisce informazioni sull'applicazione di sistema se l'ID applicazione fornito è relativo all'applicazione di sistema. I risultati includono le applicazioni distribuite con stato "attivo", "attivazione in corso" e "download in corso". Questa query richiede che il nome del nodo corrisponda a un nodo nel cluster. La query ha esito negativo se il nome del nodo specificato non fa riferimento ad alcun nodo di Service Fabric attivo nel cluster.

Richiesta

Metodo URI richiesta
GET /Nodes/{nodeName}/$/GetApplications/{applicationId}?api-version=6.1&timeout={timeout}&IncludeHealthState={IncludeHealthState}

Parametri

Nome Tipo Necessario Posizione
nodeName string Sì Percorso
applicationId string Sì Percorso
api-version string Sì Query
timeout integer (int64) No Query
IncludeHealthState boolean No Query

nodeName

Tipo: stringa
Obbligatorio: Sì

Il nome del nodo.

applicationId

Tipo: stringa
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: stringa
Obbligatorio: Sì
Impostazione predefinita: 6.1

Versione dell'API. Questo parametro è obbligatorio e il relativo valore deve essere '6.1'.

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.

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.

IncludeHealthState

Tipo: booleano
Obbligatorio: No
Impostazione predefinita: false

Include lo stato di integrità di un'entità. Se questo parametro è false o non viene specificato, lo stato di integrità restituito è "Unknown". Quando è impostato su true, la query passa in parallelo al nodo e al servizio di sistema di integrità prima che i risultati vengano uniti. Di conseguenza, la query è più costosa e può richiedere più tempo.

Risposte

Codice di stato HTTP Descrizione Schema di risposta
200 (OK) Un'operazione riuscita restituirà il codice di stato 200 e le informazioni sull'applicazione distribuita.
 DeployedApplicationInfo
204 (NoContent) Viene restituita una risposta vuota se l'applicazione specificata non viene distribuita nel nodo.
Tutti gli altri codici di stato Risposta dettagliata all'errore.
 FabricError

Esempio

Ottenere un'applicazione distribuita specifica in base all'ID applicazione e includere lo stato di integrità nel risultato

In questo esempio viene illustrato come ottenere informazioni su un'applicazione distribuita in un nodo specificato usando un identificatore dell'applicazione. Se l'applicazione viene trovata, le informazioni vengono restituite con il codice di stato 200. Viene restituita una risposta vuota con codice di stato 204, se l'applicazione specificata non viene distribuita nel nodo.

Richiesta

GET http://localhost:19080/Nodes/_Node_0/$/GetApplications/samples~CalculatorApp?api-version=6.1&IncludeHealthState=True

Risposta 200

Corpo
{
  "Id": "samples~CalculatorApp",
  "Name": "fabric:/samples/CalculatorApp",
  "TypeName": "CalculatorApp",
  "TypeVersion": "1.0.0",
  "Status": "Active",
  "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\work",
  "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\log",
  "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\temp",
  "HealthState": "Ok"
}

Risposta 204

Corpo

Il corpo della risposta è vuoto.