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

获取已部署的应用程序信息

项目
08/05/2023

获取部署在 Service Fabric 节点上的应用程序的相关信息。

如果提供的应用程序 ID 是系统应用程序的，则此查询将返回系统应用程序信息。结果包括处于活动、正在激活和正在下载状态的已部署应用程序。此查询要求节点名称对应于群集上的某个节点。如果提供的节点名称未指向群集上的任何活动 Service Fabric 节点，则查询将失败。

请求

方法	请求 URI
GET	`/Nodes/{nodeName}/$/GetApplications/{applicationId}?api-version=6.1&timeout={timeout}&IncludeHealthState={IncludeHealthState}`

参数

名称	类型	必须	位置
`nodeName`	string	是	路径
`applicationId`	字符串	是	路径
`api-version`	字符串	是	查询
`timeout`	整数 (int64)	否	查询
`IncludeHealthState`	boolean	否	查询

`nodeName`

类型：字符串
必需：是

节点的名称。

`applicationId`

类型：字符串
必需：是

应用程序的标识。这通常是不带“fabric:”URI 方案的应用程序全名。从版本 6.0 开始，分层名称以“~”字符隔开。例如，如果应用程序名称为“fabric:/myapp/app1”，则在 6.0 及更高版本中应用程序标识为“myapp~app1”，在以前的版本中为“myapp/app1”。

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

`timeout`

类型：整数 (int64)
必需：否
默认：
InclusiveMaximum： 4294967295
InclusiveMinimum： 1

执行操作的服务器超时，以秒为单位。此超时指定客户端可以等待请求的操作完成的持续时间。此参数的默认值为 60 秒。

`IncludeHealthState`

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

包含实体的运行状况。如果此参数为 false 或未指定，则返回的运行状况为“Unknown”。设置为 true，查询将并行转到节点和运行状况系统服务，然后将结果合并。因此，查询开销更高，并可能需要更长的时间。

响应

HTTP 状态代码	说明	响应架构
200 (正常)	成功的操作将返回 200 状态代码和有关已部署应用程序的信息。	DeployedApplicationInfo
204 (NoContent)	如果未在节点上部署指定的应用程序，则返回空响应。
所有其他状态代码	详细的错误响应。	FabricError

示例

按应用程序 ID 获取特定的已部署应用程序，并在结果中包含运行状况状态

此示例演示如何使用应用程序标识符获取有关部署在指定节点上的应用程序的信息。如果找到应用程序，则会返回包含 200 状态代码的信息。如果未在节点上部署指定的应用程序，则返回状态代码为 204 的空响应。

请求

GET http://localhost:19080/Nodes/_Node_0/$/GetApplications/samples~CalculatorApp?api-version=6.1&IncludeHealthState=True

200 响应

正文

{
  "Id": "samples~CalculatorApp",
  "Name": "fabric:/samples/CalculatorApp",
  "TypeName": "CalculatorApp",
  "TypeVersion": "1.0.0",
  "Status": "Active",
  "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\work",
  "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\log",
  "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\temp",
  "HealthState": "Ok"
}

204 响应

正文

响应正文为空。

通过