UpdateBulkVolumeStatus

UpdateBulkVolumeStatusメソッドを使用すると、StartBulkVolumeReadメソッドまたはStartBulkVolumeWriteメソッドで開始した一括ボリューム ジョブのステータスを更新できます。

パラメータ

このメソッドの入力パラメータは次のとおりです。

名前 説明 タイプ デフォルト値 必須
key StartBulkVolumeReadまたはStartBulkVolumeWriteセッションの初期化中に割り当てられたキー。 文字列 なし
status 指定した一括ボリューム ジョブのステータスが設定されます。有効な値は次のとおりです。
  • running:アクティブなジョブ。
  • complete:完了したジョブ。
  • failed:失敗したジョブ。
文字列 なし
percentComplete 一括ボリューム ジョブの進捗状況(パーセント値)。 文字列 なし ×
message ジョブが完了したときの一括ボリューム ジョブのステータスが返されます。 文字列 なし ×
attributes JSON属性。一括ボリューム ジョブの内容を更新します。 JSONオブジェクト なし ×

戻り値

このメソッドの戻り値は次のとおりです。

名前 説明 タイプ
status 要求したセッションのステータス。ステータスは次のとおりです。
  • preparing
  • active
  • done
  • failed
文字列
attributes メソッド呼び出しで指定された属性を返します。値は変更の有無にかかわらず返されます。 文字列
url ノードのWebサーバにアクセスするためのURL。セッションがアクティブな場合にのみ提供されます。 文字列

要求例

このメソッドの要求例を次に示します。

{
   "method": "UpdateBulkVolumeStatus",
   "params": {
          "key": "0b2f532123225febda2625f55dcb0448",
	      "status": "running"
      },
   "id": 1
}

応答例

このメソッドの応答例を次に示します。

{
   "id" : 1,
   "result": {
	  "status" : "running",
	  "url" : "https://10.10.23.47:8443/"
    }		
}

新規導入バージョン

9.6