All Products
Search

This Product

    DataWorks:UpdateTask

    Document Center

    DataWorks:UpdateTask

    Last Updated:Jul 07, 2026

    Updates a specified node. The modifications are synchronized to DataStudio, where a new saved version is created.

    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

    dataworks:*

    update

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    Id

    integer

    Yes

    The node ID.

    1234
    ClientUniqueCode

    string

    No

    The client unique code of the node, used to uniquely identify a node. This code is used to implement asynchronous operations and idempotence. If not specified during creation, the system automatically generates one, and the code is uniquely bound to the resource ID. When updating or deleting a resource, if this parameter is specified, it must be consistent with the client unique code used during creation.

    Task_0bc5213917368545132902xxxxxxxx
    EnvType

    string

    No

    The project environment. Valid values:

    • Prod: production.

    • Dev: development.

    Prod
    Name

    string

    No

    The name.

    SQL node
    Description

    string

    No

    The description.

    test
    Owner

    string

    No

    The account ID of the node owner.

    1000
    InstanceMode

    string

    No

    The instance generation mode. Valid values:

    • T+1: The instance is generated the next day.

    • Immediately: The instance is generated immediately. Note: Only periodic instances whose scheduled time is at least ten minutes after the node publish time are generated normally. During the full instance generation period (22:00 to 24:00), real-time instance generation is not available. You can submit and publish nodes, but new nodes do not automatically generate instances.

    T+1
    Timeout

    integer

    No

    The node execution timeout period, in seconds. The value must be greater than 3600.

    3600
    RerunMode

    string

    No

    Specifies whether the node can be rerun. Valid values:

    • AllDenied: The node cannot be rerun regardless of whether it succeeds or fails.

    • FailureAllowed: The node can be rerun only when it fails.

    • AllAllowed: The node can be rerun regardless of whether it succeeds or fails.

    AllAllowed
    RerunTimes

    integer

    No

    The number of retries. This parameter takes effect when the node is configured to allow reruns.

    3
    RerunInterval

    integer

    No

    The retry time interval, in milliseconds. The value cannot exceed 1800000.

    60000
    Script

    object

    No

    The script information.

    Content deprecated

    string

    No

    The script content.

    echo "helloWorld"
    Parameters

    string

    No

    The list of script parameters.

    para1=$bizdate
    Trigger

    object

    No

    The node trigger method.

    Type

    string

    No

    The trigger type. Valid values:

    • Scheduler: periodic scheduling trigger.

    • Manual: manual trigger.

    Scheduler
    Recurrence

    string

    No

    The run mode when triggered. This parameter takes effect when Type is set to Scheduler. Valid values:

    • Pause: paused.

    • Skip: dry run.

    • Normal: normal run.

    Normal
    Cron

    string

    No

    The cron expression. This parameter takes effect when Type is set to Scheduler.

    00 00 00 * * ?
    StartTime

    string

    No

    The effective period of the epoch trigger. This parameter takes effect when Type is set to Scheduler. Format: yyyy-mm-dd hh:mm:ss.

    1970-01-01 00:00:00
    EndTime

    string

    No

    The expiration time of the periodic trigger. This parameter takes effect when Type is set to Scheduler. Format: yyyy-mm-dd hh:mm:ss.

    9999-01-01 00:00:00
    CycleType

    string

    No

    The epoch type. This parameter takes effect when Type is set to Scheduler and the cron expression specifies timed scheduling at a specific hour. Default value: Daily. Valid values:

    • Daily: daily scheduling.

    • NotDaily: hourly scheduling.

    Daily
    RuntimeResource

    object

    No

    The environment configuration, such as resource group information.

    ResourceGroupId

    string

    No

    The identifier of the schedule resource group configured for the node.

    S_res_group_524258031846018_1684XXXXXXXXX
    Image

    string

    No

    The image ID configured for the node.

    i-xxxxxx
    Cu

    string

    No

    The CU consumption configured for the node.

    0.25
    DataSource

    object

    No

    The associated data source information.

    Name

    string

    No

    The data source name.

    odps_test
    Inputs

    object

    No

    The input information.

    Variables

    array<object>

    No

    The list of variable definitions.

    object

    No

    Type

    string

    Yes

    The type. Valid values:

    • Constant: constant.

    • PassThrough: parameter node output.

    • System: variable.

    • NodeOutput: script output.

    Constant
    Value

    string

    No

    The variable value.

    value1
    Name

    string

    No

    The variable name.

    key1
    Outputs

    object

    No

    The output information.

    TaskOutputs

    array<object>

    No

    The list of node output definitions.

    object

    No

    Output

    string

    No

    The output identifier.

    pre.odps_sql_demo_0
    Variables

    array<object>

    No

    The list of variable definitions.

    object

    No

    Type

    string

    Yes

    The type. Valid values:

    • Constant: constant.

    • PassThrough: parameter node output.

    • System: variable.

    • NodeOutput: script output.

    Constant
    Value

    string

    No

    The variable value.

    value1
    Name

    string

    No

    The variable name.

    key1
    Dependencies

    array<object>

    No

    The dependency information.

    object

    No

    Type

    string

    Yes

    The dependency type. Valid values:

    • CrossCycleDependsOnChildren: cross-cycle dependency on first-level child nodes.

    • CrossCycleDependsOnSelf: cross-cycle dependency on self.

    • CrossCycleDependsOnOtherNode: cross-cycle dependency on other nodes.

    • Normal: same-cycle dependency.

    Normal
    UpstreamOutput

    string

    No

    The output identifier of the upstream node. This field is returned when the dependency type is same-cycle dependency and input content is configured.

    pre.odps_sql_demo_0
    UpstreamTaskId

    integer

    No

    The ID of the upstream node. This field is returned when the dependency type is cross-cycle dependency on other nodes, or same-cycle dependency without input content configured. It is not returned in other cases.

    1234
    Tags

    array<object>

    No

    The list of node tags.

    object

    No

    Value

    string

    No

    The tag value.

    value1
    Key

    string

    Yes

    The tag key.

    key1

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID, used for locating logs and troubleshooting issues.

    22C97E95-F023-56B5-8852-B1A77A17XXXX
    Success

    boolean

    Indicates whether the operation was successful.

    true

    Examples

    Success response

    JSON format

    {
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
  "Success": true
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.