StatefulServicePartitionInfo

  • Article

Information about a partition of a stateful Service Fabric service..

Properties

Name Type Required
HealthState string (enum) No
PartitionStatus string (enum) No
PartitionInformation PartitionInformation No
TargetReplicaSetSize integer (int64) No
MinReplicaSetSize integer (int64) No
AuxiliaryReplicaCount integer (int64) No
LastQuorumLossDuration string (duration) No
PrimaryEpoch Epoch No

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.

PartitionStatus

Type: string (enum)
Required: No

The status of the service fabric service partition.

Possible values are:

  • Invalid - Indicates the partition status is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
  • Ready - Indicates that the partition is ready. This means that for a stateless service partition there is at least one instance that is up and for a stateful service partition the number of ready replicas is greater than or equal to the MinReplicaSetSize. The value is 1.
  • NotReady - Indicates that the partition is not ready. This status is returned when none of the other states apply. The value is 2.
  • InQuorumLoss - Indicates that the partition is in quorum loss. This means that number of replicas that are up and participating in a replica set is less than MinReplicaSetSize for this partition. The value is 3.
  • Reconfiguring - Indicates that the partition is undergoing reconfiguration of its replica sets. This can happen due to failover, upgrade, load balancing or addition or removal of replicas from the replica set. The value is 4.
  • Deleting - Indicates that the partition is being deleted. The value is 5.

PartitionInformation

Type: PartitionInformation
Required: No

Information about the partition identity, partitioning scheme and keys supported by it.

TargetReplicaSetSize

Type: integer (int64)
Required: No

The target replica set size as a number.

MinReplicaSetSize

Type: integer (int64)
Required: No

The minimum replica set size as a number.

AuxiliaryReplicaCount

Type: integer (int64)
Required: No

The auxiliary replica count as a number. To use Auxiliary replicas the following must be true, AuxiliaryReplicaCount < (TargetReplicaSetSize+1)/2 and TargetReplicaSetSize >=3.

LastQuorumLossDuration

Type: string (duration)
Required: No

The duration for which this partition was in quorum loss. If the partition is currently in quorum loss, it returns the duration since it has been in that state. This field is using ISO8601 format for specifying the duration.

PrimaryEpoch

Type: Epoch
Required: No

An Epoch is a configuration number for the partition as a whole. When the configuration of the replica set changes, for example when the Primary replica changes, the operations that are replicated from the new Primary replica are said to be a new Epoch from the ones which were sent by the old Primary replica.