Canceling migration

REST API Reference Guide for Virtual Storage Platform 5000, Virtual Storage Platform E Series, and Virtual Storage Platform G/F Series

Version
93-07-0x
90-09-0x
88-08-10
Audience
anonymous
Part Number
MK-98RD9014-17
The following request cancels migration of the specified pair. You can use this request if you want to cancel a migration that is in progress, or if an attempted migration fails. If migration is canceled, the status of the pair reverts to SMPL.

Execution permission

Storage Administrator (Local Copy)

Request line

POST base-URL/v1/objects/local-clone-copypairs/object-ID/actions/split/invoke

Request message

Object ID

Specify the localCloneCopypairId value obtained by getting the pair information. You can also specify the following attributes and connect them with commas:

copyGroupName,pvolDeviceGroupName,svolDeviceGroupName,copyPairName

Attribute

Type

Description

copyGroupName

string

(Required) Specify the copy group name. Value should not exceed 31 characters. The name is case sensitive.

pvolDeviceGroupName

string

(Required) Specify the P-VOL (source volume) device group name. Value should not exceed 31 characters. The name is case sensitive.

svolDeviceGroupName

string

(Required) Specify the S-VOL (target volume) device group name. Value should not exceed 31 characters. The name is case sensitive.

copyPairName

string

(Required) Specify the name of the pair. Value should not exceed 31 characters. The name is case sensitive.

Query parameters

None.

Body
{
  "parameters":{
    "forceSplit": true
  }
}

Attribute

Type

Description

forceSplit

boolean

(Optional) Specify whether to cancel migration.
  • true: Cancel migration.
  • false: Do not cancel migration.

If this attribute is omitted, false is assumed.

Response message

Body

A job object is returned. For details on attributes other than affectedResources, see the section explaining job objects.

Attribute

Description

affectedResources

URL of the pair for which migration was canceled

Status codes

For details on the status codes of the request for this operation, see the description on HTTP status codes.

Coding example

curl -v -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/local-clone-copypairs/vm-cg,dgp,dgs,p1/actions/split/invoke