Splitting ShadowImage pairs in units of copy groups

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 splits the ShadowImage pairs included in the specified copy group. If the pair is split, data can be read from or written to the secondary volume.
Tip: We recommend specifying Job-Mode-Wait-Configuration-Change:NoWait in the request header of this API function. For details, see the description of the flow of operations for the pairs.
Note: The forceSplit attribute in the action template is unnecessary. When using the action template, remove this attribute before creating a request.

Execution permission

Storage Administrator (Local Copy)

Request line

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

Request message

Object ID

Specify the localCloneCopygroupId value obtained by getting the list of copy groups. You can also specify the following attributes and connect them with commas:

copyGroupName,pvolDeviceGroupName,svolDeviceGroupName

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 device group name. Value should not exceed 31 characters. The name is case sensitive.

svolDeviceGroupName

string

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

Query parameters

None.

Body
{
  "parameters": {
    "quickMode": true,
    "copyPace": 10,
    "forceSuspend": false
  }
}

Attribute

Type

Description

quickMode

boolean

(Optional) Specify whether to run in quick mode.
  • true: Performs execution in quick mode.
  • false: Performs execution in normal mode.

If this value is omitted, false is assumed.

copyPace

int

(Optional) Specify a value in the range from 1 to 15 to be the copy speed. The larger the value, the higher the speed.

If you specify true for the forceSuspend attribute, you cannot specify this attribute.

forceSuspend

boolean

(Optional) Specify whether to force splitting of the pair.

  • true: Forces splitting of the pair.
  • false: Does not force splitting of the pair.

If this value is omitted, false is assumed.

If you specify true for this attribute, you cannot specify the copyPace attribute.

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 split copy group

Action template

GET base-URL/v1/objects/local-clone-copygroups/object-ID/actions/split

Status codes

The following table describes the meaning of the status code of the request for this operation. For details on other status codes, see the description on HTTP status codes.

Status code

Message

Description

412

Precondition Failed

The action template cannot be obtained, because the object is incorrect.

Coding example

To get an action template:

curl -v -H "Accept: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/local-clone-copygroups/localCopyGroup1,localCopyGroup1P_,localCopyGroup1S_/actions/split

To run the request after getting an action template:

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-copygroups/localCopyGroup1,localCopyGroup1P_,localCopyGroup1S_/actions/split/invoke