Deleting a Copy Session

DELETE /copysession/{copysession_id}

Introduction

Deletes the specified Copy Session.

Caution

  • The following Copy Session Types can be removed: OPC, QuickOPC, SnapOPC, SnapOPC+, EC, and REC.

  • Use "Delete /volume" when removing the Copy Session and the destination Volume together.

  • In the case of OPC or SnapOPC, even if you specify forced deletion, the same processing as normal deletion is performed.

  • If you are in the process of copying data when you delete a QuickOPC Session (If Phase was Copying_and_Tracking), delete the Copy Session after the data copy is complete. To delete the Copy Session before the data copy is completed, perform a force deletion.

  • When removing a non-latest generation of SnapOPC+ Session, the process to ensure consistency of the copy data across generations is asynchronous with the session removal. To remove a Session immediately without taking any steps to ensure generational integrity, perform a force deletion. However, if you force-delete an SnapOPC+ Session, sessions of the previous generation are also stopped.

  • When removing EC/REC Session, the source and destination must be in equality (Phase is equivalent). To remove a Copy Session that is not maintaining equality (Phase is Copying), perform a force removal.

  • When the REC Session is forcibly deleted, if the copy path cannot communicate, the copy session information may remain on the connected device. In this case, delete the remaining Session from the connected device.

  • An REC Session with asynchronous consistency transfer mode can only be force-deleted. To delete an REC Session after completing a running copy of the data, force the deletion after suspending the REC Session.

  • Copy Sessions cannot be deleted by tenant users for the following cases.

    • Neither the copy source volume nor the copy destination volume belongs to the tenant of the current user.

    • The Copy Session Type is REC.

Request Examples

  • This is an example of deleting a Copy Session with Copy Session ID 2.
    $ curl -i -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X DELETE "https://192.168.1.1:5665/api/v1/copysession/2"

Response Examples

{
  "job_id": 8192001,
  "job_href": "/api/v1/job/8192001"
}

Parameters

PATH PARAMETERS

copysession_id

(required)

integer

Copy Session ID.

QUERY PARAMETERS

force

boolean

Default: false

Whether the deletion is forced.

If true, forces the deletion of the Copy Session.

If a Copy Session is forcibly removed, the destination Volume is essentially unreachable because the current data copy is interrupted and the Copy Session is removed.

Responses

If the job registration is successful, the HTTP status code will be 202 (Accepted) and the response body will respond.

RESPONSE BODY

job_id

integer

Job ID.
job_href

string

Resource link of the job.