你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

获取应用程序信息列表

  • 项目

获取在 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}

参数

名称 类型 必须 位置
api-version string 是 查询
ApplicationDefinitionKindFilter integer 否 查询
ApplicationTypeName 字符串 否 查询
ExcludeApplicationParameters boolean 否 查询
ContinuationToken 字符串 否 查询
MaxResults 整数 (int64) 否 查询
timeout 整数 (int64) 否 查询

api-version

类型：字符串
必需：是
默认：

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

类型：整数
必需：否
默认：

用来筛选 ApplicationDefinitionKind，它是用来定义 Service Fabric 应用程序的机制。

  • 默认值 - 默认值，它执行与选择“全部”相同的功能。 值为 0。
  • All - 与任何 ApplicationDefinitionKind 值的输入匹配的筛选器。 值为 65535。
  • ServiceFabricApplicationDescription - 与 ApplicationDefinitionKind 值 ServiceFabricApplicationDescription 的输入匹配的筛选器。 值为 1。
  • Compose - 与 ApplicationDefinitionKind 值 Compose 的输入匹配的筛选器。 值为 2。

ApplicationTypeName

类型：字符串
必需：否

用于筛选要查询的应用程序的应用程序类型名称。 此值不应包含应用程序类型版本。

ExcludeApplicationParameters

类型：布尔值
必需：否
默认：

该标志指定应用程序参数是否排除在结果之外。

ContinuationToken

类型：字符串
必需：否

继续标记参数用于获取下一组结果。 如果单个响应无法容纳来自系统的结果，则 API 响应中包括含有非空值的继续标记。 当此值传递到下一个 API 调用时，API 返回下一组结果。 如果没有更多结果，则该继续标记不包含值。 不应将此参数的值进行 URL 编码。

MaxResults

类型：整数 (int64)
必需：否
默认：
InclusiveMinimum： 0

作为分页查询的一部分返回的最大结果数。 此参数定义返回结果数的上限。 如果根据配置中定义的最大消息大小限制，无法将这些结果容纳到消息中，则返回的结果数可能小于指定的最大结果数。 如果此参数为零或者未指定，则分页查询包含返回消息中最多可容纳的结果数。

timeout

类型：整数 (int64)
必需：否
默认：
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"
    }
  ]
}