共用方式為

取得應用程式資訊清單

  • 發行項

取得在 Service Fabric 叢集中建立且符合所指定篩選條件的應用程式清單。

取得 Service Fabric 叢集中已建立或正在建立且符合指定篩選條件的應用程式相關資訊。 回應包括名稱、類型、狀態、參數，以及應用程式的其他詳細資料。 如果應用程式無法放入一頁，則會傳回一頁結果，以及可用來取得下一頁的接續權杖。 無法同時指定篩選條件 ApplicationTypeName 和 ApplicationDefinitionKindFilter。

要求

方法 要求 URI
GET /Applications?api-version=6.1&ApplicationDefinitionKindFilter={ApplicationDefinitionKindFilter}&ApplicationTypeName={ApplicationTypeName}&ExcludeApplicationParameters={ExcludeApplicationParameters}&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout}

參數

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

api-version

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

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

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

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

ApplicationDefinitionKindFilter

類型：整數
必要：否
預設：0

用來依據 ApplicationDefinitionKind 進行篩選，這是用來定義 Service Fabric 應用程式的機制。

  • 預設值 - 預設值，其會執行與選取 「All」 相同的函式。 值為 0。
  • All - 符合輸入與任何 ApplicationDefinitionKind 值的篩選。 值為 65535。
  • ServiceFabricApplicationDescription - 符合 ApplicationDefinitionKind 值 ServiceFabricApplicationDescription 之輸入的篩選準則。 值為 1。
  • Compose - 符合 ApplicationDefinitionKind 值 Compose 輸入的篩選準則。 值為 2。

ApplicationTypeName

類型：字串
必要：否

用來篩選要查詢之應用程式的應用程式類型名稱。 此值不應該包含應用程式類型版本。

ExcludeApplicationParameters

類型：布林值
必要：否
預設：false

指定是否將從結果中排除應用程式參數的旗標。

ContinuationToken

類型：字串
必要：否

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

MaxResults

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

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

timeout

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

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

回應

HTTP 狀態碼 描述 回應結構描述
200 (確定) 叢集中建立的應用程式清單。
 PagedApplicationInfoList
所有其他狀態碼 詳細的錯誤回應。
 FabricError

範例

限制最大結果

此範例示範如何取得叢集上應用程式的相關資訊。 頁面中的結果數目限制為使用 MaxResult 參數最多兩個。

要求

GET http://localhost:19080/Applications?api-version=6.1&MaxResults=2

200 回應

主體
{
  "ContinuationToken": "fabric:/samples/PQueueApp1",
  "Items": [
    {
      "Id": "samples~CalculatorApp",
      "Name": "fabric:/samples/CalculatorApp",
      "TypeName": "CalculatorApp",
      "TypeVersion": "1.0",
      "Status": "Ready",
      "Parameters": [],
      "HealthState": "Ok",
      "ApplicationDefinitionKind": "ServiceFabricApplicationDescription"
    },
    {
      "Id": "samples~PQueueApp1",
      "Name": "fabric:/samples/PQueueApp1",
      "TypeName": "PersistentQueueApp",
      "TypeVersion": "1.0",
      "Status": "Ready",
      "Parameters": [],
      "HealthState": "Ok",
      "ApplicationDefinitionKind": "ServiceFabricApplicationDescription"
    }
  ]
}

使用接續權杖的頁面

此範例示範如何使用 ContinuationToken 參數，逐頁流覽叢集上應用程式的相關資訊。 此參數的值是從上一個查詢提供，在此案例中為上述範例。 回應包含剩餘的一個結果和空的 ContinuationToken。 空的 ContinuationToken 表示無法使用其他結果。

要求

GET http://localhost:19080/Applications?api-version=6.1&ContinuationToken=fabric:/samples/PQueueApp1&MaxResults=2

200 回應

主體
{
  "ContinuationToken": "",
  "Items": [
    {
      "Id": "samples~VQueueApp1",
      "Name": "fabric:/samples/VQueueApp1",
      "TypeName": "VolatileQueueApp",
      "TypeVersion": "1.0",
      "Status": "Ready",
      "Parameters": [],
      "HealthState": "Ok",
      "ApplicationDefinitionKind": "ServiceFabricApplicationDescription"
    }
  ]
}