The response includes the name, status, ID, health, uptime, and other details about the nodes.
Supports noop? false
Parameters
nodestatus(Optional[String[1]])
— The status of the node.
api_version(Optional[String[1]])
— The version of the API. This parameter is required and its value must be '6.3'.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 version 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 accepts 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 and the runtime is 6.1, 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.
continuation_token(Optional[String[1]])
— The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded.
max_results(Optional[String[1]])
— The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message.
timeout(Optional[String[1]])
— 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.
nodedownat(Optional[String[1]])
— Date time in UTC when the node went down. If node has never been down then this value will be zero date time.
nodedowntimeinseconds(Optional[String[1]])
— Time in seconds since the node has been in NodeStatus Down. Value zero indicates node is not NodeStatus Down.
id(Optional[String[1]])
— An internal ID used by Service Fabric to uniquely identify a node. Node Id is deterministically generated from node name.
healthstate(Optional[String[1]])
— The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.
name(Optional[String[1]])
— The name of a Service Fabric node.
codeversion(Optional[String[1]])
— The version of Service Fabric binaries that the node is running.
isseednode(Optional[String[1]])
— 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.
nodedeactivationinfo(Optional[String[1]])
— Information about the node deactivation. This information is valid for a node that is undergoing deactivation or has already been deactivated.
nodeuptimeinseconds(Optional[String[1]])
— Time in seconds since the node has been in NodeStatus Up. Value zero indicates that the node is not Up.
node_status_filter(Optional[String[1]])
— Allows filtering the nodes based on the NodeStatus. Only the nodes that are matching the specified filter value will be returned. The filter value can be one of the following.
configversion(Optional[String[1]])
— The version of Service Fabric cluster manifest that the node is using.
isstopped(Optional[String[1]])
— Indicates if the node is stopped by calling stop node API or not. Returns true if the node is stopped, otherwise false.
instanceid(Optional[String[1]])
— 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.
nodeupat(Optional[String[1]])
— Date time in UTC when the node came up. If the node has never been up then this value will be zero date time.
ipaddressorfqdn(Optional[String[1]])
— The IP address or fully qualified domain name of the node.
type(Optional[String[1]])
— The type of the node.
upgradedomain(Optional[String[1]])
— The upgrade domain of the node.
faultdomain(Optional[String[1]])
— The fault domain of the node.