ModifySchedule

ModifyScheduleを使用すると、スケジュールされたSnapshotが作成される間隔を変更できます。スケジュールを削除または一時停止することもできます。

パラメータ

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

名前	説明	タイプ	デフォルト値	必須
attributes	Snapshotの作成頻度。有効な値は次のとおりです。 Days of Week Days of Month Time Interval	JSONオブジェクト	なし	×
hours	Snapshotを作成する間隔（時間数）、または、Days of WeekまたはDays of Monthで指定した場合のSnapshotが作成される時間。有効な値は0～24です。	文字列	なし	×
name	Snapshotの名前。名前を入力しない場合、グループSnapshotの作成日時が使用されます。最大文字数は244文字です。	文字列	なし	×
minutes	Snapshotを作成する間隔（分数）、または、Days of WeekまたはDays of Monthで指定した場合のSnapshotが作成される時間（分）。有効な値は0～59です。	整数	なし	×
paused	スケジュールを一時停止するかどうか。有効な値は次のとおりです。 true false	ブーリアン	なし	×
recurring	スケジュールを繰り返すかどうか。指定できる値は次のとおりです。 true false	ブーリアン	なし	×
runNextInterval	スケジューラが次回アクティブになったときにSnapshotを作成するかどうか。有効な値は次のとおりです。 true false trueに設定すると、次にスケジューラがアクティブになったときにスケジュールされたSnapshotが作成され、その後falseにリセットされます。	ブーリアン	false	×
scheduleID	スケジュールの一意のID。	整数	なし	○
scheduleName	スケジュールの一意の名前。最大文字数は244文字です。	文字列	なし	×
scheduleType	作成するスケジュールのタイプ。有効な値はsnapshotです。	文字列	なし	○
scheduleInfo	スケジュールに指定した一意の名前、作成されたSnapshotの保持期間、Snapshot作成元のボリュームのID。有効な値は次のとおりです。 volumeID：Snapshotに含めるボリュームのID （整数）。 volumes：グループSnapshotに含めるボリュームIDのリスト（整数の配列）。 name：使用するSnapshot名（文字列）。 enableRemoteReplication：リモートレプリケーションにSnapshotを含めるかどうか（ブーリアン）。 retention：HH:mm:ss形式での、Snapshotを保持する時間（文字列）。	JSONオブジェクト	なし	×
snapMirrorLabel	SnapMirrorエンドポイントでのSnapshot保持ポリシーを指定するためにSnapMirrorソフトウェアで使用されるラベル。	文字列	なし	×
toBeDeleted	スケジュールを削除対象としてマークするかどうか。有効な値は次のとおりです。 true false	ブーリアン	なし	×
startingDate	スケジュールが最初に開始された日、または開始される日。	ISO 8601形式の日付文字列	なし	×
monthdays	Snapshotを作成する特定の日にち。有効な値は1～31です。	整数の配列	なし	○
weekdays	Snapshotを作成する曜日。曜日は日曜の「0」から始まり、オフセットは「1」です。	文字列	なし	×

戻り値

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

名前	説明	タイプ
schedule	変更されたスケジュール属性を含むオブジェクト。	schedule

要求例

{
  "method": "ModifySchedule",
  "params": {
    "scheduleName" : "Chicago",
    "scheduleID" : 3
    },
  "id": 1
}

応答例

{
  "id": 1,
  "result": {
    "schedule": {
      "attributes": {
        "frequency": "Days Of Week"
            },
      "hasError": false,
      "hours": 5,
      "lastRunStatus": "Success",
      "lastRunTimeStarted": null,
      "minutes": 0,
      "monthdays": [],
      "paused": false,
      "recurring": true,
      "runNextInterval": false,
      "scheduleID": 3,
      "scheduleInfo": {
        "volumeID": "2"
            },
      "scheduleName": "Chicago",
      "scheduleType": "Snapshot",
      "startingDate": null,
      "toBeDeleted": false,
      "weekdays": [
        {
          "day": 2,
          "offset": 1
      }
      ]
    }
  }
}