CreateSchedule

CreateScheduleを使用すると、ボリュームのSnapshotのスケジュールを設定し、指定した間隔でSnapshotを自動的に作成できます。

作成したSnapshotは、バックアップまたはロールバックとして使用して、Snapshotを作成した時点でのボリュームまたはボリューム グループのデータの整合性を確保することができます。Snapshotのスケジュールを5分以外の間隔で設定した場合、Snapshotは5分単位に繰り上げた時間で実行されます。たとえば、12:42:00 UTCに実行するようにSnapshotのスケジュールを設定した場合、12:45:00 UTCに実行されます。Snapshotのスケジュールを5分未満の間隔で実行するように設定することはできません。
注:クラスタ フルのステージが1、2、または3の間はSnapshotを作成できます。ステージが4または5に達すると、Snapshotを作成できなくなります。

パラメータ

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

名前 説明 タイプ デフォルト値 必須
attributes 「frequency」文字列を使用してSnapshotの作成頻度を指定します。有効な値は次のとおりです。
  • Days of Week
  • Days of Month
  • Time Interval
JSONオブジェクト なし ×
hours Snapshotを作成する間隔(時間数)、または、Days of WeekまたはDays of MonthモードでのSnapshotが作成される時間(GMT)。有効な値は0~23です。 整数 なし ×
name Snapshotの名前。名前を入力しない場合、グループSnapshotの作成日時が使用されます。最大文字数は244文字です。 文字列 なし ×
minutes Snapshotを繰り返し作成する間隔の時間(分数)、または、Days of WeekまたはDays of MonthモードでSnapshotを作成する分(GMT)。有効な値は5~59です。 整数 なし ×
paused スケジュールを一時停止するかどうか。有効な値は次のとおりです。
  • true
  • false
ブーリアン なし ×
recurring スケジュールを繰り返すかどうか。指定できる値は次のとおりです。
  • true
  • false
ブーリアン なし ×
scheduleName スケジュールの一意の名前。最大文字数は244文字です。 文字列 なし
scheduleType 作成するスケジュールのタイプ。有効な値はsnapshotです。 文字列 なし
scheduleInfo 定期的にSnapshotを作成する方法に関する、スケジュール情報のオブジェクト。
  • volumeID:Snapshotに含めるボリュームのID (整数)。
  • volumes:グループSnapshotに含めるボリュームIDのリスト (整数の配列)。
  • name:使用するSnapshot名 (文字列)。
  • enableRemoteReplication:リモート レプリケーションにSnapshotを含めるかどうか (ブーリアン)。
  • retention:HH:mm:ss形式での、Snapshotを保持する時間 (文字列)。
JSONオブジェクト なし
snapMirrorLabel SnapMirrorエンドポイントでのSnapshot保持ポリシーを指定するためにSnapMirrorソフトウェアで使用されるラベル。 文字列 なし ×
startingDate この時刻を過ぎてからスケジュールを実行します。設定しない場合、スケジュールはただちに開始されます。形式は、UTC時間形式です。 ISO 8601形式の日付文字列 なし ×
monthdays Snapshotを作成する特定の日にち。有効な値は1~31です。 整数の配列 なし ○(日にちでスケジュール設定する場合)
weekdays Snapshotを作成する曜日。必要な値は次のとおりです(使用する場合)。
  • Day:0~6(日曜日~土曜日)。
  • Offset:1
JSONオブジェクトの配列 なし ○(曜日でスケジュール設定する場合)

戻り値

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

名前 説明 タイプ
scheduleID 作成されたスケジュールのID。 整数
schedule 作成されたスケジュールの情報を含むオブジェクト。 schedule

要求例1

次のパラメータを含むスケジュールの例を次に示します。
  • 可能なかぎり午前0時(00:00:00Z)近くにスケジュールが開始されるように、開始時刻(時間と分)は指定しません。
  • 繰り返し作成しません(一度だけ実行されます)。
  • 2015年6月1日UTC 19:17:15Z以降の最初の日曜日または水曜日(いずれか早い日)に一度だけ実行されます。
  • 1つのボリューム(ボリュームID = 1)のみが含まれます。
{
  "method":"CreateSchedule",
  "params":{
    "hours":0,
    "minutes":0,
    "paused":false,
    "recurring":false,
    "scheduleName":"MCAsnapshot1",
    "scheduleType":"snapshot",
    "attributes":{
      "frequency":"Days Of Week"
    },
    "scheduleInfo":{
      "volumeID":"1",
      "name":"MCA1"
    },
    "monthdays":[],
    "weekdays":[
      {
        "day":0,
        "offset":1
      },
      {
        "day":3,
        "offset":1
      }
    ],
    "startingDate":"2015-06-01T19:17:54Z"
  },
   "id":1
}
}
}

