FabricClient.HealthClient.GetNodeHealthAsync メソッド

定義

オーバーロード

GetNodeHealthAsync(NodeHealthQueryDescription)

指定されたタイムアウトとキャンセル トークンを使用して、Service Fabric ノードの正常性を非同期的に取得します。

GetNodeHealthAsync(String)

Service Fabric ノードの正常性を非同期的に取得します。

GetNodeHealthAsync(String, ClusterHealthPolicy)

Service Fabric ノードの正常性を非同期的に取得します。

GetNodeHealthAsync(NodeHealthQueryDescription, TimeSpan, CancellationToken)

指定されたタイムアウトとキャンセル トークンを使用して、Service Fabric ノードの正常性を非同期的に取得します。

GetNodeHealthAsync(String, TimeSpan, CancellationToken)

指定されたタイムアウトとキャンセル トークンを使用して、Service Fabric ノードの正常性を非同期的に取得します。

GetNodeHealthAsync(String, ClusterHealthPolicy, TimeSpan, CancellationToken)

指定されたタイムアウトとキャンセル トークンを使用して、Service Fabric ノードの正常性を非同期的に取得します。

GetNodeHealthAsync(NodeHealthQueryDescription)

指定されたタイムアウトとキャンセル トークンを使用して、Service Fabric ノードの正常性を非同期的に取得します。

public System.Threading.Tasks.Task<System.Fabric.Health.NodeHealth> GetNodeHealthAsync (System.Fabric.Description.NodeHealthQueryDescription queryDescription);
member this.GetNodeHealthAsync : System.Fabric.Description.NodeHealthQueryDescription -> System.Threading.Tasks.Task<System.Fabric.Health.NodeHealth>
Public Function GetNodeHealthAsync (queryDescription As NodeHealthQueryDescription) As Task(Of NodeHealth)

パラメーター

queryDescription
NodeHealthQueryDescription

正常性ポリシー、フィルターなどのパラメーターを定義するクエリの説明。

戻り値

Service Fabric ノードの正常性。

例外

オブジェクトは FabricClient 閉じた状態です。 使用しているオブジェクトを FabricClient 破棄し、新しい FabricClient オブジェクトをインスタンス化します。

null 参照が有効な引数として受け入れられないメソッドに渡されたときに返されます。

次のいずれかが原因で発生します。

E_INVALIDARGは、1 つ以上の引数が無効な場合に返されます。

次のいずれかが原因で発生します。

OperationTimedOut は、操作の完了に指定した時間を超えると返されます。

次のいずれかが原因で発生します。

ServiceTooBusy は、サービスがビジー状態で操作を処理できる場合に返されます。

次のいずれかが原因で発生します。

E_ACCESSDENIEDは、この操作に対するアクセス チェックが失敗したときに返されます。

適用対象

GetNodeHealthAsync(String)

Service Fabric ノードの正常性を非同期的に取得します。

public System.Threading.Tasks.Task<System.Fabric.Health.NodeHealth> GetNodeHealthAsync (string nodeName);
member this.GetNodeHealthAsync : string -> System.Threading.Tasks.Task<System.Fabric.Health.NodeHealth>
Public Function GetNodeHealthAsync (nodeName As String) As Task(Of NodeHealth)

パラメーター

nodeName
String

Service Fabric ノード名。

戻り値

Service Fabric ノードの正常性。

例外

オブジェクトは FabricClient 閉じた状態です。 使用しているオブジェクトを FabricClient 破棄し、新しい FabricClient オブジェクトをインスタンス化します。

null 参照が有効な引数として受け入れられないメソッドに渡されたときに返されます。

次のいずれかが原因で発生します。

E_INVALIDARGは、1 つ以上の引数が無効な場合に返されます。

次のいずれかが原因で発生します。

OperationTimedOut は、操作の完了に指定した時間を超えると返されます。

次のいずれかが原因で発生します。

ServiceTooBusy は、サービスがビジー状態で操作を処理できる場合に返されます。

次のいずれかが原因で発生します。

E_ACCESSDENIEDは、この操作に対するアクセス チェックが失敗したときに返されます。

注釈

次の例では、ノードの正常性を取得します。

