Compose Deployment Status List を取得する

  • [アーティクル]

Service Fabric クラスターで作成された Compose デプロイの一覧を取得します。

Service Fabric クラスターで作成されたまたは作成中の Compose デプロイの状態を取得します。 応答には、名前、状態、および Compose デプロイに関するその他の詳細が含まれています。 デプロイのリストが 1 ページに収まらない場合、1 ページの結果と継続トークンが返されます。これは次のページを取得するために使用できます。

Request

Method 要求 URI
GET /ComposeDeployments?api-version=6.0-preview&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout}

パラメーター

名前 Type 必須 場所
api-version string はい クエリ
ContinuationToken string いいえ クエリ
MaxResults integer (int64) いいえ クエリ
timeout integer (int64) いいえ クエリ

api-version

型: string
必須: はい
既定値:

API のバージョン。 このパラメーターは必須であり、その値は '"6.0-preview' である必要があります。

ContinuationToken

型: string
必須: いいえ

継続トークンのパラメーターは、次の結果セットを取得するために使用されます。 システムからの結果が 1 つの応答に収まらない場合は、空以外の値を持つ継続トークンが API の応答に含まれます。 この値が次の API 呼び出しに渡されると、API が次の結果セットを返します。 それ以上の結果がない場合は、継続トークンに値が含まれません。 このパラメーターの値を URL にエンコードすることはできません。

MaxResults

型: integer (int64)
必須: いいえ
既定値:
InclusiveMinimum: 0

ページング クエリの一部として返される結果の最大数。 このパラメーターは、返される結果の数に上限を定義します。 返された結果が、構成で定義したメッセージの最大サイズの制限に収まらない場合は、指定した最大結果数よりも少なくなる場合があります。 このパラメーターがゼロまたは指定されていない場合、ページング クエリには、応答メッセージに収まるできるだけ多くの結果が含まれます。

timeout

型: integer (int64)
必須: いいえ
既定値:
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

操作を実行するためのサーバー タイムアウト (秒単位)。 このタイムアウトは、要求した操作が完了するまでクライアントが待機できる期間を指定します。 このパラメーターの既定値は 60 秒です。

応答

HTTP 状態コード 説明 応答スキーマ
200 (OK) クラスター内の Compose デプロイの状態の一覧。
 PagedComposeDeploymentStatusInfoList
その他のすべての状態コード 詳細なエラー応答。
 FabricError