VolumeのCopy Session情報の取得

GET /volume/{volume_id}/copysession

概要説明

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

注意

応答情報を作成するうえで、以下のCopy Sessionの存在は無視されます。例えば、Storage ClusterのCopy先Volumeであっても、is_copy_destination_volumeがfalseになります。

  • Monitor

  • ODX

  • XCOPY

  • VVOL Copy Session

  • Storage Cluster

  • Copy範囲がExtent

  • Copy Session StatusがReserved

リクエスト例

  • Volume ID 100001 に存在するCopy Sessionの情報を取得する場合の例です。

    $ curl -i -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X GET "https://192.168.1.1:5665/api/v1/volume/100001/copysession"

レスポンス例

{
  "volume_id": 100001,
  "volume_number": 1,
  "volume_href": "/api/v1/volume/100001",
  "volume_name": "vol#01",
  "is_copy_source_volume": true,
  "is_copy_destination_volume": true,
  "backup_type": "Clone",
  "source_volume_number": 2,
  "source_volume_href": "/api/v1/volume/200001",
  "source_volume_name": "datastore#2",
  "source_boxid": "00ETERNUSDXHS3ET00000A####EI000002######",
  "copysession_href": "/api/v1/copysession/1",
  "remote_copysession_id": 2,
  "backup_time": "2020-12-01T12:30:00Z",
  "error_ocurrence_time": "2020-12-01T12:30:00Z",
  "status": "Active",
  "phase": "Equivalent",
  "is_manual_snapshot": false,
  "is_data_tracking_disabled": false,
  "backup_volume_list": [
    {
      "volume_number": 3,
      "volume_href": "/api/v1/volume/300001",
      "volume_name": "vol#03",
      "backup_type": "Remote_Mirror",
      "destination_boxid": "00ETERNUSDXHS3ET00000A####EI000001######",
      "copysession_href": "/api/v1/copysession/3",
      "remote_copysession_id": 2,
      "backup_time": "2020-12-01T12:30:00Z",
      "error_ocurrence_time": "2020-12-01T12:30:00Z",
      "status": "Active",
      "phase": "Equivalent",
      "is_manual_snapshot": false,
      "is_data_tracking_disabled": false
    }
  ]
}

Parameters

PATH PARAMETERS

volume_id

(required)

integer

Volume ID。

QUERY PARAMETERS

fields

Array of strings

表示したいParameter。

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

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

Array of strings

Backup Type。

情報を取得したいBackup VolumeのBackup Typeを指定します。
項目 説明
Clone OPCまたはQuickOPCのコピー先。
Snapshot SnapOPCまたはSnapOPC+のコピー先。
Local_Mirror ECのコピー先。
Remote_Mirror RECのコピー先。
Restored Restore OPCのコピー先 (OPCのコピー先からのRestore OPCは除く)。

入力条件：

  • 5個まで指定可能です。
is_manual_snapshot

boolean

世代管理するSnapshotかどうか。

trueを指定した場合、世代管理しないSnapshot(SnapOPCのVolume相当)のCopy Session情報のみを応答します。
is_data_tracking_disabled

boolean

Cloneの物理データの再同期が実行可能かどうか。

trueを指定した場合、物理データの再同期が実行不可のClone(OPCのVolume相当)のCopy Session情報のみを応答します。

Responses

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

RESPONSE BODY

volume_id

integer

Volume ID。
volume_number

integer

Volume Number。
volume_href

string

VolumeのResourceへのLink。
volume_name

string

VolumeのFriendly Name。
is_copy_source_volume

boolean

Volumeがコピー元Volumeかどうか。

trueの場合、Volumeがコピー元Volumeである。

falseの場合、Volumeがコピー元Volumeではない。
is_copy_destination_volume

boolean

Volumeがコピー先Volumeかどうか。

trueの場合、Volumeがコピー先Volumeである。

falseの場合、Volumeがコピー先Volumeではない。
backup_type

string

Backup Type。

Volumeがコピー先の場合に限り応答します。
項目 説明
Clone OPCまたはQuickOPCのコピー先。
Snapshot SnapOPCまたはSnapOPC+のコピー先。
Local_Mirror ECのコピー先。
Remote_Mirror RECのコピー先。
Restored Restore OPCのコピー先 (OPCのコピー先からのRestore OPCは除く)。

Restore中のVolumeのBackup Typeは以下のように応答します。

  • SnapshotまたはClone(物理データの再同期が実行不可のCloneを除く) からRestore中のVolumeの場合、Backup Typeは「Restored」を応答します。

  • 物理データの再同期が実行不可のCloneからRestore中のVolumeの場合、Backup Typeは「Clone」を応答します。

  • Copy Sessionの反転機能を使用して、Remote MirrorまたはLocal MirrorからRestore中のVolumeの場合、Backup Typeは「Remote Mirror」または「Local Mirror」を応答します。
