Ottenere informazioni sull'applicazione

  • Articolo

Recupera informazioni su un'applicazione di Service Fabric.

Restituisce le informazioni sull'applicazione creata o in corso di creazione nel cluster di Service Fabric e il cui nome corrisponde a quello specificato come parametro. La risposta include il nome, il tipo, lo stato, i parametri e altri dettagli relativi all'applicazione.

Richiesta

Metodo URI richiesta
GET /Applications/{applicationId}?api-version=6.0&ExcludeApplicationParameters={ExcludeApplicationParameters}&timeout={timeout}

Parametri

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

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

ExcludeApplicationParameters

Tipo: booleano
Obbligatorio: No
Impostazione predefinita: false

Flag che specifica se i parametri dell'applicazione verranno esclusi dal risultato.

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) Informazioni sull'applicazione.
 ApplicationInfo
204 (NoContent) Viene restituita una risposta vuota se l'applicationId specificato non viene trovato nel cluster.
Tutti gli altri codici di stato Risposta dettagliata all'errore.
 FabricError

Esempio

Ottenere un'applicazione specifica in base all'ID applicazione

Questo esempio illustra come ottenere informazioni su un'applicazione usando l'identificatore. Se l'applicazione viene trovata, vengono restituite informazioni con il codice di stato 200. Se l'applicazione non viene trovata, il contenuto vuoto viene restituito con il codice di stato 204.

Richiesta

GET http://localhost:19080/Applications/samples~CalculatorApp?api-version=6.0

Risposta 200

Corpo
{
  "Id": "samples~CalculatorApp",
  "Name": "fabric:/samples/CalculatorApp",
  "TypeName": "CalculatorApp",
  "TypeVersion": "1.0",
  "Status": "Ready",
  "Parameters": [
    {
      "Key": "CalculatorAppParameter1",
      "Value": "314"
    },
    {
      "Key": "CalculatorAppParameter2",
      "Value": "271"
    }
  ],
  "HealthState": "Ok",
  "ApplicationDefinitionKind": "ServiceFabricApplicationDescription"
}

Risposta 204

Corpo

Il corpo della risposta è vuoto.