你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
获取子名称信息列表
枚举给定名称下的所有 Service Fabric 名称。
枚举给定名称下的所有 Service Fabric 名称。 如果子名称不适合页面，则返回一页结果以及可用于获取下一页的继续标记。 查询不存在的名称将失败。
请求
| 方法 | 请求 URI |
|---|---|
| GET | /Names/{nameId}/$/GetSubNames?api-version=6.0&Recursive={Recursive}&ContinuationToken={ContinuationToken}&timeout={timeout} |
参数
| 名称 | 类型 | 必须 | 位置 |
|---|---|---|---|
nameId |
string | 是 | 路径 |
api-version |
字符串 | 是 | 查询 |
Recursive |
boolean | 否 | 查询 |
ContinuationToken |
字符串 | 否 | 查询 |
timeout |
整数 (int64) | 否 | 查询 |
nameId
类型：字符串
必需：是
Service Fabric 名称，不带“fabric:”URI 方案。
api-version
类型：字符串
必需：是
默认：
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
类型：布尔值
必需：否
默认：
允许指定执行的搜索应为递归。
ContinuationToken
类型：字符串
必需：否
继续标记参数用于获取下一组结果。 如果单个响应无法容纳来自系统的结果，则 API 响应中包括含有非空值的继续标记。 当此值传递到下一个 API 调用时，API 返回下一组结果。 如果没有更多结果，则该继续标记不包含值。 不应将此参数的值进行 URL 编码。
timeout
类型：整数 (int64)
必需：否
默认：
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"
]
}