Update a schedule
Updates a schedule to change its configuration. Use this operation to adjust schedule details while keeping in mind that certain fields cannot be modified depending on the schedule type.
HTTP method and endpoint
PATCH /cluster/schedules/{uuid}
Introduced in
ONTAP 9.6
Usage notes
Note that you cannot modify a cron field of an interval schedule, or the interval field of a cron schedule.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
uuid |
string |
path |
True |
Schedule UUID |
Request Body
| Name | Type | Description |
|---|---|---|
cron |
Details for schedules of type cron. |
|
interval |
string |
An ISO-8601 duration formatted string. |
scope |
string |
If the schedule is owned by a data SVM, then the scope is set to svm. Otherwise it will be set to cluster. |
type |
string |
Schedule type |
uuid |
string |
Job schedule UUID |
Example request
{
"cron": {
"days": [
"integer"
],
"hours": [
"integer"
],
"minutes": [
"integer"
],
"months": [
"integer"
],
"weekdays": [
"integer"
]
},
"interval": "P1DT2H3M4S",
"scope": "string",
"type": "string",
"uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
}
Response
Status: 200, Ok
Error
Status: Default
ONTAP Error Response Codes
| Error Code | Description |
|---|---|
458788 |
The schedule specified is not a valid schedule. |
459760 |
The schedule specified is not a valid schedule. |
459761 |
Schedule cannot be modified on this cluster because it is replicated from the remote cluster. |
460783 |
As this is a MetroCluster configuration and the local cluster is waiting for switchback, changes to non-system schedules are not allowed. |
461785 |
A cron schedule cannot have an interval field. |
461786 |
An interval schedule cannot have a cron field. |
Also see the table of common errors in the Response body overview section of this documentation.
Definitions
See Definitions
href
| Name | Type | Description |
|---|---|---|
href |
string |
_links
cluster
The cluster that owns the schedule. Defaults to the local cluster.
| Name | Type | Description |
|---|---|---|
name |
string |
Cluster name |
uuid |
string |
Cluster UUID |
cron
Details for schedules of type cron.
| Name | Type | Description |
|---|---|---|
days |
array[integer] |
The days of the month the schedule runs. Leave empty for all. |
hours |
array[integer] |
The hours of the day the schedule runs. Leave empty for all. |
minutes |
array[integer] |
The minutes the schedule runs. Required on POST for a cron schedule. |
months |
array[integer] |
The months of the year the schedule runs. Leave empty for all. |
weekdays |
array[integer] |
The weekdays the schedule runs. Leave empty for all. |
svm
SVM, applies only to SVM-scoped objects.
| Name | Type | Description |
|---|---|---|
name |
string |
The name of the SVM. This field cannot be specified in a PATCH method. |
uuid |
string |
The unique identifier of the SVM. This field cannot be specified in a PATCH method. |
schedule
Complete schedule information
| Name | Type | Description |
|---|---|---|
cron |
Details for schedules of type cron. |
|
interval |
string |
An ISO-8601 duration formatted string. |
scope |
string |
If the schedule is owned by a data SVM, then the scope is set to svm. Otherwise it will be set to cluster. |
type |
string |
Schedule type |
uuid |
string |
Job schedule UUID |
error_arguments
| Name | Type | Description |
|---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
returned_error
| Name | Type | Description |
|---|---|---|
arguments |
array[error_arguments] |
Message arguments |
code |
string |
Error code |
message |
string |
Error message |
target |
string |
The target parameter that caused the error. |