DeployedStatefulServiceReplicaInfo

  • Article

Information about a stateful service replica deployed on a node.

Properties

Name Type Required
ServiceName string No
ServiceTypeName string No
ServiceManifestName string No
CodePackageName string No
PartitionId string (uuid) No
ReplicaStatus string (enum) No
Address string No
ServicePackageActivationId string No
HostProcessId string No
ReplicaId string No
ReplicaRole string (enum) No
ReconfigurationInformation ReconfigurationInformation No

ServiceName

Type: string
Required: No

The full name of the service with 'fabric:' URI scheme.

ServiceTypeName

Type: string
Required: No

Name of the service type as specified in the service manifest.

ServiceManifestName

Type: string
Required: No

The name of the service manifest in which this service type is defined.

CodePackageName

Type: string
Required: No

The name of the code package that hosts this replica.

PartitionId

Type: string (uuid)
Required: No

An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.

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.

Address

Type: string
Required: No

The last address returned by the replica in Open or ChangeRole.

ServicePackageActivationId

Type: string
Required: No

The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service is 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId is always an empty string.

HostProcessId

Type: string
Required: No

Host process ID of the process that is hosting the replica. This will be zero if the replica is down. In hyper-v containers this host process ID will be from different kernel.

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.

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.
  • IdleAuxiliary - Refers to a replica in the set that receives a state transfer from the Primary replica to prepare for becoming an ActiveAuxiliary replica. There can be multiple IdleAuxiliary replicas in a replica set at a time. IdleAuxiliary replicas do not count as a part of a write quorum. The value is 5.
  • ActiveAuxiliary - Refers to a replica in the set that receives state updates from the Primary replica, applies them, and sends acknowledgements back. ActiveAuxiliary replicas must participate in the write quorum for a replica set. There can be multiple active ActiveAuxiliary replicas in a replica set at a time. The number of active ActiveAuxiliary replicas is configurable that the reliability subsystem should maintain. The value is 6.
  • PrimaryAuxiliary - Refers to the replica in the set that is used to rebuild a new Secondary replica to relinquish primary status to. It cannot field read or write requests. The value is 7.

ReconfigurationInformation

Type: ReconfigurationInformation
Required: No

Information about current reconfiguration like phase, type, previous configuration role of replica and reconfiguration start date time.