通过

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

使用策略获取分区运行状况

  • 项目

使用指定的运行状况策略获取指定 Service Fabric 分区的运行状况。

获取指定分区的运行状况信息。 如果指定了应用程序运行状况策略，运行状况评估会使用它来获取聚合的运行状况状态。 如果未指定策略，运行状况评估将使用应用程序清单中定义的应用程序运行状况策略;如果未在清单中定义任何策略，则使用默认运行状况策略。 使用 EventsHealthStateFilter 根据运行状况筛选分区上报告的运行状况事件的集合。 使用 ReplicasHealthStateFilter 可以筛选分区上 ReplicaHealthState 对象的集合。 在 POST 正文中使用 ApplicationHealthPolicy 替代用于评估运行状况的运行状况策略。 如果指定运行状况存储中不存在的分区，此请求会返回错误。

请求

方法 请求 URI
POST /Partitions/{partitionId}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&ReplicasHealthStateFilter={ReplicasHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&timeout={timeout}

参数

名称 类型 必须 位置
partitionId string (uuid) 是 路径
api-version 字符串 是 查询
EventsHealthStateFilter integer 否 查询
ReplicasHealthStateFilter integer 否 查询
ExcludeHealthStatistics boolean 否 查询
timeout 整数 (int64) 否 查询
ApplicationHealthPolicy ApplicationHealthPolicy 否 正文

partitionId

类型：uuid) (字符串
必需：是

分区的标识。

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。
  • Ok - 与 HealthState 值为 Ok 的输入匹配的筛选器。 值为 2。
  • 警告 - 与 HealthState 值为 Warning 的输入匹配的筛选器。 值为 4。
  • 错误 - 与 HealthState 值为 Error 的输入匹配的筛选器。 值为 8。
  • All - 与具有任何 HealthState 值的输入匹配的筛选器。 值为 65535。

ReplicasHealthStateFilter

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

用于筛选分区中 ReplicaHealthState 对象的集合。 可从位运算的成员或 HealthStateFilter 的成员获取该值。 只会返回与筛选器匹配的副本。 所有副本都会用于评估聚合运行状态。 如果未指定，将返回所有条目。状态值为基于标志的枚举，因此该值可以是使用按位“OR”运算符获取的值的组合。 例如，如果提供的值为 6，则会返回 HealthState 值为 OK (2) 和 Warning (4) 的所有事件。 此参数的可能值包括以下运行状态之一的整数值。

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

ExcludeHealthStatistics

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

指示运行状况统计数据是否应作为查询结果的一部分返回。 默认值为 False。 统计信息显示处于 Ok、Warning 和 Error 运行状况的子实体数。

timeout

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

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

ApplicationHealthPolicy

类型： ApplicationHealthPolicy
必需：否

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

响应

HTTP 状态代码 说明 响应架构
200 (正常) 成功的操作将返回 200 状态代码和有关指定分区的运行状况信息。
 PartitionHealth
所有其他状态代码 详细的错误响应。
 FabricError