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

使用策略获取已部署的服务包运行状况

获取有关使用指定策略在Service Fabric节点上部署的特定应用程序的服务包运行状况的信息。

针对 Service Fabric 节点部署的特定应用程序,获取其服务包运行状况的相关信息。 使用指定的策略。 使用 EventsHealthStateFilter 可以选择性地根据运行状况筛选部署的服务包上报告的 HealthEvent 对象的集合。 使用 ApplicationHealthPolicy 选择性地替代用于评估运行状况的运行状况策略。 此 API 仅使用 ApplicationHealthPolicy 的“ConsiderWarningAsError”字段。 评估已部署的服务包的运行状况时,将忽略其余字段。

请求

方法 请求 URI
POST /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&timeout={timeout}

参数

名称 类型 必需 位置
nodeName string 路径
applicationId 字符串 路径
servicePackageName 字符串 路径
api-version 字符串 查询
EventsHealthStateFilter integer 查询
timeout integer (int64) 查询
ApplicationHealthPolicy ApplicationHealthPolicy Body

nodeName

类型:字符串
必需:是

节点的名称。


applicationId

类型:字符串
必需:是

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


servicePackageName

类型:字符串
必需:是

服务包的名称。


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


EventsHealthStateFilter

类型:整数
必需:否
默认

用于根据运行状况筛选返回的 HealthEvent 对象集合。 此参数的可能值包括以下运行状态之一的整数值。 仅返回与筛选器匹配的事件。 所有事件用于评估聚合运行状态。 如果未指定,则返回所有项。 状态值为基于标志的枚举,因此该值可以是使用按位“OR”运算符获取的值的组合。 例如,如果提供的值为 6,则返回 HealthState 值为 OK (2) 和 Warning (4) 的所有事件。

  • 默认值 - 默认值。 匹配任何 HealthState。 值为 0。
  • 无 - 与任何 HealthState 值不匹配的筛选器。 未返回有关给定状态集合的结果时使用。 值为 1。
  • 确定 - 与 HealthState 值 Ok 匹配输入的筛选器。 值为 2。
  • Warning - 与 HealthState 值 Warning 匹配输入的筛选器。 值为 4。
  • 错误 - 与 HealthState 值 Error 匹配输入的筛选器。 值为 8。
  • All - 与任何 HealthState 值的输入匹配的筛选器。 值为 65535。

timeout

类型:整数 (int64)
必需:否
默认
InclusiveMaximum4294967295
InclusiveMinimum1

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


ApplicationHealthPolicy

类型ApplicationHealthPolicy
必需:否

描述用于评估应用程序或其子级的运行状况的运行状况策略。 如果不存在,运行状况评估将使用应用程序清单中的运行状况策略或默认运行状况策略。

响应

HTTP 状态代码 描述 响应架构
200 (正常) 成功的操作将返回 200 状态代码,以及特定节点和应用程序的已部署服务包的运行状况信息。
DeployedServicePackageHealth
所有其他状态代码 详细的错误响应。
FabricError