GetTask - Query task node configuration | DMS API - Data Management

Queries the configuration of a task node by node ID, including time variables.

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

dms:GetTask

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Tid	integer	No	The ID of the tenant. Note To view the tenant ID, log on to the DMS console and hover over the profile picture in the upper-right corner. View information about the current tenant.	3***
NodeId	integer	Yes	The ID of the task node. Call GetTaskInstanceRelation to query the node ID.	51***

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID, used for log queries and troubleshooting.	7838266C-E17B-58F4-B072-4DC356B58258
ErrorCode	string	The error code returned if the request failed.	UnknownError
ErrorMessage	string	The error message returned if the request failed.	UnknownError
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
Task	object	The task node.
DagId	integer	The ID of the task flow to which the node belongs.	7321
NodeName	string	The name of the node.	Cross-Database Spark SQL-1
NodeType	string	The type of the node. Valid values: NodeType parameter.	SPARK_SQL
NodeContent	string	The node configuration.	{\"dbList\":[{\"instanceId\":177****}" }
TimeVariables	string	The time variables of the node.	{\"variables\":[{\"name\":\"Today\",\"pattern\":\"yyyy-MM-dd\|+1d\"}]}
NodeConfig	string	The advanced configuration of the node.	{\"dbId\":39***,\"dbType\":\"mysql\",\"locale\":\"zh\",\"sql\":\"/ Make sure the following SQL meets your requirements before you submit it for execution */\\n\\nCREATE TABLE IF NOT EXISTS `momo_weekGather` (\\n\\t`id` bigint AUTO_INCREMENT DEFAULT '0',\\n\\t`age` bit NULL,\\n\\t`action` varchar(150) NULL,\\n\\t`elapse_time` datetime NULL,\\n\\tPRIMARY KEY (`id`)\\n) ENGINE=InnoDB\\nDEFAULT CHARACTER SET=utf8;\"}
NodeOutput	string	The output variables of the node. Available only for certain node types.	{ "outputs":[ "extractMethod":"json" , "variableName":"var", "description":"demo desc" } ] }
GraphParam	string	The position of the node on the Directed Acyclic Graph (DAG).	{"{\"x\":0,\"y\":0,\"layoutType\":\"Horizontal\"}", "id": 51***}

The TimeVariables value is a JSON string. Example:

{
    "variables":[
        {
            "name":"var",// The name of the variable.
            /*
            Variable format
            As shown in the example, the date can have one or more offsets, including minutes (m), hours (h), days (d), weeks (w), months (M), or years (y). The offsets are optional, and you can specify the offsets in a different order than described here. 
            */
            "pattern":"yyyy-MM-dd|+0d" 
        },
        {
            "name":"test",
            "pattern":"yyyy-MM-dd|+0d"
        }
    ]
}

Examples

Success response

JSON format

{
  "RequestId": "7838266C-E17B-58F4-B072-4DC356B58258",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "Task": {
    "DagId": 7321,
    "NodeName": "Cross-Database Spark SQL-1",
    "NodeType": "SPARK_SQL",
    "NodeContent": "{\\\"dbList\\\":[{\\\"instanceId\\\":177****}\"   }",
    "TimeVariables": "{\\\"variables\\\":[{\\\"name\\\":\\\"Today\\\",\\\"pattern\\\":\\\"yyyy-MM-dd|+1d\\\"}]}",
    "NodeConfig": "{\\\"dbId\\\":39****,\\\"dbType\\\":\\\"mysql\\\",\\\"locale\\\":\\\"zh\\\",\\\"sql\\\":\\\"/* Make sure the following SQL meets your requirements before you submit it for execution */\\\\n\\\\nCREATE TABLE IF NOT EXISTS `momo_weekGather` (\\\\n\\\\t`id` bigint AUTO_INCREMENT DEFAULT '0',\\\\n\\\\t`age` bit NULL,\\\\n\\\\t`action` varchar(150) NULL,\\\\n\\\\t`elapse_time` datetime NULL,\\\\n\\\\tPRIMARY KEY (`id`)\\\\n) ENGINE=InnoDB\\\\nDEFAULT CHARACTER SET=utf8;\\\"}",
    "NodeOutput": "{ \"outputs\":[ \"extractMethod\":\"json\" , \"variableName\":\"var\",   \"description\":\"demo desc\" } ] }",
    "GraphParam": "{\"{\\\"x\\\":0,\\\"y\\\":0,\\\"layoutType\\\":\\\"Horizontal\\\"}\",  \"id\": 51***}"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.