FabricClient.HealthClient.GetPartitionHealthAsync メソッド

定義

オーバーロード

GetPartitionHealthAsync(Guid, TimeSpan, CancellationToken)

指定したタイムアウトおよびキャンセル トークンを使用して、Service Fabric パーティションの正常性を非同期的に取得します。

GetPartitionHealthAsync(PartitionHealthQueryDescription, TimeSpan, CancellationToken)

指定したタイムアウトおよびキャンセル トークンを使用して、Service Fabric パーティションの正常性を非同期的に取得します。

GetPartitionHealthAsync(Guid, ApplicationHealthPolicy, TimeSpan, CancellationToken)

指定したタイムアウトおよびキャンセル トークンを使用して、Service Fabric パーティションの正常性を非同期的に取得します。

GetPartitionHealthAsync(Guid)

Service Fabric パーティションの正常性を非同期的に取得します。

GetPartitionHealthAsync(PartitionHealthQueryDescription)

指定したタイムアウトおよびキャンセル トークンを使用して、Service Fabric パーティションの正常性を非同期的に取得します。

GetPartitionHealthAsync(Guid, ApplicationHealthPolicy)

Service Fabric パーティションの正常性を非同期的に取得します。

GetPartitionHealthAsync(Guid, TimeSpan, CancellationToken)

指定したタイムアウトおよびキャンセル トークンを使用して、Service Fabric パーティションの正常性を非同期的に取得します。

public System.Threading.Tasks.Task<System.Fabric.Health.PartitionHealth> GetPartitionHealthAsync (Guid partitionId, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);
member this.GetPartitionHealthAsync : Guid * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Health.PartitionHealth>
Public Function GetPartitionHealthAsync (partitionId As Guid, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of PartitionHealth)

パラメーター

partitionId
Guid

Service Fabric パーティションの ID。

timeout
TimeSpan

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

cancellationToken
CancellationToken

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

戻り値

Service Fabric パーティションの正常性。

例外

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

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

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

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

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

OperationTimedOut は、操作が完了するために指定 timeout されたユーザーよりも多くかかる場合に返されます。

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

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

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

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

適用対象

GetPartitionHealthAsync(PartitionHealthQueryDescription, TimeSpan, CancellationToken)

指定したタイムアウトおよびキャンセル トークンを使用して、Service Fabric パーティションの正常性を非同期的に取得します。

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

パラメーター

queryDescription
PartitionHealthQueryDescription

クエリの説明。

timeout
TimeSpan

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

cancellationToken
CancellationToken

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

戻り値

Service Fabric パーティションの正常性。

例外

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

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

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

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

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

OperationTimedOut は、操作が完了するために指定 timeout されたユーザーよりも多くかかる場合に返されます。

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

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

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

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

適用対象

GetPartitionHealthAsync(Guid, ApplicationHealthPolicy, TimeSpan, CancellationToken)

指定したタイムアウトおよびキャンセル トークンを使用して、Service Fabric パーティションの正常性を非同期的に取得します。

public System.Threading.Tasks.Task<System.Fabric.Health.PartitionHealth> GetPartitionHealthAsync (Guid partitionId, System.Fabric.Health.ApplicationHealthPolicy healthPolicy, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);
member this.GetPartitionHealthAsync : Guid * System.Fabric.Health.ApplicationHealthPolicy * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Health.PartitionHealth>
Public Function GetPartitionHealthAsync (partitionId As Guid, healthPolicy As ApplicationHealthPolicy, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of PartitionHealth)

パラメーター

partitionId
Guid

Service Fabric パーティションの ID。

healthPolicy
ApplicationHealthPolicy

エンティティの正常性を評価するために使用されるアプリケーション正常性ポリシー。

timeout
TimeSpan

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

cancellationToken
CancellationToken

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

戻り値

Service Fabric パーティションの正常性。

例外

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

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

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

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

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

OperationTimedOut は、操作が完了するために指定 timeout されたユーザーよりも多くかかる場合に返されます。

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

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

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

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

適用対象

GetPartitionHealthAsync(Guid)

Service Fabric パーティションの正常性を非同期的に取得します。

