Condividi tramite

Ottenere l'elenco delle informazioni sull'applicazione

  • Articolo

Mostra l'elenco di applicazioni create nel cluster di Service Fabric che corrisponde ai filtri specificati.

Recupera le informazioni sulle applicazioni create o in corso di creazione nel cluster di Service Fabric e che corrispondono ai filtri specificati. La risposta include il nome, il tipo, lo stato, i parametri e altri dettagli relativi all'applicazione. Se le applicazioni non rientrano in una pagina, viene restituita una pagina di risultati e un token di continuazione, che possono essere usati per accedere alla pagina successiva. Non è possibile specificare contemporaneamente i filtri ApplicationTypeName e ApplicationDefinitionKindFilter.

Richiesta

Metodo URI richiesta
GET /Applications?api-version=6.1&ApplicationDefinitionKindFilter={ApplicationDefinitionKindFilter}&ApplicationTypeName={ApplicationTypeName}&ExcludeApplicationParameters={ExcludeApplicationParameters}&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout}

Parametri

Nome Tipo Necessario Posizione
api-version string Sì Query
ApplicationDefinitionKindFilter numero intero No Query
ApplicationTypeName string No Query
ExcludeApplicationParameters boolean No Query
ContinuationToken string No Query
MaxResults integer (int64) No Query
timeout integer (int64) No Query

api-version

Tipo: string
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 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.

ApplicationDefinitionKindFilter

Tipo: integer
Obbligatorio: No
Impostazione predefinita: 0

Usato per filtrare in base ad ApplicationDefinitionKind, che è il meccanismo usato per definire un'applicazione di Service Fabric.

  • Default : valore predefinito, che esegue la stessa funzione della selezione di "All". Il valore è 0.
  • All: filtro che corrisponde all'input con qualsiasi valore di ApplicationDefinitionKind. Il valore è 65535.
  • ServiceFabricApplicationDescription: filtro che corrisponde all'input con il valore ApplicationDefinitionKind ServiceFabricApplicationDescription. Il valore è uguale a 1.
  • Compose: filtro che corrisponde all'input con il valore ApplicationDefinitionKind Compose. Il valore è 2.

ApplicationTypeName

Tipo: string
Obbligatorio: No

Nome del tipo di applicazione usato per filtrare le applicazioni per cui eseguire le query. Questo valore non deve contenere la versione del tipo di applicazione.

ExcludeApplicationParameters

Tipo: booleano
Obbligatorio: No
Impostazione predefinita: false

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

ContinuationToken

Tipo: string
Obbligatorio: No

Il parametro del token di continuazione viene utilizzato per ottenere il set di risultati successivo. Un token di continuazione con un valore non vuoto è incluso nella risposta dell'API quando i risultati del sistema non rientrano in una singola risposta. Quando questo valore viene passato alla successiva chiamata API, l'API restituisce il set di risultati successivo. Se non sono presenti altri risultati, il token di continuazione non contiene alcun valore. Il valore di questo parametro non deve essere codificato in URL.

MaxResults

Tipo: integer (int64)
Obbligatorio: No
Impostazione predefinita: 0
InclusiveMinimum: 0

Il numero massimo di risultati che devono essere restituiti come parte delle query di paging. Questo parametro definisce il limite massimo di risultati restituiti. Se non rientrano nel messaggio in base ai limiti di dimensione massima per i messaggi definiti nella configurazione, il numero dei risultati restituiti può essere inferiore al numero massimo di risultati specificato. Se questo parametro è uguale a zero o non specificato, le query di paging includono il numero massimo di risultati possibili che rientrano nel messaggio restituito.

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.

Risposte

Codice di stato HTTP Descrizione Schema di risposta
200 (OK) Elenco di applicazioni create nel cluster.
 PagedApplicationInfoList
Tutti gli altri codici di stato Risposta dettagliata all'errore.
 FabricError

Esempio

Limitare i risultati massimi

Questo esempio illustra come ottenere informazioni sulle applicazioni nel cluster. Il numero di risultati in una pagina è limitato a un massimo di due usando il parametro MaxResult.

Richiesta

GET http://localhost:19080/Applications?api-version=6.1&MaxResults=2

Risposta 200

Corpo
{
  "ContinuationToken": "fabric:/samples/PQueueApp1",
  "Items": [
    {
      "Id": "samples~CalculatorApp",
      "Name": "fabric:/samples/CalculatorApp",
      "TypeName": "CalculatorApp",
      "TypeVersion": "1.0",
      "Status": "Ready",
      "Parameters": [],
      "HealthState": "Ok",
      "ApplicationDefinitionKind": "ServiceFabricApplicationDescription"
    },
    {
      "Id": "samples~PQueueApp1",
      "Name": "fabric:/samples/PQueueApp1",
      "TypeName": "PersistentQueueApp",
      "TypeVersion": "1.0",
      "Status": "Ready",
      "Parameters": [],
      "HealthState": "Ok",
      "ApplicationDefinitionKind": "ServiceFabricApplicationDescription"
    }
  ]
}

Pagina con token di continuazione

In questo esempio viene illustrato come visualizzare le informazioni sulle applicazioni nel cluster usando il parametro ContinuationToken. Il valore di questo parametro viene fornito dalla query precedente, in questo caso l'esempio illustrato in precedenza. La risposta contiene il risultato rimanente e una continuazione vuotaToken. La continuazione vuotaToken indica che non sono disponibili risultati aggiuntivi.

Richiesta

GET http://localhost:19080/Applications?api-version=6.1&ContinuationToken=fabric:/samples/PQueueApp1&MaxResults=2

Risposta 200

Corpo
{
  "ContinuationToken": "",
  "Items": [
    {
      "Id": "samples~VQueueApp1",
      "Name": "fabric:/samples/VQueueApp1",
      "TypeName": "VolatileQueueApp",
      "TypeVersion": "1.0",
      "Status": "Ready",
      "Parameters": [],
      "HealthState": "Ok",
      "ApplicationDefinitionKind": "ServiceFabricApplicationDescription"
    }
  ]
}