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

获取服务运行状况

项目
07/19/2023

获取指定 Service Fabric 服务的运行状况。

获取指定服务的运行状况信息。使用 EventsHealthStateFilter 可以根据运行状态筛选针对服务报告的运行状况事件的集合。使用 PartitionsHealthStateFilter 可以筛选返回的分区集合。如果指定运行状况存储中不存在的服务，此请求会返回错误。

请求

方法	请求 URI
GET	`/Services/{serviceId}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&PartitionsHealthStateFilter={PartitionsHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&timeout={timeout}`

参数

名称	类型	必须	位置
`serviceId`	string	是	路径
`api-version`	字符串	是	查询
`EventsHealthStateFilter`	integer	否	查询
`PartitionsHealthStateFilter`	integer	否	查询
`ExcludeHealthStatistics`	boolean	否	查询
`timeout`	整数 (int64)	否	查询

`serviceId`

类型：字符串
必需：是

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

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

`PartitionsHealthStateFilter`

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

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

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

`ExcludeHealthStatistics`

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

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

`timeout`

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

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

响应

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

通过