简体中文版经机器翻译而成,仅供参考。如与英语版出现任何冲突,应以英语版为准。

ModifySchedule

提供者

您可以使用 ModfySchedule 更改执行计划快照的间隔。您也可以使用此方法删除或暂停计划。

Parameters

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

Name

Description

Type

默认值

Required

属性

用于更改快照发生频率。可能值:

  • 每周的日期 d

  • d月之日

  • 时间间隔

JSON 对象

hours

两个快照之间的小时数,或者在 Days of Week 或 Days of Month 模式下创建快照的小时数。有效值为 0 到 24 。

string

name

快照的名称。如果未输入任何名称,则会使用创建组快照的日期和时间。允许的最大名称长度为 244 个字符。

string

minutes

两个快照之间的分钟数或在 Days of Week 或 Days of Month 模式下创建快照的分钟值。有效值为 0 到 59 。

整型

lastRunStatus

上次计划快照创建的结果或状态。

string

已暂停

指示是否应暂停计划。有效值:

  • true

  • false

boolean

重复

指示计划是否重复。有效值为:

  • true

  • false

boolean

runNextInterval

用于选择是否在计划程序下次处于活动状态时运行快照。有效值:

  • true

  • false

如果设置为 true ,则计划快照会在计划程序下次处于活动状态时运行,然后重置为 false 。

boolean

false

计划 ID

计划的唯一 ID 。

整型

是的。

scheduleName

计划的唯一名称。允许的最大计划名称长度为 244 个字符。

string

scheduleType

指示要创建的计划的类型。唯一支持的值为 snapshot

string

是的。

scheduleInfo

为计划指定的唯一名称,创建的快照的保留期限以及从中创建快照的卷的卷 ID 。有效值:

  • volumeID :要包括在快照中的卷的 ID 。整型

  • volumes :要包含在组快照中的卷 ID 列表。(整型数组)

  • name :要使用的快照名称。string

  • enableRemoteReplication :指示是否应将快照包括在远程复制中。boolean

  • retention :快照的保留时间,以 HH : mm : ss 表示如果为空,则快照将永久保留。string

  • ifo :快照按先出( FIFO )原则保留。string

  • ensureSerialCreation :指定在执行先前的快照复制时是否应允许创建新的快照。boolean

snapMirrorLabel

SnapMirror 软件用于在 SnapMirror 端点上指定快照保留策略的标签。

string

已删除

指示是否已将计划标记为删除。有效值:

  • true

  • false

boolean

启动日期

指示首次开始或开始计划的日期。

ISO 8601 日期字符串

一个月中将创建快照的天数。有效值为 1 到 31 。

整型数组

是的。

weekDays

要创建快照的星期几。一周中的某一天从星期日开始,其值为 0 ,偏移量为 1 。

string

返回值

此方法具有以下返回值:

Name

Description

Type

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
      }
      ]
    }
  }
}

自版本以来的新增功能

9.6