Handover
POST v1/volume_collections/id/actions/handover
Description
Gracefully transfer ownership of the specified volume collection. This action can be used to pass control of the volume collection to the downstream replication partner. Ownership and full control over the volume collection will be given to the downstream replication partner. The volumes associated with the volume collection will be set to offline prior to the final snapshot being taken and replicated, thus ensuring full data synchronization as part of the transfer. By default, the new owner will automatically begin replicating the volume collection back to this node when the handover completes.
Normal Response Codes
200
HTTP Error Codes
400 401 403 404 409 500 503
Detail Codes
Request
| Parameter | Type | JSON Type | Description | Mandatory |
|---|---|---|---|---|
| id | NsObjectID | string | ID of the volume collection be handed over to the downstream replication partner. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | true |
| replication_partner_id | NsObjectID | string | ID of the new owner. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | true |
| no_reverse | NsBoolean | boolean | Do not automatically reverse direction of replication. Using this argument will prevent the new owner from automatically replicating the volume collection to this node when the handover completes. The default behavior is to enable replication back to this node. Default: 'false'. Possible values: 'true', 'false'. | false |
| invoke_on_upstream_partner | NsBoolean | boolean | Invoke handover request on upstream partner. Default: 'false'. Possible values: 'true', 'false'. | false |
JSON Request
{
"data" : {
"id":"0700000000000004d3000000000000000000000005",
"replication_partner_id":"0900000000000004d3000000000000000000000001",
"no_reverse":false,
}
}
Response
Type:
JSON Response
{
}