Sign in

v10

latestSwagger 2.02026-07-132477431.2 MB
Node

Gets the information about a specific node in the Service Fabric cluster.

The response includes the name, status, ID, health, uptime, and other details about the node.

get/Nodes/{nodeName}

Path parameters

nodeNamestring required

The name of the node.

Query parameters

api-version'6.0' required

The version of the API. This parameter is required and its value must be '6.0'.

Service Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.

Additionally the runtime accept any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0, but if the runtime is 6.1, in order to make it easier to write the clients, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.

timeoutinteger

The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.

Response

A successful operation will return information about the node with the specified nodeName.

Namestring

The name of a Service Fabric node.

IpAddressOrFQDNstring

The IP address or fully qualified domain name of the node.

Typestring

The type of the node.

CodeVersionstring

The version of Service Fabric binaries that the node is running.

ConfigVersionstring

The version of Service Fabric cluster manifest that the node is using.

NodeStatus'Invalid' | 'Up' | 'Down' | 'Enabling' | 'Disabling' | 'Disabled' | 'Unknown' | 'Removed'

The status of the node.

NodeUpTimeInSecondsstring

Time in seconds since the node has been in NodeStatus Up. Value zero indicates that the node is not Up.

HealthState'Invalid' | 'Ok' | 'Warning' | 'Error' | 'Unknown'

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.

IsSeedNodeboolean

Indicates if the node is a seed node or not. Returns true if the node is a seed node, otherwise false. A quorum of seed nodes are required for proper operation of Service Fabric cluster.

UpgradeDomainstring

The upgrade domain of the node.

FaultDomainstring

The fault domain of the node.

InstanceIdstring

The ID representing the node instance. While the ID of the node is deterministically generated from the node name and remains same across restarts, the InstanceId changes every time node restarts.

IsStoppedboolean

Indicates if the node is stopped by calling stop node API or not. Returns true if the node is stopped, otherwise false.

NodeDownTimeInSecondsstring

Time in seconds since the node has been in NodeStatus Down. Value zero indicates node is not NodeStatus Down.

NodeUpAtstring date-time

Date time in UTC when the node came up. If the node has never been up then this value will be zero date time.

NodeDownAtstring date-time

Date time in UTC when the node went down. If node has never been down then this value will be zero date time.

NodeTagsstring[]

List that contains tags, which will be applied to the nodes.

IsNodeByNodeUpgradeInProgressboolean

Indicates if a node-by-node upgrade is currently being performed on this node.

InfrastructurePlacementIDstring

PlacementID used by the InfrastructureService.