Copy Session情報の取得

GET /copysession/{copysession_id}

概要説明

指定されたCopy Session情報を取得します。

注意

Storage ClusterおよびVVOLのCopy Session情報は応答しません。

リクエスト例

Copy Session ID 2 のCopy Sessionについて、ID、Type、およびStatusのみを取得する場合の例です。

$ curl -i -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X GET "https://192.168.1.1:5665/api/v1/copysession/2?fields=type,status"

レスポンス例

{
  "copysession_id": 0,
  "copysession_href": "/api/v1/copysession/0",
  "type": "OPC",
  "status": "Active",
  "source_volume_number": 1,
  "source_volume_href": "/api/v1/volume/100001",
  "source_volume_name": "hoge#1",
  "destination_volume_number": 2,
  "destination_volume_href": "/api/v1/volume/200001",
  "destination_volume_name": "hoge#2",
  "phase": "Equivalent",
  "error_code": "b1",
  "copy_range": "Totally",
  "concurrent_suspend_result": "Running",
  "remain_time_to_finish_suspend": 33,
  "elapsed_time": 83920,
  "backup_time": "2020-12-01T12:30:00Z",
  "error_ocurrence_time": "2020-12-01T12:30:00Z",
  "total_data_size": 3812,
  "uncopied_data_size": 3812,
  "progress": 30,
  "requestor": "REST",
  "resolution": 16,
  "generation": 1,
  "generation_count": 3,
  "tracking_data_size": 34,
  "remote_copysession_id": 1,
  "transfer_mode": "Consistency",
  "split_mode": "Manual",
  "recovery_mode": "Manual",
  "remote_boxid": "00ETERNUSDXHS3ET00000A####EI000001######",
  "is_local_source_volume": true
}

Parameters

PATH PARAMETERS

copysession_id

(required)

integer

Copy Session ID。

QUERY PARAMETERS

fields

Array of strings

表示したいParameter。

指定したParameter名(Response Body Parameter)の情報のみを抜き出して取得します。

指定方法の詳細は、表示する項目の絞り込みを参照してください。

Responses

正常に取得できた場合、HTTPステータスコードが200 (OK)となりレスポンスボディを応答します。

RESPONSE BODY

copysession_id

integer

Copy Session ID。

copysession_href

string

Copy SessionのResourceへのLink。

type

string

Copy Session Type。

項目	種類
OPC	OPC Session
QuickOPC	QuickOPC Session
SnapOPC	SnapOPC Session
SnapOPCPlus	SnapOPC+ Session
EC	EC Session
REC	REC Session
Monitor	Monitor Session
XCOPY	Extended Copy Session
ODX	Offloaded Data Transfer Session

status

string

Copy Sessionのステータス。

項目	説明
Active	正常動作中。
Reserved	Copy Session ID予約中。
Suspended	一時中断中。
Halt	コピー経路異常やREC Bufferの枯渇などによりコピー中断中。 Recovery ModeがAutomaticの場合、Halt要因を復旧後に自動でコピーを再開します。 Manualの場合、復旧後に強制Suspend/Resumeにより手動で再開する必要があります。
Error	装置故障や容量不足によりコピー中止。エラー要因を復旧したあとにCopy Sessionの削除と再作成が必要です。

source_volume_number

integer

コピー元VolumeのNumber。

Copy Session StatusがReservedの場合は応答しません。

テナントユーザーの場合、コピー元Volumeが自テナント以外のものであっても応答します。

source_volume_href

string

コピー元VolumeのResourceへのLink。

Copy Session StatusがReservedの場合は応答しません。

Copy Session TypeがRECで、かつis_local_source_volumeがfalseの場合は応答しません。

テナントユーザーの場合、コピー元Volumeが自テナント以外のものであっても応答します。

source_volume_name

string

コピー元VolumeのFriendly Name。

Copy Session StatusがReservedの場合は応答しません。

Copy Session TypeがRECで、かつis_local_source_volumeがfalseの場合は応答しません。

テナントユーザーで、コピー元Volumeが自テナントに属するVolumeではない場合は応答しません。

destination_volume_number

integer

コピー先VolumeのNumber。

Copy Session TypeがMonitorの場合は応答しません。

Copy Session StatusがReservedの場合は応答しません。

テナントユーザーの場合、コピー先Volumeが自テナント以外のものであっても応答します。

destination_volume_href

string

コピー先VolumeのResourceへのLink。

Copy Session TypeがMonitorの場合は応答しません。

Copy Session StatusがReservedの場合は応答しません。

Copy Session TypeがRECで、かつis_local_source_volumeがtrueの場合は応答しません。

