v10

latestSwagger 2.02026-07-132477431.2 MB
Replica

Gets the details of replica deployed on a Service Fabric node.

Gets the details of the replica deployed on a Service Fabric node. The information includes service kind, service name, current service operation, current service operation start date time, partition ID, replica/instance ID, reported load, and other information.

get/Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas/{replicaId}/$/GetDetail

Path parameters

nodeNamestring required

The name of the node.

partitionIdstring uuid required

The identity of the partition.

replicaIdstring required

The identifier of the replica.

Query parameters

api-version'6.0' required

The version of the API. This parameter is required and its value must be '6.0'.

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 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 accept 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, but if the runtime is 6.1, in order to make it easier to write the clients, 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.

timeoutinteger

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.

Response

A successful operation will return 200 status code and the list of deployed service replica information.

ServiceKind'Invalid' | 'Stateless' | 'Stateful' required

The kind of service (Stateless or Stateful).

ServiceNamestring

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

PartitionIdstring uuid

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'Unknown' | 'None' | 'Open' | 'ChangeRole' | 'Close' | 'Abort'

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

CurrentServiceOperationStartTimeUtcstring date-time

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