NodeInfo
Information about a node in Service Fabric cluster.
Properties
| Name | Type | Required |
|---|---|---|
Name |
string | No |
IpAddressOrFQDN |
string | No |
Type |
string | No |
CodeVersion |
string | No |
ConfigVersion |
string | No |
NodeStatus |
string (enum) | No |
NodeUpTimeInSeconds |
string | No |
HealthState |
string (enum) | No |
IsSeedNode |
boolean | No |
UpgradeDomain |
string | No |
FaultDomain |
string | No |
Id |
NodeId | No |
InstanceId |
string | No |
NodeDeactivationInfo |
NodeDeactivationInfo | No |
IsStopped |
boolean | No |
NodeDownTimeInSeconds |
string | No |
NodeUpAt |
string (date-time) | No |
NodeDownAt |
string (date-time) | No |
NodeTags |
array of string | No |
IsNodeByNodeUpgradeInProgress |
boolean | No |
InfrastructurePlacementID |
string | No |
Name
Type: string
Required: No
The name of a Service Fabric node.
IpAddressOrFQDN
Type: string
Required: No
The IP address or fully qualified domain name of the node.
Type
Type: string
Required: No
The type of the node.
CodeVersion
Type: string
Required: No
The version of Service Fabric binaries that the node is running.
ConfigVersion
Type: string
Required: No
The version of Service Fabric cluster manifest that the node is using.
NodeStatus
Type: string (enum)
Required: No
The status of the node.
Possible values are:
Invalid- Indicates the node status is invalid. All Service Fabric enumerations have the invalid type. The value is zero.Up- Indicates the node is up. The value is 1.Down- Indicates the node is down. The value is 2.Enabling- Indicates the node is in process of being enabled. The value is 3.Disabling- Indicates the node is in the process of being disabled. The value is 4.Disabled- Indicates the node is disabled. The value is 5.Unknown- Indicates the node is unknown. A node would be in Unknown state if Service Fabric does not have authoritative information about that node. This can happen if the system learns about a node at runtime.The value is 6.Removed- Indicates the node is removed. A node would be in Removed state if NodeStateRemoved API has been called for this node. In other words, Service Fabric has been informed that the persisted state on the node has been permanently lost. The value is 7.
NodeUpTimeInSeconds
Type: string
Required: No
Time in seconds since the node has been in NodeStatus Up. Value zero indicates that the node is not Up.
HealthState
Type: string (enum)
Required: No
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.
Possible values are:
Invalid- Indicates an invalid health state. All Service Fabric enumerations have the invalid type. The value is zero.Ok- Indicates the health state is okay. The value is 1.Warning- Indicates the health state is at a warning level. The value is 2.Error- Indicates the health state is at an error level. Error health state should be investigated, as they can impact the correct functionality of the cluster. The value is 3.Unknown- Indicates an unknown health status. The value is 65535.
IsSeedNode
Type: boolean
Required: No
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.
UpgradeDomain
Type: string
Required: No
The upgrade domain of the node.
FaultDomain
Type: string
Required: No
The fault domain of the node.
Id
Type: NodeId
Required: No
An internal ID used by Service Fabric to uniquely identify a node. Node Id is deterministically generated from node name.
InstanceId
Type: string
Required: No
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.
NodeDeactivationInfo
Type: NodeDeactivationInfo
Required: No
Information about the node deactivation. This information is valid for a node that is undergoing deactivation or has already been deactivated.
IsStopped
Type: boolean
Required: No
Indicates if the node is stopped by calling stop node API or not. Returns true if the node is stopped, otherwise false.
NodeDownTimeInSeconds
Type: string
Required: No
Time in seconds since the node has been in NodeStatus Down. Value zero indicates node is not NodeStatus Down.
NodeUpAt
Type: string (date-time)
Required: No
Date time in UTC when the node came up. If the node has never been up then this value will be zero date time.
NodeDownAt
Type: string (date-time)
Required: No
Date time in UTC when the node went down. If node has never been down then this value will be zero date time.
NodeTags
Type: array of string
Required: No
List that contains tags, which will be applied to the nodes.
IsNodeByNodeUpgradeInProgress
Type: boolean
Required: No
Indicates if a node-by-node upgrade is currently being performed on this node.
InfrastructurePlacementID
Type: string
Required: No
PlacementID used by the InfrastructureService.