All Products
Search

This Product

    CloudFlow:UpdateSchedule

    Document Center

    CloudFlow:UpdateSchedule

    Last Updated:Aug 28, 2026

    Updates a time-based schedule.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    fnf:UpdateSchedule

    update

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    FlowName

    string

    Yes

    The name of the flow associated with the time-based schedule. The name must be unique within the region and cannot be modified after the 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
    ScheduleName

    string

    Yes

    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
    Description

    string

    No

    The description of the time-based schedule.

    test description
    Payload

    string

    No

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

    {"key": "value"}
    CronExpression

    string

    No

    The CRON expression.

    0 * * * * *
    Enable

    boolean

    No

    Whether to enable the time-based schedule. Valid values:

    • true

    • false

    true

    Response elements

    Element

    Type

    Description

    Example

    object

    The response schema.

    RequestId

    string

    The request ID.

    testRequestId
    Description

    string

    The description of the time-based schedule.

    test description
    ScheduleId

    string

    The ID of the time-based schedule.

    testScheduleId
    Payload

    string

    The trigger message of the time-based schedule.

    {"key": "value"}
    ScheduleName

    string

    The name of the time-based schedule.

    testScheduleName
    CreatedTime

    string

    The time when the time-based schedule was created.

    2020-01-01T01:01:01.001Z
    LastModifiedTime

    string

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

    2020-01-01T01:01:01.001Z
    CronExpression

    string

    The CRON expression.

    0 * * * * *
    Enable

    boolean

    Whether the time-based schedule is enabled. Valid values:

    • true

    • false

    true

    Examples

    Success response

    JSON format

    {
  "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 code

    Error code

    Error message

    Description
    400 APIVersionNotSupported The requested API version '%s' is not supported yet. Please check.
    400 InvalidArgument Parameter error.
    400 MissingRequiredHeader The HTTP header '%s' must be specified.
    400 MissingRequiredParams The HTTP query '%s' must be specified.
    412 PreconditionFailed The resource to be modified has been changed.
    500 InternalServerError An internal error has occurred. Please retry.
    403 AccessDenied The resources doesn't belong to you.
    404 FlowNotExists Flow %s does not exist.
    404 ScheduleNotExists The schedule %s for flow %s does not exist.
    409 ConcurrentUpdateError Update conflict, please retry.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.