Fabric Client. Health Client. Get Cluster Health Async 方法

CommunicationError 当通信错误导致操作失败时，返回。

FabricTransientException

由以下原因之一引起：

ServiceTooBusy 当服务太忙而无法处理操作时，将返回。

UnauthorizedAccessException

由以下原因之一引起：

当此操作的访问检查失败时，将返回E_ACCESSDENIED。

适用于

GetClusterHealthAsync(TimeSpan, CancellationToken)

使用指定的超时和取消令牌异步获取 Service Fabric 群集的运行状况。

public System.Threading.Tasks.Task<System.Fabric.Health.ClusterHealth> GetClusterHealthAsync (TimeSpan timeout, System.Threading.CancellationToken cancellationToken);

member this.GetClusterHealthAsync : TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Health.ClusterHealth>

Public Function GetClusterHealthAsync (timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of ClusterHealth)

参数

timeout: TimeSpan

Service Fabric 在返回 TimeoutException之前允许此操作继续的最长时间。

cancellationToken: CancellationToken

操作正在观察的可选取消标记。它可用于发送应取消操作的通知。请注意，取消是建议性的，即使取消了操作，该操作仍可能已完成。

Task<ClusterHealth>

Service Fabric 群集的运行状况。

例外

FabricObjectClosedException

对象 FabricClient 处于关闭状态。释放正在使用的对象 FabricClient 并实例化新 FabricClient 对象。

ArgumentNullException

将 null 引用传递给不接受它作为有效参数的方法时返回。

ArgumentException

由以下原因之一引起：

当一个或多个参数无效时，将返回E_INVALIDARG。

TimeoutException

由以下原因之一引起：

OperationTimedOut 当操作完成所需时间超过用户提供 timeout 的时间时，将返回。

FabricException

由以下原因之一引起：

CommunicationError 当通信错误导致操作失败时，返回。

FabricTransientException

由以下原因之一引起：

ServiceTooBusy 当服务太忙而无法处理操作时，将返回。

UnauthorizedAccessException

由以下原因之一引起：

当此操作的访问检查失败时，将返回E_ACCESSDENIED。

适用于

GetClusterHealthAsync(ClusterHealthPolicy, TimeSpan, CancellationToken)

使用指定的运行状况策略、超时和取消令牌异步获取 Service Fabric 群集的运行状况。

public System.Threading.Tasks.Task<System.Fabric.Health.ClusterHealth> GetClusterHealthAsync (System.Fabric.Health.ClusterHealthPolicy healthPolicy, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);

member this.GetClusterHealthAsync : System.Fabric.Health.ClusterHealthPolicy * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Health.ClusterHealth>

Public Function GetClusterHealthAsync (healthPolicy As ClusterHealthPolicy, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of ClusterHealth)

参数

healthPolicy: ClusterHealthPolicy

用于评估群集运行状况的群集运行状况策略。

timeout: TimeSpan

Service Fabric 在返回 TimeoutException之前允许此操作继续的最长时间。

cancellationToken: CancellationToken

操作正在观察的可选取消标记。它可用于发送应取消操作的通知。请注意，取消是建议性的，即使取消了操作，该操作仍可能已完成。

Task<ClusterHealth>

Service Fabric 群集的运行状况。

例外

FabricObjectClosedException

对象 FabricClient 处于关闭状态。释放正在使用的对象 FabricClient 并实例化新 FabricClient 对象。

ArgumentNullException

将 null 引用传递给不接受它作为有效参数的方法时返回。

ArgumentException

由以下原因之一引起：

当一个或多个参数无效时，将返回E_INVALIDARG。

TimeoutException

由以下原因之一引起：

OperationTimedOut 当操作完成所需时间超过用户提供 timeout 的时间时，将返回。

FabricException

由以下原因之一引起：

CommunicationError 当通信错误导致操作失败时，返回。

FabricTransientException

由以下原因之一引起：

ServiceTooBusy 当服务太忙而无法处理操作时，将返回。

UnauthorizedAccessException

由以下原因之一引起：

