FabricClient.QueryClient.GetNodeLoadInformationAsync Method

Reference

Definition

Namespace:: System.Fabric

Assembly:: System.Fabric.dll

Package:: Microsoft.ServiceFabric v9.1.1833

Package:: Microsoft.ServiceFabric v8.2.1748

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Overloads

GetNodeLoadInformationAsync(String)	Get metrics and load information on the node.
GetNodeLoadInformationAsync(String, TimeSpan, CancellationToken)	Get metrics and load information on the node.

GetNodeLoadInformationAsync(String)

Get metrics and load information on the node.

public System.Threading.Tasks.Task<System.Fabric.Query.NodeLoadInformation> GetNodeLoadInformationAsync (string nodeName);

member this.GetNodeLoadInformationAsync : string -> System.Threading.Tasks.Task<System.Fabric.Query.NodeLoadInformation>

Public Function GetNodeLoadInformationAsync (nodeName As String) As Task(Of NodeLoadInformation)

Parameters

nodeName: String

The name of the node. This is a case-sensitive exact match. If the node name does not match any node on the cluster, an empty NodeLoadInformation is returned.

Returns

Task<NodeLoadInformation>

A task that represents the asynchronous query operation.

The returned task contains the load information of the node as NodeLoadInformation.

Exceptions

FabricObjectClosedException

See https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions for handling common FabricClient failures.

TimeoutException

This operation has a timeout of 60 seconds.

See https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions for handling common FabricClient failures.

FabricException

See also https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions for handling common FabricClient failures.

Applies to

GetNodeLoadInformationAsync(String, TimeSpan, CancellationToken)

Get metrics and load information on the node.

public System.Threading.Tasks.Task<System.Fabric.Query.NodeLoadInformation> GetNodeLoadInformationAsync (string nodeName, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);

member this.GetNodeLoadInformationAsync : string * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Query.NodeLoadInformation>

Public Function GetNodeLoadInformationAsync (nodeName As String, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of NodeLoadInformation)

Parameters

nodeName: String

The name of the node. This is a case-sensitive exact match. If the node name does not match any node on the cluster, an empty NodeLoadInformation is returned.