Suspending REC Session

POST /copysession/{copysession_id}/suspend

Introduction

Suspends the specified REC Session.

The copy of the REC Session is suspended and the source and destination volumes become accessible as independent volumes.

During Suspend, changes to the destination and the source are recorded continuously.

By issuing "POST /copysession/{session_id}/resume", the changes that have been made after the transition to Suspend state was completed are copied and the equivalent state is restored.

Caution

  • If the transfer mode is synchronous or asynchronous consistency, the Suspend process may not complete when the Job reaches Success. An Href to indicate the progress of the suspend operation is responded to by progress_href_list in "GET /job/{job_id}". Use "GET /copysession/{copysession_id}" to verify that it is completed.

  • In the case of a Partial Error, the error information is available on the failed_resource_info_list in "GET/job/{job_id}".

  • Suspend an REC Session when the source and destination data are in the equivalent state.

  • Even if the data of the copy source and the copy destination is not in the equivalent state, it is possible to forcibly suspend, but the untransferred data remains and the data of the copy destination becomes unusable.

  • Forced Suspend is used mainly in the following cases. In other cases, in principle, do not use this function.

    • When the REC Session configuration is changed

    • When the data is restored from the connected device

    • When performing a manual recovery of a halted REC session due to a copy path error

  • You cannot specify the following REC Sessions.

    • Copy Session whose Type is not REC

    • REC Session whose Status is Error

    • REC Session in the asynchronous through transfer mode

    • When suspending an REC Session whose transfer mode is asynchronous stack, the phase is not equivalent.

    • For tenant users, REC Sessions cannot be specified if the volume in the local storage system does not belong to the tenant of the current user.

Request Examples

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

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

Indicates whether to Suspend the session forcibly.

If true, the REC Session is forcibly suspended even if the source and destination data are not in the equivalent state.

If false, the REC Session is suspended when the source and destination data are in the equivalent state.

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.