Sign in
Functions

Update a function scheduler

Changed on
patch/projects/{id}/functions/{functionId}/schedulers/{schedulerId}

Request

  • Base URL: https://api.volcano.dev
  • URL: https://api.volcano.dev/projects/{id}/functions/{functionId}/schedulers/{schedulerId}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring uuid required

Project ID

functionIdstring uuid required

Function ID

schedulerIdstring uuid required

Function scheduler ID

Request body

namestring
enabledboolean
payloadobject
regionsstring[]

Example request

{
  "schedule": {
    "cron_expression": "*/5 * * * *"
  }
}

Response

Scheduler updated

idstring uuid
project_idstring uuid
function_idstring uuid
function_kind'standard' | 'durable'

Which kind of function this is. standard runs once per invocation. durable checkpoints its progress and resumes from the last completed step, and is invoked asynchronously through its own executions collection. A function's kind is fixed when it is created and cannot be changed afterwards. Omitting this field means standard.

namestring
enabledboolean
schedule_kind'cron'
cron_expressionstring
payloadobject
regionsstring[]
regions_explicitboolean
next_run_atstring date-time
last_started_atstring date-time
last_completed_atstring date-time
last_errorstring
run_countinteger

Total number of times this scheduler has executed. 0 for a scheduler that has never run.

created_atstring date-time
updated_atstring date-time

Changes

  • 23e7875e7c4cRevision changes
    • ○

      the endpoint scheme security ProjectAccessToken was added to the API

  • 3a6f365f3f35Revision changes
    • ▲

      added the new path request parameter functionId

    • ▲

      added the new path request parameter id

    • ▲

      added the new path request parameter schedulerId

    • ▲

      the request's body type changed from no type to object

    • ▲

      the response's body type changed from no type to object for status

    • ○

      added the new optional request property

    • ○

      added the new optional request property

    • ○

      added the new optional request property

    • ○

      added the new optional request property

    • ○

      added the new optional request property

    • ○

      added the non-success response with the status

    • ○

      added the non-success response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status