All Products
Search

This Product

    :ModifyScheduleTask

    Document Center

    :ModifyScheduleTask

    Last Updated:Dec 11, 2025

    Modifies the specified scheduled task.

    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

    polardb:ModifyScheduleTask

    update

    *DBCluster

    acs:polardb:{#regionId}:{#accountId}:{#resource-type}/{#resource-id}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DBClusterId

    string

    Yes

    The cluster ID.

    Note

    You can call the DescribeDBClusters operation to query the details of all clusters in your account, including cluster IDs.

    pc-****************

    TaskId

    string

    Yes

    The task ID.

    53879cdb-9a00-428e-acaf-ff4cff******

    ResourceGroupId

    string

    No

    The resource group ID.

    rg-************
    PlannedStartTime

    string

    Yes

    The earliest time to start the scheduled task. The time is in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.

    Note

    • The start time can be any point in time within the next 24 hours. For example, if the current time is 2021-01-14T09:00:00Z, you can set the start time to a value in the range of 2021-01-14T09:00:00Z to 2021-01-15T09:00:00Z.

    • If you leave this parameter empty, the task is executed immediately.

    2023-05-15T20:00:00Z
    PlannedEndTime

    string

    Yes

    The latest time to start the scheduled task. The time is in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.

    Note

    • The latest start time must be at least 30 minutes later than the earliest start time.

    • If you specify PlannedStartTime but not this parameter, the latest start time of the task is PlannedStartTime + 30 minutes by default. For example, if you set PlannedStartTime to 2021-01-14T09:00:00Z and leave this parameter empty, the task will be executed no later than 2021-01-14T09:30:00Z.

    2023-04-18T19:20:00Z

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    E56531A4-E552-40BA-9C58-137B80******

    Success

    boolean

    The result of the request. Valid values:

    • true: The request was successful.

    • false: The request failed.

    True

    Examples

    Success response

    JSON format

    {
  "RequestId": "E56531A4-E552-40BA-9C58-137B80******\t\n",
  "Success": true
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidTimerParam.StartTime The specified plannedStartTime is not valid The specified earliest time of the scheduled task is invalid.
    404 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid. The specified DBClusterId parameter is invalid.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.