All Products
Search
Document Center

DataWorks:UpdateTaskInstances

Last Updated:Dec 10, 2024

Modifies properties configured for multiple instances at a time. The properties include the priority, resource group for scheduling, and data source.

Operation description

This API operation is available for all DataWorks editions.

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

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
TaskInstancesarray<object>No

The instances.

objectNo
IdlongYes

The instance ID.

1234
PriorityintegerNo

The priority of the instance. Valid values: 1, 3, 5, 7, and 8.

A larger value indicates a higher priority. Default value: 1.

1
RuntimeResourcestringNo

The resource group information. Set this parameter to the ID of a resource group for scheduling.

S_res_group_524258031846018_1684XXXXXXXXX
DataSourceobjectNo

The information about the associated data source.

NamestringNo

The name of the data source.

mysql_test
CommentstringNo

The remarks.

this is a comment

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

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

The result of the batch operation, which is in the MAP structure. The instance ID serves as a key, and the result serves as a value.

object

The result.

Successboolean

Indicates whether the request was successful.

true
Messagestring

The error message.

Examples

Sample success responses

JSONformat

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX\n",
  "SuccessInfo": {
    "key": {
      "Success": true,
      "Message": ""
    }
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history