当此操作的访问检查失败时，将返回E_ACCESSDENIED。

适用于

GetClusterHealthAsync(ClusterHealthQueryDescription)

使用查询说明异步获取 Service Fabric 群集的运行状况。

public System.Threading.Tasks.Task<System.Fabric.Health.ClusterHealth> GetClusterHealthAsync (System.Fabric.Description.ClusterHealthQueryDescription queryDescription);

member this.GetClusterHealthAsync : System.Fabric.Description.ClusterHealthQueryDescription -> System.Threading.Tasks.Task<System.Fabric.Health.ClusterHealth>

Public Function GetClusterHealthAsync (queryDescription As ClusterHealthQueryDescription) As Task(Of ClusterHealth)

参数

queryDescription: ClusterHealthQueryDescription

定义查询参数（如运行状况策略、筛选器等）的查询说明。

Task<ClusterHealth>

Service Fabric 群集的运行状况。

例外

FabricObjectClosedException

对象 FabricClient 处于关闭状态。释放正在使用的对象 FabricClient 并实例化新 FabricClient 对象。

ArgumentNullException

将 null 引用传递给不接受它作为有效参数的方法时返回。

ArgumentException

由以下原因之一引起：

当一个或多个参数无效时，将返回E_INVALIDARG。

TimeoutException

由以下原因之一引起：

OperationTimedOut 当操作完成时间超过指定时间时，将返回。

FabricException

由以下原因之一引起：

CommunicationError 当通信错误导致操作失败时，返回。

FabricTransientException

由以下原因之一引起：

ServiceTooBusy 当服务太忙而无法处理操作时，将返回。

UnauthorizedAccessException

由以下原因之一引起：

当此操作的访问检查失败时，将返回E_ACCESSDENIED。

适用于

GetClusterHealthAsync()

异步获取 Service Fabric 群集的运行状况。

public System.Threading.Tasks.Task<System.Fabric.Health.ClusterHealth> GetClusterHealthAsync ();

member this.GetClusterHealthAsync : unit -> System.Threading.Tasks.Task<System.Fabric.Health.ClusterHealth>

Public Function GetClusterHealthAsync () As Task(Of ClusterHealth)

Task<ClusterHealth>

Service Fabric 群集的运行状况。

例外

FabricObjectClosedException

对象 FabricClient 处于关闭状态。释放正在使用的对象 FabricClient 并实例化新 FabricClient 对象。

ArgumentNullException

将 null 引用传递给不接受它作为有效参数的方法时返回。

ArgumentException

由以下原因之一引起：

当一个或多个参数无效时，将返回E_INVALIDARG。

TimeoutException

由以下原因之一引起：

OperationTimedOut 当操作完成时间超过指定时间时，将返回。

FabricException

由以下原因之一引起：

CommunicationError 当通信错误导致操作失败时，返回。

FabricTransientException

由以下原因之一引起：

ServiceTooBusy 当服务太忙而无法处理操作时，将返回。

UnauthorizedAccessException

由以下原因之一引起：

当此操作的访问检查失败时，将返回E_ACCESSDENIED。

注解

以下示例获取群集的运行状况。

