All Products
Search

This Product

    CloudFlow:UpdateSchedule

    Document Center

    CloudFlow:UpdateSchedule

    Last Updated:Apr 11, 2024

    Updates a time-based schedule.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    FlowNamestringYes

    The name of the flow that is associated with the time-based schedule. The name must be unique within the region and cannot be modified after the time-based schedule is created. The name must meet the following conventions:

    • The name can contain letters, digits, underscores (_), and hyphens (-).
    • The name must start with a letter or an underscore (_).
    • The name is case-sensitive.
    • The name must be 1 to 128 characters in length.
    		testFlowName
    ScheduleNamestringYes

    The name of the time-based schedule. The name must meet the following conventions:

    • The name can contain letters, digits, underscores (_), and hyphens (-).
    • The name must start with a letter or an underscore (_).
    • The name is case-sensitive.
    • The name must be 1 to 128 characters in length.
    		testScheduleName
    DescriptionstringNo

    The description of the time-based schedule.

    		test description
    PayloadstringNo

    The trigger message of the time-based schedule. It must be in the JSON format.

    		{"key": "value"}
    CronExpressionstringNo

    The CRON expression.

    		0 * * * * *
    EnablebooleanNo

    Specifies whether to enable the time-based schedule. Valid values:

    • true
    • false
    		true

    Response parameters

    ParameterTypeDescriptionExample
    object

    The schema of response.

    RequestIdstring

    The request ID.

    		testRequestId
    Descriptionstring

    The description of the time-based schedule.

    		test description
    ScheduleIdstring

    The ID of the time-based schedule.

    		testScheduleId
    Payloadstring

    The trigger message of the time-based schedule.

    		{"key": "value"}
    ScheduleNamestring

    The name of the time-based schedule.

    		testScheduleName
    CreatedTimestring

    The time when the time-based schedule was created.

    		2020-01-01T01:01:01.001Z
    LastModifiedTimestring

    The time when the time-based schedule was last updated.

    		2020-01-01T01:01:01.001Z
    CronExpressionstring

    The CRON expression.

    		0 * * * * *
    Enableboolean

    Indicates whether the time-based schedule is enabled. Valid values:

    • true
    • false
    		true

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "testRequestId",
  "Description": "test description",
  "ScheduleId": "testScheduleId",
  "Payload": "{\"key\": \"value\"}",
  "ScheduleName": "testScheduleName",
  "CreatedTime": "2020-01-01T01:01:01.001Z",
  "LastModifiedTime": "2020-01-01T01:01:01.001Z",
  "CronExpression": "0 * * * * *",
  "Enable": true
}

    Error codes

    HTTP status codeError codeError messageDescription
    400APIVersionNotSupportedThe requested API version '%s' is not supported yet. Please check.-
    400InvalidArgumentParameter error.Parameter error.
    400MissingRequiredHeaderThe HTTP header '%s' must be specified.The HTTP header '%s' must be specified.
    400MissingRequiredParamsThe HTTP query '%s' must be specified.The HTTP query '%s' must be specified.
    403AccessDeniedThe resources doesn't belong to you.-
    404FlowNotExistsFlow %s does not exist.Flow %s does not exist.
    404ScheduleNotExistsThe schedule %s for flow %s does not exist.-
    409ConcurrentUpdateErrorUpdate conflict, please retry.Update conflict, please retry.
    412PreconditionFailedThe resource to be modified has been changed.The resource to be modified has been changed. Please try again later.
    500InternalServerErrorAn internal error has occurred. Please retry.An internal error has occurred. Please retry.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2024-03-21The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 403
      delete Error Codes: 404
      delete Error Codes: 409
      delete Error Codes: 412
      delete Error Codes: 500
    Input ParametersThe request parameters of the API has changed.
      delete Input Parameters: RequestId