All Products
Search
Document Center

Data Management:UpdateTaskConfig

Last Updated:Nov 28, 2024

Updates the advanced configuration of a task node.

Operation description

You can call this operation to configure a failed task or rerun a task.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dms:UpdateTaskConfigupdate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TidlongNo

The ID of the tenant. You can call the GetUserActiveTenant or ListUserTenants operation to query the tenant ID.

3***
NodeIdstringYes

The ID of the task node. You can call the GetTaskInstanceRelation operation to query the node ID.

43****
NodeConfigstringYes

The advanced configuration for the node. The value of this parameter must be a JSON string.

{ "rerun":{ "rerunEnable":true, "rerunCount":1, "rerunInterval":10 } }

The following sample code provides an example on how to specify the NodeConfig parameter:

 
    "rerun":{ // This field is required.
        "rerunEnable":true, // Specifies whether to enable rerun.
        "rerunCount":1, // The number of reruns.
        "rerunInterval":10 // The interval between each rerun.
     
 

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

F4E2A94B-604F-43FF-93E7-F4EE3DCF412E
ErrorCodestring

The error code returned if the request failed.

UnknownError
ErrorMessagestring

The error message returned if the request failed.

UnknownError
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true

Examples

Sample success responses

JSONformat

{
  "RequestId": "F4E2A94B-604F-43FF-93E7-F4EE3DCF412E",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history