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

HealthInformation

项目
07/19/2023

表示常见的运行状况报告信息。它包含在发送到运行状况存储的所有运行状况报告以及运行状况查询返回的所有运行状况事件中。

属性

名称	类型	必须
`SourceId`	string	是
`Property`	字符串	是
`HealthState`	string (枚举)	是
`TimeToLiveInMilliSeconds`	字符串 (持续时间)	否
`Description`	字符串	否
`SequenceNumber`	字符串	否
`RemoveWhenExpired`	boolean	否
`HealthReportId`	字符串	否

`SourceId`

类型：字符串
必需：是

标识已生成运行状况信息的客户端/监视程序/系统组件的源名称。

`Property`

类型：字符串
必需：是

运行状况信息的属性。一个实体可以有不同属性的运行状况报告。该属性是一个字符串，不是固定的枚举，因此可使报告器灵活地对触发报告的状态条件进行分类。例如，SourceId 为“LocalWatchdog”的报告器可以监视节点上的可用磁盘的状态，因此它可以报告该节点的“AvailableDisk”属性。同一报告器可以监视节点连接，因此它可以报告同一节点的“Connectivity”属性。在运行状况存储中，这些报告均被视为指定节点的单独运行状况事件。

与 SourceId 一起，该属性唯一地标识运行状况信息。

`HealthState`

类型：字符串 (枚举)
必需：是

Service Fabric 实体（例如群集、节点、应用程序、服务、分区、副本等）的运行状况。

可能的值包括：

Invalid - 指示无效的运行状况。所有 Service Fabric 枚举的类型无效。值为 0。
Ok - 指示运行状况正常。值为 1。
Warning - 指示运行状况处于警告级别。值为 2。
Error - 指示运行状况处于错误级别。应调查错误运行状况，因为它们可能会影响群集的正确功能。值为 3。
Unknown - 指示未知的运行状况。值为 65535。

`TimeToLiveInMilliSeconds`

类型：字符串 (持续时间)
必需：否

此运行状况报告保持有效的持续时间。此字段将 ISO8601 格式用于指定该持续时间。当客户端定期报告时，它们应以高于生存时间的频率发送报告。如果客户端以非定期的方式报告，它们可以将生存时间设置为无限。生存时间过期时，包含运行状况信息的运行状况事件将从运行状况存储中删除（如果 RemoveWhenExpired 为 true），或者将会评估为处于错误状态（如果 RemoveWhenExpired 为 false）。

如果未指定，生存时间将默认为无限值。

`Description`

类型：字符串
必需：否

运行状况信息的说明。它表示用于添加有关该报告的用户可读信息的自定义文本。该说明的最大字符串长度为 4096 个字符。如果所提供字符串的长度大于该值，它将被自动截断。截断时，该说明的末尾字符包含一个标记“[Truncated]”，并且总字符串大小为 4096 个字符。该标记的存在向用户指示截断已发生。请注意，当截断时，该说明包含来自原始字符串的 4096 个以内的字符。

`SequenceNumber`

类型：字符串
必需：否

此运行状况报告的序列号（采用数字字符串形式）。报告序列号由运行状况存储用来检测过时的报告。如果未指定，序列号将在报告被添加时由运行状况客户端自动生成。

`RemoveWhenExpired`

类型：布尔值
必需：否

该值指示是否在报告过期时从运行状况存储删除该报告。如果设置为 true，报告在过期后将从运行状况存储中删除。如果设置为 false，报告在过期时将被视为错误。此属性的值在默认情况下为 false。当客户端定期报告时，它们应将 RemoveWhenExpired 设置为 false（默认值）。这样，如果报告器 (出现问题（例如死锁) 且无法报告），则会在运行状况报告过期时以错误方式评估实体。这会将该实体标记为处于“Error”运行状况状态。

`HealthReportId`

类型：字符串
必需：否

一个运行状况报告 ID，用于标识运行状况报告，可用于在 aka.ms/sfhealthid

通过