Update an object replication schedule

NAS File Storage REST API v7 Reference

Version
14.7.x
14.6.x
Audience
anonymous
Part Number
MK-92HNAS088-05

Updates an object replication schedule.

HTTP request syntax (URI)

PATCH <base_URI>/v7/storage/object-replication-schedules/{id}

Parameters

Name Type Required Values Description
id URI Y string/number ID of an object replication schedule object.
enabled BODY Y boolean True to enable; false otherwise.
interval BODY Y number Schedule interval.
unit BODY Y string Unit of time of schedule interval. Current supported values are:
  • MINUTE
  • HOUR
  • DAY
  • WEEK
  • MONTH
nextRunSchedule BODY Y number Time of the next run schedule.
finalRunSchedule BODY Y number Time of the final run schedule.
type BODY Y string Type of schedule. Current supported values are:
  • PERIODIC
  • CONTINUOUS
  • ONCE_ONLY
  • DRY_RUN_DETAILED

If type is ONCE_ONLY, the interval and unit values are not used so they can be anything.

Return codes

Code Data Description
204 No Data An object replication schedule was updated successfully.
400 No Data Missing or invalid request contents.
404 Error Message Requested resource not found.
500 Error message Error associated with the storage system.
501 No Data Server has not implemented the request operation on the resource.

Any HTTP status code other than 204 indicates that the API did not complete successfully.

Request example

curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v7/storage/object-replication-schedules/63376434346636362d373637632d313164322d393036612d3439653162623836346232333a3 a3a343a3a3a353a3a3a303a3a3a4f49445f24232140255f56 -X PATCH -d '{"interval":2, "enabled":false, "unit":"MONTH", "type":"ONCE_ONLY", "nextRunSchedule":1234567, "finalRunSchedule":2234568}'

Response example

HTTP/1.1 204 No Content