Get Deployed Service Replica Info List

  • Article

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.

Request

Method Request URI
GET /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetReplicas?api-version=6.0&PartitionId={PartitionId}&ServiceManifestName={ServiceManifestName}&timeout={timeout}

Parameters

Name Type Required Location
nodeName string Yes Path
applicationId string Yes Path
api-version string Yes Query
PartitionId string (uuid) No Query
ServiceManifestName string No Query
timeout integer (int64) No Query

nodeName

Type: string
Required: Yes

The name of the node.

applicationId

Type: string
Required: Yes

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 "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.

api-version

Type: string
Required: Yes
Default: 6.0

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.

PartitionId

Type: string (uuid)
Required: No

The identity of the partition.

ServiceManifestName

Type: string
Required: No

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

timeout

Type: integer (int64)
Required: No
Default: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

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.

Responses

HTTP Status Code Description Response Schema
200 (OK) A successful operation will return 200 status code and the list of deployed service replica information.
 array of DeployedServiceReplicaInfo
204 (NoContent) An empty response is returned if the specified applicationId is not found on the specified node. An empty response is also returned if there are no replicas matching the specified filter values for PartitionId or ServiceManifestName query parameters.
All other status codes The detailed error response.
 FabricError