CreateSchedule

您可以使用 CreateSchedule 制定按定义的间隔自动生成卷快照的计划。

您可以在以后使用已创建的快照作为备份或回滚,以确保卷或卷组上的数据在创建快照时的时间点是一致的。如果计划按无法被 5 分钟整除的时间段运行快照,快照将在下一个可被 5 分钟整除的时间段运行。例如,如果计划在 12:42:00 UTC 运行快照,它将在 12:45:00 UTC 运行。您无法计划以低于 5 分钟的间隔运行快照。
注:当集群填充度处于第 1、2 或第 3 阶段时,您可以创建快照。当集群填充度达到第 4 或第 5 阶段时,您不能创建快照。

参数

此方法具有以下输入参数:

名称 说明 类型 默认值 必需
attributes 使用 “frequency” 字符串以指示生成快照的频率。可能值:
  • Days of Week
  • Days of Month
  • Time Interval
JSON 对象
hours 两次重复生成快照相隔的小时数,或者在 Days of WeekDays of Month 模式下生成快照的 GMT 时间(小时)。有效值为 0 到 23。 整型
name 快照的名称。如果未输入任何名称,则会使用生成组快照时的日期和时间。允许的最大名称长度为 244 个字符。 字符串
minutes 两次重复生成快照相隔的分钟数,或者在 Days of WeekDays of Month 模式下生成快照的 GMT 时间(分钟)。有效值为 5 到 59。 整型
paused 指示是否应暂停该计划。有效值:
  • true
  • false
布尔型
recurring 指示该计划是否重复运行。有效值为:
  • true
  • false
布尔型
scheduleName 计划的唯一名称。允许的最大计划名称长度为 244 个字符。 字符串
scheduleType 指示要创建的计划的类型。有效值为 snapshot 字符串
scheduleInfo 有关如何在每个计划的间隔创建快照的信息的对象。
  • volumeID:要包括在快照中的卷的 ID。(整型)
  • volumes:要包括在组快照中的卷的 ID 列表。(整型数组)
  • name:要使用的快照名称。(字符串)
  • enableRemoteReplication:指示是否应将快照包括在远程复制中。(布尔值)
  • retention:快照的保留时间,格式为 HH:mm:ss。(字符串)
JSON 对象
snapMirrorLabel SnapMirror 软件用于在 SnapMirror 端点上指定快照保留策略的标签。 字符串
startingDate 运行该计划之前经过的时间。如果未设置此参数,计划将立即启动。采用 UTC 时间格式。 ISO 8601 日期字符串
monthdays 将在月份中的哪些天生成快照。有效值为 1 到 31。 整型数组 是(如果计划在月份中的某些天生成快照)
weekdays 将在星期几创建快照。所需的值(如果使用):
  • Day:0 到 6(星期日到星期六)
  • Offset:1
JSON 对象数组 是(如果计划在周中的某些天生成快照)

返回值

此方法具有以下返回值:

名称 说明 类型
scheduleID 已创建的计划的 ID。 整型
schedule 包含新创建计划的相关信息的对象。 schedule

请求示例 1

以下示例计划具有下列参数:
  • 由于未指定开始 hours 或 minutes,因此该计划在尽可能接近午夜 (00:00:00Z) 时启动。
  • 此计划不重复运行(仅运行一次)。
  • 此计划在 2015 年 6 月 1 日 UTC 19:17:15Z 之后的第一个星期日或星期三(以较早日期为准)仅运行一次。
  • 此计划仅包括一个卷 (volumeID = 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 运行。
  • 此计划仅包括一个卷 (volumeID = 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 运行。
  • 此计划包括一组卷(volumes = 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
  }
}

发布以下版本后新增

9.6