public static bool GetClusterHealth(string clusterConnection)
            {
                ClusterHealth clusterHealth;

                // Connect to the cluster.
                FabricClient fabricClient = new FabricClient(clusterConnection);

                // Get the cluster health.
                try
                {
                    clusterHealth = fabricClient.HealthManager.GetClusterHealthAsync().Result;
                }
                catch (Exception e)
                {
                    Console.WriteLine("Error: " + e.Message);

                    if (e.InnerException != null)
            Console.WriteLine("  Inner Exception: " + e.InnerException.Message);

                    return false;
                }

                // Display the cluster health state.
                Console.WriteLine("Cluster Health:");
                Console.WriteLine("  Aggregated Health State: " + clusterHealth.AggregatedHealthState);
                Console.WriteLine();

                // Display the application health states on the cluster.
                Console.WriteLine("  Application Health States:");
                IList<ApplicationHealthState> applicationHealthStateList = clusterHealth.ApplicationHealthStates;
                foreach(ApplicationHealthState applicationHealthState in applicationHealthStateList)
                {
                    Console.WriteLine("    Application {0}: {1}", applicationHealthState.ApplicationName, applicationHealthState.AggregatedHealthState);
                }

                // Display Node Health States on the cluster.
                Console.WriteLine("  Node Health States:");
                IList<NodeHealthState> nodeHealthStateList = clusterHealth.NodeHealthStates;
                foreach (NodeHealthState nodeHealthState in nodeHealthStateList)
                {
                    Console.WriteLine("    Node Name: " + nodeHealthState.NodeName);
                    Console.WriteLine("      Aggregated Health State: " + nodeHealthState.AggregatedHealthState);
                }

                // Display Health Events.
                Console.WriteLine("  Health Events:");
                IList<HealthEvent> healthEventList = clusterHealth.HealthEvents;
                foreach(HealthEvent healthEvent in healthEventList)
                {
                    Console.WriteLine("      Health Event:");
                    Console.WriteLine("        Last Modified: " + healthEvent.LastModifiedUtcTimestamp);
                    Console.WriteLine("        Source UTC Timestamp: " + healthEvent.SourceUtcTimestamp);
                    Console.WriteLine("        Is Expired: " + healthEvent.IsExpired);
                    Console.WriteLine("        Health Information:");
                    Console.WriteLine("          Description: " + healthEvent.HealthInformation.Description);
                    Console.WriteLine("          Source ID: " + healthEvent.HealthInformation.SourceId);
                    Console.WriteLine("          Health State: " + healthEvent.HealthInformation.HealthState);
                    Console.WriteLine("          Property: " + healthEvent.HealthInformation.Property);
                    Console.WriteLine("          Remove When Expired: " + healthEvent.HealthInformation.RemoveWhenExpired);
                    Console.WriteLine("          Sequence Number: " + healthEvent.HealthInformation.SequenceNumber);
                    Console.WriteLine("          Time to Live: " + healthEvent.HealthInformation.TimeToLive);
                }

                Console.WriteLine("  Unhealthy Evaluations:");
                IList<HealthEvaluation> healthEvaluationList = clusterHealth.UnhealthyEvaluations;
                foreach(HealthEvaluation healthEvaluation in healthEvaluationList)
                {
                    Console.WriteLine("    Kind: " + healthEvaluation.Kind);
                    Console.WriteLine("      Aggregated Health State: " + healthEvaluation.AggregatedHealthState);
                    Console.WriteLine("      Description: " + healthEvaluation.Description);
                }

                return true;
            }

适用于

GetClusterHealthAsync(ClusterHealthPolicy)

异步获取 Service Fabric 群集的运行状况，并使用指定的策略对其进行评估。

public System.Threading.Tasks.Task<System.Fabric.Health.ClusterHealth> GetClusterHealthAsync (System.Fabric.Health.ClusterHealthPolicy healthPolicy);

member this.GetClusterHealthAsync : System.Fabric.Health.ClusterHealthPolicy -> System.Threading.Tasks.Task<System.Fabric.Health.ClusterHealth>

Public Function GetClusterHealthAsync (healthPolicy As ClusterHealthPolicy) As Task(Of ClusterHealth)

参数

healthPolicy: ClusterHealthPolicy

用于评估群集运行状况的群集运行状况策略。

Task<ClusterHealth>

Service Fabric 群集的运行状况。

例外

FabricObjectClosedException

对象 FabricClient 处于关闭状态。释放正在使用的对象 FabricClient 并实例化新 FabricClient 对象。

ArgumentNullException

将 null 引用传递给不接受它作为有效参数的方法时返回。

ArgumentException

由以下原因之一引起：

当一个或多个参数无效时，将返回E_INVALIDARG。

TimeoutException

由以下原因之一引起：

OperationTimedOut 当操作完成时间超过指定时间时，将返回。

FabricException

由以下原因之一引起：

CommunicationError 当通信错误导致操作失败时，返回。