source_volume_number

integer

コピー元VolumeのNumber。

Volumeがコピー先の場合に限り応答します。

Backup TypeがRestoredの場合、Restore元VolumeのNumberを応答します。

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

string

コピー元VolumeのResourceへのLink。

Volumeがコピー先の場合に限り応答します。

Backup TypeがRemote_Mirrorの場合は応答しません。

Backup TypeがRestoredの場合、Restore元VolumeのResourceへのLinkを応答します。

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

string

コピー元VolumeのFriendly Name。

Volumeがコピー先の場合に限り応答します。

Backup TypeがRemote_Mirrorの場合は応答しません。

Backup TypeがRestoredの場合、Restore元VolumeのFriendly Nameを応答します。

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

string

コピー元装置のBox ID。

Volumeがコピー先の場合に限り応答します。

Backup TypeがRemote_Mirrorの場合に限り応答します。
copysession_href

string

Copy SessionのResourceへのLink。

Volumeがコピー先の場合に限り応答します。
remote_copysession_id

integer

接続先装置のCopy Session ID。

Volumeがコピー先の場合に限り応答します。

Backup TypeがRemote_Mirrorの場合に限り応答します。
backup_time

string

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

Volumeがコピー先の場合に限り応答します。

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

Backup TypeがRestoredの場合、バックグラウンドで実施されるRestore元Volumeからのデータコピーの開始時刻を応答します。

Formatは以下です。

タイムゾーンはUTCです。

YYYY-MM-DDThh:mm:ssZ
error_ocurrence_time

string

Copy Sessionの障害発生時刻。

Volumeがコピー先の場合に限り応答します。

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

Formatは以下です。

タイムゾーンはUTCです。

YYYY-MM-DDThh:mm:ssZ
status

string

Copy Sessionのステータス。

Volumeがコピー先の場合に限り応答します。
項目 説明
Active 正常動作中。
Suspended 一時中断中。
Halt

コピー経路異常やREC Bufferの枯渇などによりコピー中断中。

Recovery ModeがAutomaticの場合、Halt要因を復旧後に自動でコピーを再開します。

Manualの場合、復旧後に強制Suspend/Resumeにより手動で再開する必要があります。
Error

装置故障や容量不足によりコピー中止。

エラー要因を復旧したあとにCopy Sessionの削除と再作成が必要です。
phase

string

Copy Sessionのフェーズ。

Volumeがコピー先の場合に限り応答します。

Backup TypeがCloneの場合、応答可能なPhaseはCopying、Tracking、Tracking_and_Copying、およびReadyingです。

Backup TypeがSnapshotまたはRestoredの場合、応答可能なPhaseはCopyingおよびReadyingです。

Backup TypeがLocal_MirrorまたはRemote_Mirrorの場合、応答可能なPhaseはCopyingおよびEquivalentです。
項目 説明
Copying

  • Snapshot、Clone (物理データの再同期不可) 、またはRestoredの場合、コピー中。

  • Clone (物理データの再同期可能) の場合、更新箇所の記録を停止後、記録された更新箇所をコピー中。

  • Local MirrorまたはRemote Mirror (転送モードが同期または非同期Consistency) の場合、データコピー中またはデータコピーを強制的に中断中のため、データ整合性は保証されていない状態。

  • Remote Mirror (転送モードが非同期Stack) の場合、コピー元Volumeのデータと一致していない状態。
Equivalent

  • Local MirrorまたはRemote Mirror (転送モードが同期、または非同期Stack) の場合、Copy元Volumeとデータが一致し、データの整合性が保証されている状態。

  • Remote Mirror (転送モードが非同期Consistency) の場合、データの整合性が保証されている状態 (REC Bufferに未転送データがある場合は、Copy元のデータと一致していない)。
Tracking Clone (物理データの再同期可能) でコピー完了後、更新箇所だけ記録中。
Tracking_and_Copying Clone (物理データの再同期可能) でコピー処理中およびコピー開始時点以降の更新箇所を記録中。
Readying コピー開始の準備中。
is_manual_snapshot

boolean

世代管理するSnapshotかどうか。

Volumeがコピー先の場合に限り応答します。

trueの場合、世代管理しないSnapshot(SnapOPC Session相当)。

falseの場合、世代管理するSnapshot(SnapOPC+ Session相当)。

Snapshot以外の場合もfalseとする。
is_data_tracking_disabled

boolean

Cloneの物理データの再同期が実行可能かどうか。

Volumeがコピー先の場合に限り応答します。

backup_typeがCloneの場合に限り応答します。

