ListNodes - DataWorks - Alibaba Cloud Documentation Center

The ID of the workspace.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
Owner	string	No	The description of the node.	193379****
BizName	string	No	The error code returned.	test_bizName
ProgramType	string	No	The operation that you want to perform. Set the value to ListNodes.	ODPS_SQL
PageNumber	integer	No	The number of entries to return on each page. Default value: 10. Maximum value: 100.	1
PageSize	integer	No	The ID of the workspace.	10
ProjectId	long	Yes	The ID of the owner.	1234
ProjectEnv	string	Yes	The number of entries returned per page. Default value: 10. Maximum value: 100. Enumeration Value: PROD DEV	PROD
NodeName	string	No	The ID of the baseline with which the node is associated.	liux_test_n****

Response parameters

Parameter	Type	Description	Example
	object	Indicates whether the node is associated with a monitoring rule in Data Quality. Valid values: 0 and 1. The value 0 indicates that the node is associated with Data Quality. The value 1 indicates that the node is not associated with Data Quality.
HttpStatusCode	integer	The interval at which the node is rerun after the node fails to run.	200
RequestId	string	The list of nodes.	E6F0DBDD-5AD****
ErrorMessage	string	The page number of the returned page.	The connection does not exist.
ErrorCode	string	The HTTP status code returned.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Indicates whether the node can be rerun.	true
Data	object	The ID of the associated workflow.
PageNumber	integer	The name of the node.	1
PageSize	integer	The cron expression returned.	10
TotalCount	integer	The name of the workflow.	66
Nodes	array<object>	The scheduling type of the node. Valid values: NORMAL: indicates that the node is a normal auto triggered node. MANUAL: indicates that the node is a manually triggered node. PAUSE: indicates that the node is a paused node. SKIP: indicates that the node is a dry-run node. Dry-run nodes are started as scheduled but the system sets the status of the nodes to successful when it starts to run them.
	object	The ID of the node.
SchedulerType	string	The types of the nodes. You can call the ListNodes operation to query the type of the node.	NORMAL
RepeatInterval	long	The environment of the workspace. Valid values: PROD and DEV.	60
Repeatability	boolean	The name of the node.	true
ProjectId	long	The information about the nodes.	33671
ProgramType	string	The error message returned.	ODPS_SQL
Priority	integer	The ID of the owner.	1
OwnerId	string	The additional parameters.	19337906836551
Connection	string	The name of the resource group.	odps_first
ParamValues	string	The type of the node.	a=b
RelatedFlowId	long	The table and partition filter expression in Data Quality that are associated with the node.	1231123
DqcType	integer	The connection string.	1
BaselineId	long	The number of the page to return. Minimum value: 1. Maximum value: 100.	123456
Description	string	The priority for running the node. Valid values: 1, 3, 5, 7, and 8.	test
NodeName	string	The total number of nodes returned.	liux_test_n****
ResGroupName	string	The ID of the workflow.	The ID of the request. You can use the ID to query logs and troubleshoot issues.
BusinessId	long	The operation that you want to perform. Set the value to ListNodes.	123
DqcDescription	string	The ID of the owner.	[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\u003d$[yyyy-mm-dd-1]"}]
CronExpress	string	The name of the workflow.	00 00 00 * * ?
NodeId	long	The types of the nodes. You can call the ListNodes operation to query the type of the node.	1234

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 200,
  "RequestId": "E6F0DBDD-5AD****",
  "ErrorMessage": "The connection does not exist.",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true,
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 66,
    "Nodes": [
      {
        "SchedulerType": "NORMAL",
        "RepeatInterval": 60,
        "Repeatability": true,
        "ProjectId": 33671,
        "ProgramType": "ODPS_SQL",
        "Priority": 1,
        "OwnerId": "19337906836551",
        "Connection": "odps_first",
        "ParamValues": "a=b",
        "RelatedFlowId": 1231123,
        "DqcType": 1,
        "BaselineId": 123456,
        "Description": "test",
        "NodeName": "liux_test_n****",
        "ResGroupName": "The ID of the request. You can use the ID to query logs and troubleshoot issues.\n",
        "BusinessId": 123,
        "DqcDescription": "[{\"projectName\":\"ztjy_dim\",\"tableName\":\"dim_user_agent_manage_area_a\",\"partition\":\"ds\\u003d$[yyyy-mm-dd-1]\"}]",
        "CronExpress": "00 00 00 * * ?",
        "NodeId": 1234,
        "ResGroupIdentifier": "",
        "FileType": 0
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-05-30	The response structure of the API has changed	View Change Details
2023-06-25	The internal configuration of the API is changed, but the call is not affected	View Change Details