Sign in

v10

latestSwagger 2.02026-07-132477431.2 MB
Replica

Gets the list of replicas deployed on a Service Fabric node.

Gets the list containing the information about replicas deployed on a Service Fabric node. The information include partition ID, replica ID, status of the replica, name of the service, name of the service type, and other information. Use PartitionId or ServiceManifestName query parameters to return information about the deployed replicas matching the specified values for those parameters.

get/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetReplicas

Path parameters

nodeNamestring required

The name of the node.

applicationIdstring required

The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myappapp1" in 6.0+ and "myapp/app1" in previous versions.

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.

PartitionIdstring uuid

The identity of the partition.

ServiceManifestNamestring

The name of a service manifest registered as part of an application type in a Service Fabric cluster.

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.

ServiceTypeNamestring

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

ServiceManifestNamestring

The name of the service manifest.

CodePackageNamestring

The name of the code package defined in the service manifest.

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.

ReplicaStatus'Invalid' | 'InBuild' | 'Standby' | 'Ready' | 'Down' | 'Dropped'

The status of a replica of a service.

Addressstring

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

ServicePackageActivationIdstring

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.

HostProcessIdstring

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.