ListInnerNodes - DataWorks - Alibaba Cloud Documentation Center

Queries information about inner nodes. For example, you can call this operation to query the inner nodes of a node group or a do-while node. You cannot call this operation to query the inner nodes of a PAI node.

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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ProgramType	string	No	The type of the node to which the inner nodes belong. Valid values: 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data Integration), 24 (ODPS Script), 97 (PAI), 98 (node group), 99 (zero load), 221 (PyODPS 2), 225 (ODPS Spark), 227 (EMR Hive), 228 (EMR Spark), 229 (EMR Spark SQL), 230 (EMR MR), 239 (OSS object inspection), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (real-time synchronization), 1002 (PAI inner node), 1089 (cross-tenant collaboration), 1091 (Hologres development), 1093 (Hologres SQL), 1100 (assignment), 1106 (for-each), and 1221 (PyODPS 3). You can call the ListNodes operation to query the type of the node.	ODPS_SQL
PageNumber	integer	No	The page number. Valid values: 1 to 100.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 100.	10
ProjectId	long	Yes	The workspace ID.	1234
ProjectEnv	string	No	The environment in which the node is run. Valid values: DEV and PROD. Default value: PROD.	PROD
NodeName	string	No	The name of the node to which the inner nodes belong.	liux_test_n****
OuterNodeId	long	Yes	The ID of the node group to which the inner nodes belong.	1234

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	E6F0DBDD-5AD****
Success	boolean	Indicates whether the request was successful.	true
Paging	object	The pagination information.
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page. Default value: 10. Maximum value: 100.	10
TotalCount	integer	The total number of inner nodes returned.	100
Nodes	array<object>	The list of inner nodes.
Nodes	object
SchedulerType	string	The scheduling type of the inner node. Valid values: NORMAL: The inner node is an auto triggered node. MANUAL: The inner node is a manually triggered node. The scheduling system does not run the node on a regular basis. PAUSE: The inner node is a paused node. SKIP: The inner node is a dry-run node. Dry-run nodes are started as scheduled, but the scheduling system sets the status of the nodes to successful when it starts to run them.	NORMAL
RepeatInterval	long	The interval at which the inner node is rerun after the inner node fails to run.	60
Repeatability	boolean	Indicates whether the inner node can be rerun.	true
ProjectId	long	The workspace ID.	123
ProgramType	string	The type of the inner node.	ODPS_SQL
Priority	integer	The priority of the inner node. Valid values: 1, 3, 5, 7, and 8.	1
OwnerId	string	The owner ID.	1933****36551
Connection	string	The connection string.	odps_first
ParamValues	string	The additional parameters.	a=b
DqcType	string	Indicates whether the inner node is associated with a monitoring rule in Data Quality. Valid values: 0 and 1. The value 0 indicates that the inner node is associated with a monitoring rule in Data Quality. The value 1 indicates that the inner node is not associated with a monitoring rule in Data Quality.	1
BaselineId	long	The baseline ID.	1234
Description	string	The description of the inner node.	test
NodeName	string	The name of the inner node.	liux_test_n****
ResGroupName	string	The name of the resource group.
BusinessId	long	The workflow ID.	123
DqcDescription	string	The table and partition filter expression in Data Quality that are associated with the inner node.	[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\u003d$[yyyy-mm-dd-1]"}]
CronExpress	string	The CRON expression.	00 00 00 * * ?
NodeId	long	The inner node ID.	12

Examples

Sample success responses

JSONformat

{
  "RequestId": "E6F0DBDD-5AD****",
  "Success": true,
  "Paging": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 100,
    "Nodes": [
      {
        "SchedulerType": "NORMAL",
        "RepeatInterval": 60,
        "Repeatability": true,
        "ProjectId": 123,
        "ProgramType": "ODPS_SQL",
        "Priority": 1,
        "OwnerId": "1933****36551",
        "Connection": "odps_first",
        "ParamValues": "a=b",
        "DqcType": "1",
        "BaselineId": 1234,
        "Description": "test",
        "NodeName": "liux_test_n****",
        "ResGroupName": "",
        "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": 12
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history