Abrufen der Bereitstellungsstatusliste "Compose"

  • Artikel

Ruft die Liste der Compose-Bereitstellungen ab, die in dem Service Fabric-Cluster erstellt wurden.

Ruft den Status zu den Compose-Bereitstellungen ab, die im Service Fabric-Cluster erstellt wurden oder momentan erstellt werden. Die Antwort enthält den Namen, den Status und weitere Details über die Compose-Bereitstellungen. Wenn die Liste mit den Bereitstellungen nicht auf eine Seite passt, werden sowohl eine Seite mit Ergebnissen als auch ein Fortsetzungstoken zurückgegeben, über das zur nächsten Seite gewechselt werden kann.

Anforderung

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

Parameter

Name type Erforderlich Standort
api-version Zeichenfolge Ja Abfrage
ContinuationToken Zeichenfolge Nein Abfrage
MaxResults ganze Zahl (int64) Nein Abfrage
timeout ganze Zahl (int64) Nein Abfrage

api-version

Typ: Zeichenfolge
Erforderlich: Ja
Standard:

Die Version der API. Dieser Parameter ist erforderlich, und sein Wert muss "6.0-preview" sein.

ContinuationToken

Typ: Zeichenfolge
Erforderlich: Nein

Der Parameter „continuation-token“ (Fortsetzungstoken) wird dazu verwendet, den nächsten Satz von Ergebnissen abzurufen. Ein Fortsetzungstoken mit einem nicht leeren Wert wird in die Antwort der API eingefügt, wenn die Ergebnisse aus dem System nicht in eine einzige Antwort passen. Wird dieser Wert an den nächsten API-Aufruf übergeben, gibt die API den nächsten Satz von Ergebnissen zurück. Gibt es keine weiteren Ergebnisse, enthält das Fortsetzungstoken keinen Wert. Der Wert dieses Parameters darf nicht als URL codiert sein.

MaxResults

Typ: integer (int64)
Erforderlich: Nein
Standard:
InclusiveMinimum: 0

Die maximale Anzahl von Ergebnissen, die als Teil der seitenweisen Abfragen zurückgegeben werden sollen. Dieser Parameter definiert die obere Grenze für die Anzahl von zurückgegebenen Ergebnissen. Es können weniger Ergebnisse zurückgegeben werden, als dieser maximalen Anzahl entspricht. Dies ist der Fall, wenn die Ergebnisse wegen der Größenbeschränkungen, die für Meldungen in der Konfiguration definiert sind, nicht in die jeweilige Meldung passen. Ist dieser Parameter gleich null oder nicht angegeben, enthält die seitenweise Abfrage so viele Ergebnisse, wie in die Rückgabemeldung passen.

timeout

Typ: integer (int64)
Erforderlich: Nein
Standard:
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

Der Servertimeout für die Ausführung des Vorgangs in Sekunden. Dieser Timeout gibt die Zeitdauer an, die der Client bereit ist, auf den Abschluss des angeforderten Vorgangs zu warten. Der Standardwert für diesen Parameter ist 60 Sekunden.

Antworten

HTTP-Statuscode BESCHREIBUNG Antwortschema
200 (OK) Liste der status von Erstellungsbereitstellungen im Cluster.
 PagedComposeDeploymentStatusInfoList
Alle anderen status Codes Die detaillierte Fehlerantwort.
 FabricError