public System.Threading.Tasks.Task<System.Fabric.Health.PartitionHealth> GetPartitionHealthAsync (Guid partitionId);
member this.GetPartitionHealthAsync : Guid -> System.Threading.Tasks.Task<System.Fabric.Health.PartitionHealth>
Public Function GetPartitionHealthAsync (partitionId As Guid) As Task(Of PartitionHealth)

パラメーター

partitionId
Guid

Service Fabric パーティションの ID。

戻り値

Service Fabric パーティションの正常性。

例外

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

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

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

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

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

OperationTimedOut は、操作の完了に指定した時間以上かかる場合に返されます。

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

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

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

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

注釈

次の例では、パーティションの正常性を取得します。

public static bool GetPartitionHealth(string clusterConnection)
            {
                PartitionHealth partitionHealth;

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

                // Get the partition health.
                try
                {
                    partitionHealth = fabricClient.HealthManager.GetPartitionHealthAsync(new Guid("a7206315-e53b-4d05-b59c-e210caa28893")).Result;
                }
                catch (Exception e)
                {
                    Console.WriteLine("Error: " + e.Message);

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

                    return false;
                }

                // Display the partition health information.
                Console.WriteLine("Partition Health:");
                Console.WriteLine("  Partition ID: " + partitionHealth.PartitionId);
                Console.WriteLine("    Aggregated Health State: " + partitionHealth.AggregatedHealthState);

                // List the health events.
                Console.WriteLine("    Health Events:");
                IList<HealthEvent> healthEvents = partitionHealth.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 replica health states.
                Console.WriteLine("    Replica Health States:");
                IList<ReplicaHealthState> replicaHealthStates = partitionHealth.ReplicaHealthStates;
                foreach (ReplicaHealthState replicaHealthState in replicaHealthStates)
                {
                    Console.WriteLine("      ID: " + replicaHealthState.Id);
                    Console.WriteLine("        Kind: " + replicaHealthState.Kind);
                    Console.WriteLine("        Aggregated Health State: " + replicaHealthState.AggregatedHealthState);
                    Console.WriteLine("        Partition ID: " + replicaHealthState.PartitionId);
                }

                // List the unhealthy evaluations.
                Console.WriteLine("    Unhealthy Evaluations:");
                IList<HealthEvaluation> healthEvaluationList = partitionHealth.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;
            }

適用対象

GetPartitionHealthAsync(PartitionHealthQueryDescription)

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

public System.Threading.Tasks.Task<System.Fabric.Health.PartitionHealth> GetPartitionHealthAsync (System.Fabric.Description.PartitionHealthQueryDescription queryDescription);
member this.GetPartitionHealthAsync : System.Fabric.Description.PartitionHealthQueryDescription -> System.Threading.Tasks.Task<System.Fabric.Health.PartitionHealth>
Public Function GetPartitionHealthAsync (queryDescription As PartitionHealthQueryDescription) As Task(Of PartitionHealth)

パラメーター

queryDescription
PartitionHealthQueryDescription

クエリの説明。

戻り値

Service Fabric パーティションの正常性。

例外

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

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

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

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

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

OperationTimedOut は、操作の完了に指定した時間以上かかる場合に返されます。

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

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

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

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

適用対象

GetPartitionHealthAsync(Guid, ApplicationHealthPolicy)

Service Fabric パーティションの正常性を非同期的に取得します。

public System.Threading.Tasks.Task<System.Fabric.Health.PartitionHealth> GetPartitionHealthAsync (Guid partitionId, System.Fabric.Health.ApplicationHealthPolicy healthPolicy);
member this.GetPartitionHealthAsync : Guid * System.Fabric.Health.ApplicationHealthPolicy -> System.Threading.Tasks.Task<System.Fabric.Health.PartitionHealth>
Public Function GetPartitionHealthAsync (partitionId As Guid, healthPolicy As ApplicationHealthPolicy) As Task(Of PartitionHealth)

パラメーター

partitionId
Guid

Service Fabric パーティションの ID。

healthPolicy
ApplicationHealthPolicy

エンティティの正常性を評価するために使用されるアプリケーション正常性ポリシー。

戻り値

Service Fabric パーティションの正常性。

例外

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

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

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

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

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

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

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

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

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

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

適用対象