StatefulServiceReplicaInfo

Represents a stateful service replica. This includes information about the identity, role, status, health, node name, uptime, and other details about the replica.

Properties

Name Type Required
ServiceKind string Yes
ReplicaStatus string (enum) No
HealthState string (enum) No
NodeName string No
Address string No
LastInBuildDurationInSeconds string No
ReplicaRole string (enum) No
ReplicaId string No

ServiceKind

Type: string
Required: Yes

A discriminator property. Its value must be 'Stateful' for objects of type 'StatefulServiceReplicaInfo'.


ReplicaStatus

Type: string (enum)
Required: No

The status of a replica of a service.

Possible values are:

  • Invalid - Indicates the replica status is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
  • InBuild - The replica is being built. This means that a primary replica is seeding this replica. The value is 1.
  • Standby - The replica is in standby. The value is 2.
  • Ready - The replica is ready. The value is 3.
  • Down - The replica is down. The value is 4.
  • Dropped - Replica is dropped. This means that the replica has been removed from the replica set. If it is persisted, its state has been deleted. The value is 5.

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.

NodeName

Type: string
Required: No

The name of a Service Fabric node.


Address

Type: string
Required: No

The address the replica is listening on.


LastInBuildDurationInSeconds

Type: string
Required: No

The last in build duration of the replica in seconds.


ReplicaRole

Type: string (enum)
Required: No

The role of a replica of a stateful service.

Possible values are:

  • Unknown - Indicates the initial role that a replica is created in. The value is zero.
  • None - Specifies that the replica has no responsibility in regard to the replica set. The value is 1
  • Primary - Refers to the replica in the set on which all read and write operations are complete in order to enforce strong consistency semantics. Read operations are handled directly by the Primary replica, while write operations must be acknowledged by a quorum of the replicas in the replica set. There can only be one Primary replica in a replica set at a time. The value is 2.
  • IdleSecondary - Refers to a replica in the set that receives a state transfer from the Primary replica to prepare for becoming an active Secondary replica. There can be multiple Idle Secondary replicas in a replica set at a time. Idle Secondary replicas do not count as a part of a write quorum. The value is 3.
  • ActiveSecondary - Refers to a replica in the set that receives state updates from the Primary replica, applies them, and sends acknowledgements back. Secondary replicas must participate in the write quorum for a replica set. There can be multiple active Secondary replicas in a replica set at a time. The number of active Secondary replicas is configurable that the reliability subsystem should maintain. The value is 4.

ReplicaId

Type: string
Required: No

Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id.