public static bool GetNodeHealth(string clusterConnection)
            {
                NodeHealth nodeHealth;

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

                // Get the node health.
                try
                {
                    nodeHealth = fabricClient.HealthManager.GetNodeHealthAsync("Node1").Result;
                }
                catch (Exception e)
                {
                    Console.WriteLine("Error: " + e.Message);

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

                    return false;
                }

                // Display the node health information.
                Console.WriteLine("Node Health:");
                Console.WriteLine("  Node {0}: {1}", nodeHealth.NodeName, nodeHealth.AggregatedHealthState);

                // List the health events.
                Console.WriteLine("    Health Events:");
                IList<HealthEvent> healthEvents = nodeHealth.HealthEvents;
                foreach (HealthEvent healthEvent in healthEvents)
                {
                    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);
                }

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

                Console.WriteLine(); 
                return true;
            }

適用対象

GetNodeHealthAsync(String, ClusterHealthPolicy)

Service Fabric ノードの正常性を非同期的に取得します。

public System.Threading.Tasks.Task<System.Fabric.Health.NodeHealth> GetNodeHealthAsync (string nodeName, System.Fabric.Health.ClusterHealthPolicy healthPolicy);
member this.GetNodeHealthAsync : string * System.Fabric.Health.ClusterHealthPolicy -> System.Threading.Tasks.Task<System.Fabric.Health.NodeHealth>
Public Function GetNodeHealthAsync (nodeName As String, healthPolicy As ClusterHealthPolicy) As Task(Of NodeHealth)

パラメーター

nodeName
String

Service Fabric ノード名。

healthPolicy
ClusterHealthPolicy

ノードの正常性を評価するために使用されるクラスター正常性ポリシー。

戻り値

Service Fabric ノードの正常性。

例外

オブジェクトは FabricClient 閉じた状態です。 使用しているオブジェクトを FabricClient 破棄し、新しい FabricClient オブジェクトをインスタンス化します。

null 参照が有効な引数として受け入れられないメソッドに渡されたときに返されます。

次のいずれかが原因で発生します。

E_INVALIDARGは、1 つ以上の引数が無効な場合に返されます。

次のいずれかが原因で発生します。

OperationTimedOut は、操作の完了に指定した時間を超えると返されます。

次のいずれかが原因で発生します。

ServiceTooBusy は、サービスがビジー状態で操作を処理できる場合に返されます。

次のいずれかが原因で発生します。

E_ACCESSDENIEDは、この操作に対するアクセス チェックが失敗したときに返されます。

適用対象

GetNodeHealthAsync(NodeHealthQueryDescription, TimeSpan, CancellationToken)

指定されたタイムアウトとキャンセル トークンを使用して、Service Fabric ノードの正常性を非同期的に取得します。

public System.Threading.Tasks.Task<System.Fabric.Health.NodeHealth> GetNodeHealthAsync (System.Fabric.Description.NodeHealthQueryDescription queryDescription, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);
member this.GetNodeHealthAsync : System.Fabric.Description.NodeHealthQueryDescription * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Health.NodeHealth>
Public Function GetNodeHealthAsync (queryDescription As NodeHealthQueryDescription, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of NodeHealth)

パラメーター

queryDescription
NodeHealthQueryDescription

正常性ポリシー、フィルターなどのパラメーターを定義するクエリの説明。

timeout
TimeSpan

Service Fabric が を返す TimeoutException前にこの操作を続行できる最大時間。

cancellationToken
CancellationToken

操作が監視している省略可能なキャンセル トークン。 操作を取り消す必要があることを示す通知を送信するために使用できます。 取り消しはアドバイザリであり、取り消された場合でも操作が完了する可能性があることに注意してください。

戻り値

Service Fabric ノードの正常性。

例外

オブジェクトは FabricClient 閉じた状態です。 使用しているオブジェクトを FabricClient 破棄し、新しい FabricClient オブジェクトをインスタンス化します。

null 参照が有効な引数として受け入れられないメソッドに渡されたときに返されます。

次のいずれかが原因で発生します。

E_INVALIDARGは、1 つ以上の引数が無効な場合に返されます。

次のいずれかが原因で発生します。

OperationTimedOut は、操作が完了するために指定 timeout されたユーザーを超える時間がかかる場合に返されます。

