取得服務類型資訊清單

發行項
08/05/2023

針對 Service Fabric 叢集中已佈建應用程式類型所支援的服務類型，取得包含服務類型相關資訊的清單。

針對 Service Fabric 叢集中已佈建應用程式類型所支援的服務類型，取得包含服務類型相關資訊的清單。提供的應用程式類型必須存在。否則，會傳回 404 狀態。

要求

方法	要求 URI
GET	`/ApplicationTypes/{applicationTypeName}/$/GetServiceTypes?api-version=6.0&ApplicationTypeVersion={ApplicationTypeVersion}&timeout={timeout}`

參數

名稱	類型	必要	Location
`applicationTypeName`	字串	是	路徑
`api-version`	字串	是	查詢
`ApplicationTypeVersion`	string	是	查詢
`timeout`	整數 (int64)	No	查詢

`applicationTypeName`

類型：字串
必要：是

應用程式類型的名稱。

`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 版本。

`ApplicationTypeVersion`

類型：字串
必要：是

應用程式類型的版本。

`timeout`

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

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

回應

HTTP 狀態碼	描述	回應結構描述
200 (確定)	布建的應用程式類型所支援的服務類型清單。	ServiceTypeInfo的陣列
所有其他狀態碼	詳細的錯誤回應。	FabricError

範例

取得所有節點的相關資訊。

此範例示範如何取得 Service Fabric 叢集中布建應用程式類型所支援之服務類型的相關資訊。

要求

GET http://localhost:19080/ApplicationTypes/Application2Type/$/GetServiceTypes?api-version=6.0&ApplicationTypeVersion=1.0.0

200 回應

主體

[
  {
    "ServiceTypeDescription": {
      "IsStateful": true,
      "ServiceTypeName": "Actor1ActorServiceType",
      "PlacementConstraints": "",
      "HasPersistedState": true,
      "Kind": "Stateful",
      "Extensions": [
        {
          "Key": "__GeneratedServiceType__",
          "Value": "<GeneratedNames xmlns=\"http://schemas.microsoft.com/2015/03/fabact-no-schema\">\r\n            <DefaultService Name=\"Actor1ActorService\" />\r\n            <ReplicatorEndpoint Name=\"Actor1ActorServiceReplicatorEndpoint\" />\r\n            <ReplicatorConfigSection Name=\"Actor1ActorServiceReplicatorConfig\" />\r\n            <ReplicatorSecurityConfigSection Name=\"Actor1ActorServiceReplicatorSecurityConfig\" />\r\n            <StoreConfigSection Name=\"Actor1ActorServiceLocalStoreConfig\" />\r\n            <ServiceEndpointV2 Name=\"Actor1ActorServiceEndpointV2\" />\r\n          </GeneratedNames>"
        }
      ],
      "LoadMetrics": [],
      "ServicePlacementPolicies": []
    },
    "ServiceManifestVersion": "1.0.0",
    "ServiceManifestName": "Actor1Pkg",
    "IsServiceGroup": false
  }
]

共用方式為