全Copy Session情報の取得

概要説明

Copy Session情報を取得します。

copysession_idの昇順で表示します。

注意

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

リクエスト例

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

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

レスポンス例

{
  "total_count": 512,
  "list_count": 1,
  "copysession_list": [
    {
      "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
    }
  ],
  "next_href": "/api/v1/volume?is_used_status_attention=true&fields=number,name&last_get_id=100005"
}

Parameters

QUERY PARAMETERS

fields

Array of strings

表示したいParameter。

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

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

copysession_id

Array of integers

Copy Session ID。

情報を取得したいCopy SessionのIDを指定します。

入力条件：

256個まで指定可能です。

type

Array of strings

Copy Session Type。

情報を取得したい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

Array of strings

ステータス。

情報を取得したいCopy Session Statusを指定します。

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

phase

Array of strings

フェーズ。

情報を取得したいCopy Sessionのフェーズを指定します。

項目	説明
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	コピー開始の準備中。

max_records

情報を取得したいリソースの最大数。

応答する情報数を制限したい場合に指定してください。

入力条件：

指定可能な範囲は1～512です。

start_number

Default: 0

情報を取得したいリソースの先頭のNumber。

入力条件：

指定可能な範囲は0～65535です。

last_get_id

integer

続きの情報を取得するためのリソースの識別子。

一度に応答条件に合致するすべてのリソースを応答できなかった場合、next_hrefが返却されます。

last_get_idは、next_hrefに付与される続きの情報を取得するための情報です。

Responses

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

RESPONSE BODY

total_count	integer (total_count) 装置に存在するResourceの総数。フィルタリングしている場合は、条件に合致するResourceの総数です。
list_count	integer (list_count) 応答するListの個数。
copysession_list	Array of objects (copysession) GET /copysession/{copysession_id}で取得できる情報を、list_count数分出力します。詳細は、Copy Session情報の取得の「Responses」を参照してください。
next_href	string (next_href) 続きの情報を取得するためのLink。一度にすべての情報を応答しきることができなかった場合に限り応答します。例えば、max_recordsで指定した個数以上に応答条件に合致するResourceが存在する場合などに応答します。