取得子名稱資訊清單
列舉指定名稱下的所有 Service Fabric 名稱。
列舉指定名稱下的所有 Service Fabric 名稱。 如果子名稱不符合頁面，則會傳回一頁的結果，以及可用來取得下一頁的接續權杖。 查詢不存在的名稱將會失敗。
要求
| 方法 | 要求 URI |
|---|---|
| GET | /Names/{nameId}/$/GetSubNames?api-version=6.0&Recursive={Recursive}&ContinuationToken={ContinuationToken}&timeout={timeout} |
參數
| 名稱 | 類型 | 必要 | Location |
|---|---|---|---|
nameId |
字串 | 是 | 路徑 |
api-version |
字串 | 是 | 查詢 |
Recursive |
boolean | No | 查詢 |
ContinuationToken |
字串 | No | 查詢 |
timeout |
整數 (int64) | No | 查詢 |
nameId
類型：字串
必要：是
不含 'fabric:' URI 配置的 Service Fabric 名稱。
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 版本。
Recursive
類型：布林值
必要：否
預設：false
允許指定執行的搜尋應該遞迴。
ContinuationToken
類型：字串
必要：否
接續權杖參數可用來取得下一組結果。 當來自系統的結果無法放入單一回應中時，API 的回應中會包含具有非空白值的接續權杖。 當此值傳遞至下一個 API 呼叫時，API 會傳回下一組結果。 如果沒有任何進一步的結果，接續權杖就不會包含值。 此參數的值不能經過 URL 編碼。
timeout
類型：整數 (int64)
必要：否
預設：60
InclusiveMaximum： 4294967295
InclusiveMinimum： 1
用來執行作業的伺服器逾時 (以秒為單位)。 此逾時指定了用戶端願意等候要求作業完成的持續時間。 這個參數的預設值是 60 秒。
回應
| HTTP 狀態碼 | 描述 | 回應結構描述 |
|---|---|---|
| 200 (確定) | Service Fabric 名稱的分頁清單。 |
PagedSubNameInfoList |
| 所有其他狀態碼 | 詳細的錯誤回應。 |
FabricError |
範例
取得子名稱
此範例示範如何取得指定 Service Fabric 名稱之所有子名稱的相關資訊。
要求
GET http://localhost:19080/Names/samples/$/GetSubNames?api-version=6.0
200 回應
主體
{
"ContinuationToken": "",
"IsConsistent": true,
"SubNames": [
"fabric:/samples/CalculatorApp",
"fabric:/samples/mynames"
]
}
以遞迴方式搜尋子名稱
此範例示範如何以遞迴方式取得指定 Service Fabric 名稱之所有子名稱的相關資訊。
要求
GET http://localhost:19080/Names/samples/$/GetSubNames?api-version=6.0&Recursive=True
200 回應
主體
{
"ContinuationToken": "",
"IsConsistent": true,
"SubNames": [
"fabric:/samples/apps",
"fabric:/samples/data",
"fabric:/samples/CalculatorApp",
"fabric:/samples/CalculatorApp/CalculatorService",
"fabric:/samples/CalculatorApp/CalculatorService/Name-1",
"fabric:/samples/CalculatorApp/CalculatorService/Name-2",
"fabric:/samples/mynames/name-1"
]
}
使用接續權杖的頁面
此範例示範如何使用 ContinuationToken 參數，逐頁查看指定 Service Fabric 名稱下子名稱的相關資訊。 這個參數的值是從上一個查詢提供，在此案例中，如上所示。 回應包含其餘兩個結果和空的 ContinuationToken。 空的 ContinuationToken 表示其他結果無法使用。
要求
GET http://localhost:19080/Names/samples/$/GetSubNames?api-version=6.0&Recursive=True&ContinuationToken=fabric:/samples/apps/PersistentQueueApp$131439231986491349
200 回應
主體
{
"ContinuationToken": "",
"IsConsistent": true,
"SubNames": [
"fabric:/samples/apps/VolatileQueueApp",
"fabric:/samples/apps/NotepadApp"
]
}