All Products
Search
Document Center

Data Management:CreateTaskFlow

Last Updated:Nov 28, 2024

Creates a task flow.

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:CreateTaskFlowcreate
*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***
DagNamestringYes

The name of the task flow.

Dag_Name
DescriptionstringNo

The description of the task flow.

zht_test
ScenarioIdlongNo

The ID of the scenario.

2**

DagName is unique to each task flow. If the DagName you specify already exists, the request fails.

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request. You can use the ID to query logs and troubleshoot issues.

19DA51A9-AC3E-5C36-8351-07EBCD2B89A1
ErrorCodestring

The error code returned if the request failed.

UnknownError
ErrorMessagestring

The error message returned if the request failed.

User can not access to Tenant [1]
Successboolean

Indicates whether the request was successful. Valid values:

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

The ID of the task flow.

33***

Examples

Sample success responses

JSONformat

{
  "RequestId": "19DA51A9-AC3E-5C36-8351-07EBCD2B89A1",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "User can not access to Tenant [1]",
  "Success": true,
  "DagId": 0
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history