共用方式為


取得服務資訊清單

取得屬於應用程式識別碼所指定應用程式之所有服務的相關資訊。

傳回屬於應用程式識別碼所指定應用程式之所有服務的相關資訊。

要求

方法 要求 URI
GET /Applications/{applicationId}/$/GetServices?ServiceTypeName={ServiceTypeName}&api-version=6.0&ContinuationToken={ContinuationToken}&timeout={timeout}

參數

名稱 類型 必要 Location
applicationId 字串 路徑
ServiceTypeName 字串 No 查詢
api-version string 查詢
ContinuationToken 字串 No 查詢
timeout 整數 (int64) No 查詢

applicationId

類型:字串
必要:是

應用程式的身分識別。 這通常是沒有 'fabric:' URI 配置之應用程式的完整名稱。 從 6.0 版開始,階層的名稱會以 "~" 字元分隔。 例如,如果應用程式名稱是 "fabric:/myapp/app1",則應用程式識別在 6.0+ 中會是 "myapp~app1",而在舊版中會是 "myapp/app1"。


ServiceTypeName

類型:字串
必要:否

用來篩選要查詢之服務的服務類型名稱。


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


ContinuationToken

類型:字串
必要:否

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


timeout

類型:整數 (int64)
必要:否
預設60
InclusiveMaximum4294967295
InclusiveMinimum1

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

回應

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