Get Unplaced Replica Information

  • Article

Gets the information about unplaced replica of the service.

Returns the information about the unplaced replicas of the service. If PartitionId is specified, then result will contain information only about unplaced replicas for that partition. If PartitionId is not specified, then result will contain information about unplaced replicas for all partitions of that service. If OnlyQueryPrimaries is set to true, then result will contain information only about primary replicas, and will ignore unplaced secondary replicas.

Request

Method Request URI
GET /Services/{serviceId}/$/GetUnplacedReplicaInformation?api-version=6.4&PartitionId={PartitionId}&OnlyQueryPrimaries={OnlyQueryPrimaries}&timeout={timeout}

Parameters

Name Type Required Location
serviceId string Yes Path
api-version string Yes Query
PartitionId string (uuid) No Query
OnlyQueryPrimaries boolean No Query
timeout integer (int64) No Query

serviceId

Type: string
Required: Yes

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

api-version

Type: string
Required: Yes
Default: 6.4

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

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 version 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 accepts 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 and the runtime is 6.1, 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.

OnlyQueryPrimaries

Type: boolean
Required: No
Default: false

Indicates that unplaced replica information will be queries only for primary replicas.

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) Information about the specified service.
 UnplacedReplicaInformation
All other status codes The detailed error response.
 FabricError