応答例1

上記の要求に対する応答例を次に示します。
{
  "id": 1,
  "result": {
    "schedule": {
      "attributes": {
        "frequency": "Days Of Week"
      },
      "hasError": false,
      "hours": 0,
      "lastRunStatus": "Success",
      "lastRunTimeStarted": null,
      "minutes": 0,
      "monthdays": [],
      "paused": false,
      "recurring": false,
      "runNextInterval": false,
      "scheduleID": 4,
      "scheduleInfo": {
        "name": "MCA1",
        "volumeID": "1"
      },
      "scheduleName": "MCAsnapshot1",
      "scheduleType": "Snapshot",
      "startingDate": "2015-06-01T19:17:54Z",
      "toBeDeleted": false,
      "weekdays": [
        {
          "day": 0,
          "offset": 1
        },
        {
          "day": 3,
          "offset": 1
        }
      ]
    },
    "scheduleID": 4
  }
}

要求例2

次のパラメータを含むスケジュールの例を次に示します。
  • 繰り返し作成されます(毎月のスケジュールされた日にちの、指定された時間に実行されます)。
  • 開始日以降の毎月1日、10日、15日、30日に実行されます。
  • スケジュールされた各日にちの午後12:15に実行されます。
  • 1つのボリューム(ボリュームID = 1)のみが含まれます。
{
  "method":"CreateSchedule",
    "params":{
      "hours":12,
      "minutes":15,
      "paused":false,
      "recurring":true,
      "scheduleName":"MCASnapshot1",
      "scheduleType":"snapshot",
      "attributes":{
        "frequency":"Days Of Month"
      },
      "scheduleInfo":{
        "volumeID":"1"
      },
      "weekdays":[          
      ],
      "monthdays":[
        1,
        10,
        15,
        30
      ],
      "startingDate":"2015-04-02T18:03:15Z"
    },
    "id":1
}

応答例2

上記の要求に対する応答例を次に示します。
{
  "id": 1,
  "result": {
    "schedule": {
      "attributes": {
        "frequency": "Days Of Month"
      },
      "hasError": false,
      "hours": 12,
      "lastRunStatus": "Success",
      "lastRunTimeStarted": null,
      "minutes": 15,
      "monthdays": [
        1,
        10,
        15,
        30
      ],
      "paused": false,
      "recurring": true,
      "runNextInterval": false,
      "scheduleID": 5,
      "scheduleInfo": {
        "volumeID": "1"
      },
      "scheduleName": "MCASnapshot1",
      "scheduleType": "Snapshot",
      "startingDate": "2015-04-02T18:03:15Z",
      "toBeDeleted": false,
      "weekdays": []
    },
      "scheduleID": 5
  }
}

要求例3

次のパラメータを含むスケジュールの例を次に示します。
  • 2015年4月2日に、スケジュールされた間隔で、5分以内に開始されます。
  • 繰り返し作成されます(毎月のスケジュールされた日にちの、指定された時間に実行されます)。
  • 開始日以降の毎月2日、3日、4日に実行されます。
  • スケジュールされた各日にちの午後14:45に実行されます。
  • ボリュームのグループが含まれています(ボリューム1および2)。
{
  "method":"CreateSchedule",
  "params":{
    "hours":14,
    "minutes":45, 
    "paused":false,
    "recurring":true,
    "scheduleName":"MCASnapUser1",
    "scheduleType":"snapshot",
    "attributes":{
      "frequency":"Days Of Month"
    },
    "scheduleInfo":{
      "volumes":[1,2]
    }, 
    "weekdays":[],
    "monthdays":[2,3,4],
    "startingDate":"2015-04-02T20:38:23Z"
  },
  "id":1
}

応答例3

上記の要求に対する応答例を次に示します。
{
  "id": 1,
  "result": {
    "schedule": {
      "attributes": {
        "frequency": "Days Of Month"
      },
      "hasError": false,
      "hours": 14,
      "lastRunStatus": "Success",
      "lastRunTimeStarted": null,
      "minutes": 45,
      "monthdays": [
        2,
        3,
        4
      ],
      "paused": false,
      "recurring": true,
      "runNextInterval": false,
      "scheduleID": 6,
      "scheduleInfo": {
        "volumes": [
          1,
          2
        ]
      },
      "scheduleName": "MCASnapUser1",
      "scheduleType": "Snapshot",
      "startingDate": "2015-04-02T20:38:23Z",
      "toBeDeleted": false,
      "weekdays": []
    },
    "scheduleID": 6
  }
}