Move Auxiliary Replica

  • Article

Moves the auxiliary replica of a partition of a stateful service.

This command moves the auxiliary replica of a partition of a stateful service, respecting all constraints. CurrentNodeName can be omitted, and in that case a random auxiliary replica is chosen. NewNodeName can be omitted, and in that case the auxiliary replica is moved to a random node. If IgnoreConstraints parameter is specified and set to true, then auxiliary will be moved regardless of the constraints.

Request

Method Request URI
POST /Services/{serviceId}/$/GetPartitions/{partitionId}/$/MoveAuxiliaryReplica?api-version=8.1&CurrentNodeName={CurrentNodeName}&NewNodeName={NewNodeName}&IgnoreConstraints={IgnoreConstraints}&timeout={timeout}

Parameters

Name Type Required Location
serviceId string Yes Path
partitionId string (uuid) Yes Path
api-version string Yes Query
CurrentNodeName string No Query
NewNodeName string No Query
IgnoreConstraints 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.

partitionId

Type: string (uuid)
Required: Yes

The identity of the partition.

api-version

Type: string
Required: Yes
Default: 8.1

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

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.

CurrentNodeName

Type: string
Required: No

The name of the source node for instance move. If not specified, instance is moved from a random node.

NewNodeName

Type: string
Required: No

The name of the target node for secondary replica or instance move. If not specified, replica or instance is moved to a random node.

IgnoreConstraints

Type: boolean
Required: No
Default: false

Ignore constraints when moving a replica or instance. If this parameter is not specified, all constraints are honored.

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 request will return 200 status code.
All other status codes The detailed error response.
 FabricError