取得撰寫部署狀態清單

取得在 Service Fabric 叢集中建立的 Compose 部署清單。

針對 Service Fabric 叢集中已建立或正在建立的 Compose 部署，取得部署的相關狀態。 回應會包含名稱、狀態，以及與 Compose 部署有關的其他詳細資料。 如果無法以一頁容納部署清單，則會傳回一頁結果及可用來取得下一頁的接續權杖。

要求

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

參數

名稱	類型	必要	Location
api-version	字串	是	查詢
ContinuationToken	字串	No	查詢
MaxResults	整數 (int64)	No	查詢
timeout	整數 (int64)	No	查詢

---

api-version

類型：字串
必要：是
預設：6.0-preview

API 的版本。 這是必要參數，其值必須是 '「6.0-preview'。

---

ContinuationToken

類型：字串
必要：否

接續權杖參數可用來取得下一組結果。 當來自系統的結果無法放入單一回應中時，API 的回應中會包含具有非空白值的接續權杖。 當此值傳遞至下一個 API 呼叫時，API 會傳回下一組結果。 如果沒有任何進一步的結果，接續權杖就不會包含值。 此參數的值不能經過 URL 編碼。

---

MaxResults

類型：整數 (int64)
必要：否
預設：0
InclusiveMinimum： 0

分頁式查詢時傳回的最大結果數目。 此參數定義傳回結果數目的上限。 根據設定中所定義的訊息大小限制上限，如果所傳回的結果無法放入訊息中，則它們可以小於指定的結果上限。 如果此參數為零或未指定，則分頁式查詢會在傳回訊息中盡可能包含較多結果。

---

timeout

類型：整數 (int64)
必要：否
預設：60
InclusiveMaximum： 4294967295
InclusiveMinimum： 1

用來執行作業的伺服器逾時 (以秒為單位)。 此逾時指定了用戶端願意等候要求作業完成的持續時間。 這個參數的預設值是 60 秒。

回應

HTTP 狀態碼	描述	回應結構描述
200 (確定)	叢集中撰寫部署的狀態清單。	PagedComposeDeploymentStatusInfoList
所有其他狀態碼	詳細的錯誤回應。	FabricError