FabricClient.HealthClient.GetClusterHealthAsync メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
オーバーロード
| GetClusterHealthAsync(ClusterHealthQueryDescription, TimeSpan, CancellationToken) |
クエリの説明、タイムアウト、およびキャンセル トークンを使用して、Service Fabric クラスターの正常性を非同期的に取得します。 |
| GetClusterHealthAsync(TimeSpan, CancellationToken) |
指定したタイムアウトおよびキャンセル トークンを使用して、Service Fabric クラスターの正常性を非同期的に取得します。 |
| GetClusterHealthAsync(ClusterHealthPolicy, TimeSpan, CancellationToken) |
指定された正常性ポリシー、タイムアウト、およびキャンセル トークンを使用して、Service Fabric クラスターの正常性を非同期的に取得します。 |
| GetClusterHealthAsync(ClusterHealthQueryDescription) |
クエリの説明を使用して、Service Fabric クラスターの正常性を非同期的に取得します。 |
| GetClusterHealthAsync() |
Service Fabric クラスターの正常性を非同期的に取得します。 |
| GetClusterHealthAsync(ClusterHealthPolicy) |
Service Fabric クラスターの正常性を非同期的に取得し、指定したポリシーを使用して評価します。 |
GetClusterHealthAsync(ClusterHealthQueryDescription, TimeSpan, CancellationToken)
クエリの説明、タイムアウト、およびキャンセル トークンを使用して、Service Fabric クラスターの正常性を非同期的に取得します。
public System.Threading.Tasks.Task<System.Fabric.Health.ClusterHealth> GetClusterHealthAsync (System.Fabric.Description.ClusterHealthQueryDescription queryDescription, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);member this.GetClusterHealthAsync : System.Fabric.Description.ClusterHealthQueryDescription * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Health.ClusterHealth>Public Function GetClusterHealthAsync (queryDescription As ClusterHealthQueryDescription, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of ClusterHealth)パラメーター
- queryDescription
- ClusterHealthQueryDescription
正常性ポリシー、フィルターなどのクエリ パラメーターを定義したクエリの説明。
- timeout
- TimeSpan
Service Fabric が を返す TimeoutException前にこの操作を続行できる最大時間。
- cancellationToken
- CancellationToken
操作が監視している省略可能なキャンセル トークン。 操作を取り消す必要があることを示す通知を送信するために使用できます。 取り消しはアドバイザリであり、取り消された場合でも操作が完了する可能性があることに注意してください。
戻り値
Service Fabric クラスターの正常性。
例外
オブジェクトは FabricClient 閉じた状態です。 使用しているオブジェクトを FabricClient 破棄し、新しい FabricClient オブジェクトをインスタンス化します。
null 参照が有効な引数として受け入れられないメソッドに渡されるときに返されます。
次のいずれかが原因で発生します。
CommunicationError は、通信エラーが原因で操作が失敗した場合に返されます。
適用対象
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
操作が監視している省略可能なキャンセル トークン。 操作を取り消す必要があることを示す通知を送信するために使用できます。 取り消しはアドバイザリであり、取り消された場合でも操作が完了する可能性があることに注意してください。
戻り値
Service Fabric クラスターの正常性。
例外
オブジェクトは FabricClient 閉じた状態です。 使用しているオブジェクトを FabricClient 破棄し、新しい FabricClient オブジェクトをインスタンス化します。
null 参照が有効な引数として受け入れられないメソッドに渡されるときに返されます。
次のいずれかが原因で発生します。
CommunicationError は、通信エラーが原因で操作が失敗した場合に返されます。
適用対象
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
操作が監視している省略可能なキャンセル トークン。 操作を取り消す必要があることを示す通知を送信するために使用できます。 取り消しはアドバイザリであり、取り消された場合でも操作が完了する可能性があることに注意してください。
戻り値
Service Fabric クラスターの正常性。
例外
オブジェクトは FabricClient 閉じた状態です。 使用しているオブジェクトを FabricClient 破棄し、新しい FabricClient オブジェクトをインスタンス化します。
null 参照が有効な引数として受け入れられないメソッドに渡されるときに返されます。
次のいずれかが原因で発生します。
CommunicationError は、通信エラーが原因で操作が失敗した場合に返されます。
適用対象
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
正常性ポリシー、フィルターなどのクエリ パラメーターを定義するクエリの説明。
戻り値
Service Fabric クラスターの正常性。
例外
オブジェクトは FabricClient 閉じた状態です。 使用しているオブジェクトを FabricClient 破棄し、新しい FabricClient オブジェクトをインスタンス化します。
null 参照が有効な引数として受け入れられないメソッドに渡されるときに返されます。
次のいずれかが原因で発生します。
CommunicationError は、通信エラーが原因で操作が失敗した場合に返されます。
適用対象
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)戻り値
Service Fabric クラスターの正常性。
例外
オブジェクトは FabricClient 閉じた状態です。 使用しているオブジェクトを FabricClient 破棄し、新しい FabricClient オブジェクトをインスタンス化します。
null 参照が有効な引数として受け入れられないメソッドに渡されるときに返されます。
次のいずれかが原因で発生します。
CommunicationError は、通信エラーが原因で操作が失敗した場合に返されます。
注釈
次の例では、クラスターの正常性を取得します。
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
クラスターの正常性を評価するために使用されるクラスター正常性ポリシー。
戻り値
Service Fabric クラスターの正常性。
例外
オブジェクトは FabricClient 閉じた状態です。 使用しているオブジェクトを FabricClient 破棄し、新しい FabricClient オブジェクトをインスタンス化します。
null 参照が有効な引数として受け入れられないメソッドに渡されるときに返されます。
次のいずれかが原因で発生します。
CommunicationError は、通信エラーが原因で操作が失敗した場合に返されます。
適用対象
Azure SDK for .NET