テナントユーザーの場合、コピー先Volumeが自テナント以外のものであっても応答します。

destination_volume_name

string

コピー先VolumeのFriendly Name。

Copy Session TypeがMonitorの場合は応答しません。

Copy Session StatusがReservedの場合は応答しません。

Copy Session TypeがRECで、かつis_local_source_volumeがtrueの場合は応答しません。

テナントユーザーで、コピー先Volumeが自テナントに属するVolumeではない場合は応答しません。

phase

string

Copy Sessionのフェーズ。

Copy Session TypeがXCOPYまたはODXの場合は応答しません。

Copy Session StatusがReservedの場合は応答しません。

Copy Session TypeがOPC、SnapOPC、またはSnapOPC+の場合、応答可能なPhaseはCopyingおよびReadyingです。

Copy Session TypeがQuickOPCの場合、応答可能なPhaseはCopying、Tracking、およびTracking_and_Copyingです。

Copy Session TypeがECまたはRECの場合、応答可能なPhaseはCopyingおよびEquivalentです。

項目	説明
Copying	OPC、SnapOPC、またはSnapOPC+の場合、コピー中。 QuickOPCの場合、更新箇所の記録を停止後、記録された更新箇所をコピー中。 EC、REC (同期モード)、またはREC (非同期Consistencyモード) の場合、コピー先Volumeにデータコピー中またはデータコピーを強制的に中断中のため、Copy先のデータ整合性は保証されていない状態。 REC (非同期Stackモード) の場合、コピー元Volumeとコピー先Volumeのデータが一致していない状態。 Monitorの場合、更新箇所を記録中。
Equivalent	EC、REC (同期モード)、またはREC (非同期Stackモード)の場合、Copy元VolumeとCopy先Volumeのデータが一致し、Copy先のデータの整合性が保証されている状態。 REC (非同期Consistencyモード)の場合、Copy先のデータの整合性が保証されている状態 (REC Bufferに未転送データがある場合は、Copy元のデータとCopy先のデータは一致していない)。
Tracking	QuickOPCでコピー完了後、更新箇所だけ記録中。
Tracking_and_Copying	QuickOPCでコピー処理中およびコピー開始時点以降の更新箇所を記録中。
Readying	コピー開始の準備中。

error_code

string

エラー発生時のエラーコード。

Copy Session StatusがReservedの場合は応答しません。

項目	説明
10 ～ 1f	コピー元ボリュームに起因するエラーです。ドライブやドライブエンクロージャの故障などが原因で、アクセスできないコピー元ボリュームがあります。
20 ～ 2f	コピー先ボリュームに起因するエラーです。ドライブやドライブエンクロージャの故障などが原因で、アクセスできないコピー先ボリュームがあります。
30 ～ 3f	コピー経路に起因するエラーです。コピー経路の状態を確認してください。
b1	カスケードコピーが設定されている状態で、カスケード元セッションにエラーが発生したため、本コピーセッションもエラー停止しました。
ba	不良セクターがあります。
bb	SDV/SDPの容量が不足しています。
bd	コピー先ボリュームまたはコピー先装置が過負荷状態です。
be	回線異常のため、RECバッファーにデータを蓄積しています。 Copy Session TypeがRECの場合だけ表示されます。
bf	回線異常のため、RECディスクバッファーにデータを蓄積しています。 Copy Session TypeがRECの場合だけ表示されます。

copy_range

string

Copy Sessionのコピー範囲。

Copy Session StatusがReservedの場合は応答しません。

項目	説明
Totally	ボリューム全体。
Extent	ボリュームの一部。

concurrent_suspend_result

string

Copy SessionのConcurrent Suspend移行状態。

Concurrent Suspendが未起動の場合もSuccessと表示します。

Copy Session TypeがECまたはRECの場合に限り応答します。

Copy Session StatusがReservedの場合は応答しません。

項目	説明
Success	Suspend移行終了。
Running	Suspend移行中。
Error	Suspend移行失敗。
Unknown	Suspend移行状態不明。

remain_time_to_finish_suspend

integer

Suspend移行完了までの予測時間。

単位は秒です。

Copy Session TypeがECまたはRECの場合に限り応答します。

Copy Session StatusがReservedの場合は応答しません。

Concurrent Suspend移行状態がRunningの場合に限り応答します。

REC経路に異常がある場合、最大値(4294967295)を応答することがあります。

elapsed_time

integer

Copy Sessionが登録されてからの経過時間。

単位は秒です。

Copy Session StatusがReservedの場合は応答しません。

backup_time

string

Copy Sessionのバックアップ開始時刻。

Copy Session StatusがError、Reserved、またはHaltの場合は応答しません。

