Share via

DeployedStatefulServiceReplicaDetailInfo

  • Article

Information about a stateful replica running in a code package. Note DeployedServiceReplicaQueryResult will contain duplicate data like ServiceKind, ServiceName, PartitionId and replicaId.

Properties

Name Type Required
ServiceName string No
PartitionId string (uuid) No
CurrentServiceOperation string (enum) No
CurrentServiceOperationStartTimeUtc string (date-time) No
ReportedLoad array of LoadMetricReportInfo No
ReplicaId string No
CurrentReplicatorOperation string (enum) No
ReadStatus string (enum) No
WriteStatus string (enum) No
ReplicatorStatus ReplicatorStatus No
ReplicaStatus KeyValueStoreReplicaStatus No
DeployedServiceReplicaQueryResult DeployedStatefulServiceReplicaInfo No

ServiceName

Type: string
Required: No

Full hierarchical name of the service in URI format starting with fabric:.

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.

CurrentServiceOperation

Type: string (enum)
Required: No

Specifies the current active life-cycle operation on a stateful service replica or stateless service instance.

Possible values are:

  • Unknown - Reserved for future use.
  • None - The service replica or instance is not going through any life-cycle changes.
  • Open - The service replica or instance is being opened.
  • ChangeRole - The service replica is changing roles.
  • Close - The service replica or instance is being closed.
  • Abort - The service replica or instance is being aborted.

CurrentServiceOperationStartTimeUtc

Type: string (date-time)
Required: No

The start time of the current service operation in UTC format.

ReportedLoad

Type: array of LoadMetricReportInfo
Required: No

List of load reported by replica.

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.

CurrentReplicatorOperation

Type: string (enum)
Required: No

Specifies the operation currently being executed by the Replicator.

Possible values are:

  • Invalid - Default value if the replicator is not yet ready.
  • None - Replicator is not running any operation from Service Fabric perspective.
  • Open - Replicator is opening.
  • ChangeRole - Replicator is in the process of changing its role.
  • UpdateEpoch - Due to a change in the replica set, replicator is being updated with its Epoch.
  • Close - Replicator is closing.
  • Abort - Replicator is being aborted.
  • OnDataLoss - Replicator is handling the data loss condition, where the user service may potentially be recovering state from an external source.
  • WaitForCatchup - Replicator is waiting for a quorum of replicas to be caught up to the latest state.
  • Build - Replicator is in the process of building one or more replicas.

ReadStatus

Type: string (enum)
Required: No

Specifies the access status of the partition.

Possible values are:

  • Invalid - Indicates that the read or write operation access status is not valid. This value is not returned to the caller.
  • Granted - Indicates that the read or write operation access is granted and the operation is allowed.
  • ReconfigurationPending - Indicates that the client should try again later, because a reconfiguration is in progress.
  • NotPrimary - Indicates that this client request was received by a replica that is not a Primary replica.
  • NoWriteQuorum - Indicates that no write quorum is available and, therefore, no write operation can be accepted.

WriteStatus

Type: string (enum)
Required: No

Specifies the access status of the partition.

Possible values are:

  • Invalid - Indicates that the read or write operation access status is not valid. This value is not returned to the caller.
  • Granted - Indicates that the read or write operation access is granted and the operation is allowed.
  • ReconfigurationPending - Indicates that the client should try again later, because a reconfiguration is in progress.
  • NotPrimary - Indicates that this client request was received by a replica that is not a Primary replica.
  • NoWriteQuorum - Indicates that no write quorum is available and, therefore, no write operation can be accepted.

ReplicatorStatus

Type: ReplicatorStatus
Required: No

Represents a base class for primary or secondary replicator status. Contains information about the service fabric replicator like the replication/copy queue utilization, last acknowledgement received timestamp, etc.

ReplicaStatus

Type: KeyValueStoreReplicaStatus
Required: No

Key value store related information for the replica.

DeployedServiceReplicaQueryResult

Type: DeployedStatefulServiceReplicaInfo
Required: No

Information about a stateful service replica deployed on a node.