Get Compose Deployment Status List

  • Articolo

Mostra l'elenco di distribuzioni di composizione create nel cluster di Service Fabric.

Mostra lo stato delle distribuzioni di composizione che sono state create oppure sono in corso di creazione nel cluster di Service Fabric. La risposta include il nome, lo stato e altri dettagli relativi alle distribuzioni di composizione. Se l'elenco di distribuzioni non rientra in una pagina, vengono restituiti una pagina di risultati e un token di continuazione, che può essere usato per accedere alla pagina successiva.

Richiesta

Metodo URI richiesta
GET /ComposeDeployments?api-version=6.0-preview&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout}

Parametri

Nome Tipo Necessario Posizione
api-version string Sì Query
ContinuationToken string No Query
MaxResults integer (int64) No Query
timeout integer (int64) No Query

api-version

Tipo: string
Obbligatorio: Sì
Impostazione predefinita: 6.0-preview

Versione dell'API. Questo parametro è obbligatorio e il relativo valore deve essere '"6.0-preview'.

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 stato delle distribuzioni compose nel cluster.
 PagedComposeDeploymentStatusInfoList
Tutti gli altri codici di stato Risposta dettagliata all'errore.
 FabricError