Formatは以下です。

タイムゾーンはUTCです。

YYYY-MM-DDThh:mm:ssZ

error_ocurrence_time

string

Copy Sessionの障害発生時刻。

Copy Session StatusがErrorまたはHaltの場合に限り応答します。

Formatは以下です。

タイムゾーンはUTCです。

YYYY-MM-DDThh:mm:ssZ

total_data_size

integer

コピー対象となるデータのサイズ。

通常はCopy元VolumeのCapacityと一致します。

単位はMBです。

Copy Session StatusがReservedの場合は応答しません。

uncopied_data_size

integer

未コピーのデータサイズ。

単位はMBです。

OPC、QuickOPC、EC、またはRECの場合

Copy Session作成時は、通常はCopy元VolumeのCapacityと一致し、物理データコピーの進捗に応じて減少します。
QuickOPCの場合

リスタート (Cloneの再同期) を実施すると、前回リスタートしたときからのCopy元Volumeの差分データ量が加算されます。

0になったらバックグラウンドの物理データコピーが完了したことを示します。
ECまたはRECの場合

Copy元Volumeのデータが更新された場合、Uncopied Data Sizeは増加します。

0になったらCopy元/先のVolumeのデータが等価状態になったことを示します。
SnapOPCまたはSnapOPC+の場合

固定で0になります。

Copy Session StatusがReservedの場合は応答しません。

total_data_sizeが0の場合は応答しません。

progress

integer

物理コピー進捗率。

単位は%です。

Copy Session StatusがReservedの場合は応答しません。

total_data_sizeが0の場合は応答しません。

requestor

string

Copy Sessionを開始したクライアント。

Copy Session TypeがXCOPYまたはODXの場合は応答しません。

Copy Session StatusがReservedの場合は応答しません。

項目	説明
SCSI	コピー制御用ソフトウェアから要求されたCopy Sessionです(SCSI 経由)。
LAN	コピー制御用ソフトウェアから要求されたCopy Sessionです(LAN 経由)。
CLI	CLIコマンドから要求されたCopy Sessionです。
GUI	Web GUIから要求されたCopy Sessionです。
SMIS	SMI-Sから要求されたCopy Sessionです。
REST	RESTful APIから要求されたCopy Sessionです。

resolution

integer

Copy Sessionの倍率。

Copy Session TypeがXCOPYまたはODXの場合は応答しません。

Copy Session StatusがReservedの場合は応答しません。

generation

integer

Copy Sessionの世代。

Copy Session TypeがSnapOPC+の場合に限り応答します。

Copy Session StatusがReservedの場合は応答しません。

generation_count

integer

Copy Sessionの総世代数。

Copy Session TypeがSnapOPC+の場合に限り応答します。

Copy Session StatusがReservedの場合は応答しません。

tracking_data_size

integer

Tracking中のデータサイズ。

単位はMBです。

再同期開始時からの差分量を応答します。

Copy Session TypeがQuickOPCの場合に限り応答します。

Copy Session StatusがReservedの場合は応答しません。

remote_copysession_id

integer

接続先装置のCopy Session ID。

Copy Session TypeがRECの場合に限り応答します。

Copy Session StatusがReservedの場合は応答しません。

transfer_mode

string

Copy Sessionの転送モード。

Copy Session TypeがRECの場合に限り応答します。

Copy Session StatusがReservedの場合は応答しません。

項目	説明
Synchronous	同期モード
Through	非同期Throughモード
Stack	非同期Stackモード
Consistency	非同期Consistencyモード

split_mode

string

Copy SessionのSplitモード。

Copy Session TypeがRECの場合に限り応答します。

Copy Session StatusがReservedの場合は応答しません。

Copy Sessionの転送モードがSynchronous(同期モード)の場合に限り応答します。

項目	説明
Automatic	自動Splitモード
Manual	手動Splitモード

recovery_mode

string

Copy Sessionのリカバリーモード。

Copy Session TypeがRECの場合に限り応答します。

Copy Session StatusがReservedの場合は応答しません。

項目	説明
Automatic	自動リカバリーモード
Manual	手動リカバリーモード

remote_boxid

string

接続先装置のBox ID。

Copy Session TypeがRECの場合に限り応答します。

Copy Session StatusがReservedの場合は応答しません。

is_local_source_volume

boolean

REC Sessionのコピー元Volumeが自装置に存在するかどうか。

trueの場合、自装置をCopy元としたREC Sessionです。

falseの場合、接続先装置をCopy元としたREC Sessionです。

Copy Session TypeがRECの場合に限り応答します。

Copy Session StatusがReservedの場合は応答しません。