次のいずれかが原因で発生します。

ServiceTooBusy は、サービスがビジー状態で操作を処理できる場合に返されます。

次のいずれかが原因で発生します。

E_ACCESSDENIEDは、この操作に対するアクセス チェックが失敗したときに返されます。

適用対象

GetNodeHealthAsync(String, TimeSpan, CancellationToken)

指定されたタイムアウトとキャンセル トークンを使用して、Service Fabric ノードの正常性を非同期的に取得します。

public System.Threading.Tasks.Task<System.Fabric.Health.NodeHealth> GetNodeHealthAsync (string nodeName, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);
member this.GetNodeHealthAsync : string * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Health.NodeHealth>
Public Function GetNodeHealthAsync (nodeName As String, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of NodeHealth)

パラメーター

nodeName
String

Service Fabric ノード。

timeout
TimeSpan

Service Fabric が を返す TimeoutException前にこの操作を続行できる最大時間。

cancellationToken
CancellationToken

操作が監視している省略可能なキャンセル トークン。 操作を取り消す必要があることを示す通知を送信するために使用できます。 取り消しはアドバイザリであり、取り消された場合でも操作が完了する可能性があることに注意してください。

戻り値

Service Fabric ノードの正常性。

例外

オブジェクトは FabricClient 閉じた状態です。 使用しているオブジェクトを FabricClient 破棄し、新しい FabricClient オブジェクトをインスタンス化します。

null 参照が有効な引数として受け入れられないメソッドに渡されたときに返されます。

次のいずれかが原因で発生します。

E_INVALIDARGは、1 つ以上の引数が無効な場合に返されます。

次のいずれかが原因で発生します。

OperationTimedOut は、操作が完了するために指定 timeout されたユーザーを超える時間がかかる場合に返されます。

次のいずれかが原因で発生します。

ServiceTooBusy は、サービスがビジー状態で操作を処理できる場合に返されます。

次のいずれかが原因で発生します。

E_ACCESSDENIEDは、この操作に対するアクセス チェックが失敗したときに返されます。

適用対象

GetNodeHealthAsync(String, ClusterHealthPolicy, TimeSpan, CancellationToken)

指定されたタイムアウトとキャンセル トークンを使用して、Service Fabric ノードの正常性を非同期的に取得します。

public System.Threading.Tasks.Task<System.Fabric.Health.NodeHealth> GetNodeHealthAsync (string nodeName, System.Fabric.Health.ClusterHealthPolicy healthPolicy, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);
member this.GetNodeHealthAsync : string * System.Fabric.Health.ClusterHealthPolicy * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Health.NodeHealth>
Public Function GetNodeHealthAsync (nodeName As String, healthPolicy As ClusterHealthPolicy, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of NodeHealth)

パラメーター

nodeName
String

Service Fabric ノード。

healthPolicy
ClusterHealthPolicy

ノードの正常性を評価するために使用されるクラスター正常性ポリシー。

timeout
TimeSpan

Service Fabric が を返す TimeoutException前にこの操作を続行できる最大時間。

cancellationToken
CancellationToken

操作が監視している省略可能なキャンセル トークン。 操作を取り消す必要があることを示す通知を送信するために使用できます。 取り消しはアドバイザリであり、取り消された場合でも操作が完了する可能性があることに注意してください。

戻り値

Service Fabric ノードの正常性。

例外

オブジェクトは FabricClient 閉じた状態です。 使用しているオブジェクトを FabricClient 破棄し、新しい FabricClient オブジェクトをインスタンス化します。

null 参照が有効な引数として受け入れられないメソッドに渡されたときに返されます。

次のいずれかが原因で発生します。

E_INVALIDARGは、1 つ以上の引数が無効な場合に返されます。

次のいずれかが原因で発生します。

OperationTimedOut は、操作が完了するために指定 timeout されたユーザーを超える時間がかかる場合に返されます。

次のいずれかが原因で発生します。

ServiceTooBusy は、サービスがビジー状態で操作を処理できる場合に返されます。

次のいずれかが原因で発生します。

E_ACCESSDENIEDは、この操作に対するアクセス チェックが失敗したときに返されます。

適用対象