Skip to main content
A newer release of this product is available.

Create a schedule

Contributors
PDFs

POST /cluster/schedules

Introduced In: 9.6

Creates a schedule.

Required Fields

  • name - Name of the job schedule. You must provide a minutes field for a cron schedule and an interval field for an interval schedule. Do not provide both a cron field and an interval field.

Parameters

Name Type In Required Description

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

  • Default value:

Request Body

Name Type Description

_links

_links

cluster

cluster

The cluster that owns the schedule. Defaults to the local cluster.

cron

cron

Details for schedules of type cron.

interval

string

An ISO-8601 duration formatted string.

name

string

Schedule name. Required in the URL or POST body.

type

string

Schedule type

uuid

string

Job schedule UUID
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "cluster": {
    "name": "cluster1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "cron": {
    "days": [
      "integer"
    ],
    "hours": [
      "integer"
    ],
    "minutes": [
      "integer"
    ],
    "months": [
      "integer"
    ],
    "weekdays": [
      "integer"
    ]
  },
  "interval": "P1DT2H3M4S",
  "name": "string",
  "type": "string",
  "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
}

Response

Status: 201, Created

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.

459763

Schedule cannot be created locally using the remote cluster name as the owner.

459764

Cannot create a schedule with the same name as an existing schedule from the MetroCluster partner cluster but of a different schedule type.

460783

As this is a MetroCluster configuration and the local cluster is waiting for switchback, changes to non-system schedules are not allowed.

460784

An error occurred creating the remote cluster version of this schedule.
Name Type Description

error

error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

self

href

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.

schedule

Complete schedule information

Name Type Description

_links

_links

cluster

cluster

The cluster that owns the schedule. Defaults to the local cluster.

cron

cron

Details for schedules of type cron.

interval

string

An ISO-8601 duration formatted string.

name

string

Schedule name. Required in the URL or POST body.

type

string

Schedule type

uuid

string

Job schedule UUID

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

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.