trueの場合、Cloneの物理データの再同期が実行不可(OPC Session相当)。

falseの場合、Cloneの物理データの再同期が実行可能(QuickOPC Session相当)。
backup_volume_list

Array of objects

コピー先Volumeの一覧。

copysession_hrefの昇順で表示します。
volume_number

integer

Volume Number。

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

string

VolumeのResourceへのLink。

Backup TypeがRemote_Mirrorの場合は応答しません。

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

string

VolumeのFriendly Name。

Backup TypeがRemote_Mirrorの場合は応答しません。

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

string

Backup Type。
項目 説明
Clone OPCまたはQuickOPCのコピー先。
Snapshot SnapOPCまたはSnapOPC+のコピー先。
Local_Mirror ECのコピー先。
Remote_Mirror RECのコピー先。
Restored Restore OPCのコピー先（PCのコピー先からのRestore OPCは除く）。

Restore中のVolumeのBackup Typeは以下のように応答します。

  • SnapshotまたはClone(物理データの再同期が実行不可のCloneを除く) からRestore中のVolumeの場合、Backup Typeは「Restored」を応答します。

  • 物理データの再同期が実行不可のCloneからRestore中のVolumeの場合、Backup Typeは「Clone」を応答します。

  • Copy Sessionの反転機能を使用して、Remote MirrorまたはLocal MirrorからRestore中のVolumeの場合、Backup Typeは「Remote Mirror」または「Local Mirror」を応答します。
destination_boxid

string

コピー先装置のBox ID。

Backup TypeがRemote_Mirrorの場合に限り応答します。
copysession_href

string

Copy SessionのResourceへのLink。
remote_copysession_id

integer

接続先装置のCopy Session ID。

Backup TypeがRemote_Mirrorの場合に限り応答します。
backup_time

string

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

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

Backup TypeがRestoredの場合、バックグラウンドで実施されるRestore元Volumeからのデータコピーの開始時刻を応答します。

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
status

string

Copy Sessionのステータス。
項目 説明
Active 正常動作中。
Suspended 一時中断中。
Halt

コピー経路異常やREC Bufferの枯渇などによりコピー中断中。

Recovery ModeがAutomaticの場合、Halt要因を復旧後に自動でコピーを再開します。

Manualの場合、復旧後に強制Suspend/Resumeにより手動で再開する必要があります。
Error

装置故障や容量不足によりコピー中止。

エラー要因を復旧したあとにCopy Sessionの削除と再作成が必要です。
phase

string

Copy Sessionのフェーズ。

Backup TypeがCloneの場合、応答可能なPhaseはCopying、Tracking、Tracking_and_Copying、およびReadyingです。

Backup TypeがSnapshotまたはRestoredの場合、応答可能なPhaseはCopyingおよびReadyingです。

Backup TypeがLocal_MirrorまたはRemote_Mirrorの場合、応答可能なPhaseはCopyingおよびEquivalentです。
項目 説明
Copying

  • Snapshot、Clone (物理データの再同期不可) 、またはRestoredの場合、コピー中。

  • Clone (物理データの再同期可能) の場合、更新箇所の記録を停止後、記録された更新箇所をコピー中。

  • Local MirrorまたはRemote Mirror (転送モードが同期または非同期Consistency) の場合、データコピー中またはデータコピーを強制的に中断中のため、データ整合性は保証されていない状態。

  • Remote Mirror (転送モードが非同期Stack) の場合、コピー元Volumeのデータと一致していない状態。
Equivalent

  • Local MirrorまたはRemote Mirror (転送モードが同期、または非同期Stack) の場合、Copy元Volumeとデータが一致し、データの整合性が保証されている状態。

  • Remote Mirror (転送モードが非同期Consistency) の場合、データの整合性が保証されている状態 (REC Bufferに未転送データがある場合は、Copy元のデータと一致していない)。
Tracking Clone (物理データの再同期可能) でコピー完了後、更新箇所だけ記録中。
Tracking_and_Copying Clone (物理データの再同期可能) でコピー処理中およびコピー開始時点以降の更新箇所を記録中。
Readying コピー開始の準備中。
is_manual_snapshot

boolean

世代管理するSnapshotかどうか。

trueの場合、世代管理しないSnapshot(SnapOPC Session相当)。

falseの場合、世代管理するSnapshot(SnapOPC+ Session相当)。

Snapshot以外の場合もfalseとする。
is_data_tracking_disabled

boolean

Cloneの物理データの再同期が実行可能かどうか。

backup_typeがCloneの場合に限り応答します。

trueの場合、Cloneの物理データの再同期が実行不可(OPC Session相当)。

falseの場合、Cloneの物理データの再同期が実行可能(QuickOPC Session相当)。