CreateScheduleを使用すると、ボリュームのSnapshotのスケジュールを設定し、指定した間隔でSnapshotを自動的に作成できます。
このメソッドの入力パラメータは次のとおりです。
| 名前 | 説明 | タイプ | デフォルト値 | 必須 |
|---|---|---|---|---|
| attributes | 「frequency」文字列を使用してSnapshotの作成頻度を指定します。有効な値は次のとおりです。
|
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 | スケジュールを一時停止するかどうか。有効な値は次のとおりです。
|
ブーリアン | なし | × |
| recurring | スケジュールを繰り返すかどうか。指定できる値は次のとおりです。
|
ブーリアン | なし | × |
| scheduleName | スケジュールの一意の名前。最大文字数は244文字です。 | 文字列 | なし | ○ |
| scheduleType | 作成するスケジュールのタイプ。有効な値はsnapshotです。 | 文字列 | なし | ○ |
| scheduleInfo | 定期的にSnapshotを作成する方法に関する、スケジュール情報のオブジェクト。
|
JSONオブジェクト | なし | ○ |
| snapMirrorLabel | SnapMirrorエンドポイントでのSnapshot保持ポリシーを指定するためにSnapMirrorソフトウェアで使用されるラベル。 | 文字列 | なし | × |
| startingDate | この時刻を過ぎてからスケジュールを実行します。設定しない場合、スケジュールはただちに開始されます。形式は、UTC時間形式です。 | ISO 8601形式の日付文字列 | なし | × |
| monthdays | Snapshotを作成する特定の日にち。有効な値は1～31です。 | 整数の配列 | なし | ○（日にちでスケジュール設定する場合） |
| weekdays | Snapshotを作成する曜日。必要な値は次のとおりです（使用する場合）。
|
JSONオブジェクトの配列 | なし | ○（曜日でスケジュール設定する場合） |
このメソッドの戻り値は次のとおりです。
| 名前 | 説明 | タイプ |
|---|---|---|
| scheduleID | 作成されたスケジュールのID。 | 整数 |
| schedule | 作成されたスケジュールの情報を含むオブジェクト。 | schedule |
{
"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
}
}
}
{
"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
}
}
{
"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
}
{
"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
}
}
{
"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
}
{
"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
}
}
9.6