共用方式為

使用原則和進階篩選來取得叢集健康情況區塊

  • 發行項

使用健康情況區塊取得 Service Fabric 叢集的健康情況。

使用健康情況區塊取得 Service Fabric 叢集的健康情況。 健康情況評估是根據輸入叢集健康情況區塊查詢描述來完成。 查詢描述可讓使用者指定健康情況原則來評估叢集及其子系。 使用者可以指定非常彈性的篩選準則，以選取要傳回的叢集實體。 您可以根據實體健全狀況狀態和階層來完成選取範圍。 查詢可以根據指定的篩選準則傳回實體的多層級子系。 例如，它可以傳回一個具有指定名稱的應用程式，而針對此應用程式，則只會傳回錯誤或警告中的服務，以及其中一個服務的所有分割區和複本。

要求

方法 要求 URI
POST /$/GetClusterHealthChunk?api-version=6.0&timeout={timeout}

參數

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

api-version

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

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

Service Fabric REST API 版本是以 API 引進或變更的執行時間版本為基礎。 Service Fabric 執行時間支援多個版本的 API。 這是 API 的最新支援版本。 如果傳遞較低的 API 版本，傳回的回應可能會與本規格中所述的回應不同。

此外，執行時間也接受高於最新支援版本的任何版本，最高為目前版本的執行時間。 因此，如果最新的 API 版本是 6.0，但如果執行時間是 6.1，為了更容易撰寫用戶端，執行時間將會接受該 API 6.1 版。 不過，API 的行為會根據記載的 6.0 版本。

timeout

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

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

ClusterHealthChunkQueryDescription

類型： ClusterHealthChunkQueryDescription
必要：否

描述用來評估叢集健康情況的叢集和應用程式健康情況原則，以及篩選準則，以選取要傳回的叢集實體。 如果叢集健康情況原則存在，則會用來評估叢集事件和叢集節點。 如果沒有，健康情況評估會使用叢集資訊清單或預設叢集健康狀態原則中定義的叢集健康情況原則。 根據預設，如果資訊清單中未定義任何原則，則會使用應用程式資訊清單中定義的特定應用程式健康情況原則或預設健康狀態原則來評估每個應用程式。 如果指定了應用程式健康狀態原則對應，且應用程式有專案，則會使用指定的應用程式健康情況原則來評估應用程式健康情況。 使用者可以指定非常彈性的篩選準則，以選取要包含在回應中的叢集實體。 您可以根據實體健全狀況狀態和階層來完成選取範圍。 查詢可以根據指定的篩選準則傳回實體的多層級子系。 例如，它可以傳回一個具有指定名稱的應用程式，而針對此應用程式，則只會傳回錯誤或警告中的服務，以及其中一個服務的所有分割區和複本。

回應

HTTP 狀態碼 描述 回應結構描述
200 (確定) 成功的作業會傳回 200 狀態碼和要求的叢集健全狀況區塊資訊。
 ClusterHealthChunk
所有其他狀態碼 詳細的錯誤回應。
 FabricError