ListNodes - DataWorks - Alibaba Cloud Documentation Center

Queries a list of nodes.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	ListNodes	The operation that you want to perform. Set the value to ListNodes.
Owner	String	No	193379****	The owner ID.
BizName	String	No	test_bizName	The name of the workflow.
ProgramType	String	No	ODPS_SQL	The node type. You can call the ListFileType operation to query the type.
PageNumber	Integer	No	1	The page number. Valid values: 1 to 100.
PageSize	Integer	No	10	The number of entries per page. Valid values: 1 to 100. Default value: 10.
ProjectId	Long	Yes	1234	The workspace ID.
ProjectEnv	String	Yes	PROD	The environment of the workspace. Valid values: PROD and DEV.
NodeName	String	No	liux_test_n****	The name of the node.
SchedulerType	String	No	NORMAL	The scheduling type of the node. Valid values: NORMAL: The node is an auto triggered node. PAUSE: The node is a paused node. SKIP: 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.

Response parameters

Parameter	Type	Example	Description
HttpStatusCode	Integer	200	The HTTP status code.
RequestId	String	E6F0DBDD-5AD****	The request ID.
ErrorMessage	String	The connection does not exist.	The error message.
ErrorCode	String	Invalid.Tenant.ConnectionNotExists	The error code.
Success	Boolean	true	Indicates whether the request was successful.
Data	Object		The list of nodes.
PageNumber	Integer	1	The page number.
PageSize	Integer	10	The number of entries per page. Valid values: 1 to 100. Default value: 10.
TotalCount	Integer	66	The total number of nodes returned.
Nodes	Array of Nodes		The information about the nodes.
SchedulerType	String	NORMAL	The scheduling type of the node. Valid values: NORMAL: The node is an auto triggered node. PAUSE: The node is a paused node. SKIP: 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.
RepeatInterval	Long	60	The interval at which the node is rerun after the node fails to run.
Repeatability	Boolean	true	Indicates whether the node can be rerun.
ProjectId	Long	33671	The workspace ID.
ProgramType	String	ODPS_SQL	The node type.
Priority	Integer	1	The priority of the node. Valid values: 1, 3, 5, 7, and 8.
OwnerId	String	19337906836551	The owner ID.
Connection	String	odps_source	The connection string.
ParamValues	String	a=b	The additional parameters.
RelatedFlowId	Long	1231123	The associated workflow ID.
DqcType	Integer	1	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 a monitoring rule in Data Quality. The value 1 indicates that the node is not associated with a monitoring rule in Data Quality.
BaselineId	Long	123456	The baseline ID.
Description	String	test	The description of the node.
NodeName	String	liux_test_n****	The name of the node.
ResGroupName	String	Shared resource group	The name of the resource group.
BusinessId	Long	123	The workflow ID.
DqcDescription	String	[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\u003d$[yyyy-mm-dd-1]"}]	The table and partition filter expression in Data Quality that are associated with the node.
CronExpress	String	00 00 00 * * ?	The CRON expression.
NodeId	Long	1234	The node ID.
ResGroupIdentifier	String	group_123	The identifier of the resource group.
FileType	Integer	10	The file type.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListNodes
&Owner=193379****
&BizName=test_bizName
&ProgramType=ODPS_SQL
&PageNumber=1
&PageSize=10
&ProjectId=1234
&ProjectEnv=PROD
&NodeName=liux_test_n****
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ListNodesResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <RequestId>E6F0DBDD-5AD****</RequestId>
    <ErrorMessage>The connection does not exist.</ErrorMessage>
    <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
    <Success>true</Success>
    <Data>
        <PageNumber>1</PageNumber>
        <PageSize>10</PageSize>
        <TotalCount>66</TotalCount>
        <Nodes>
            <SchedulerType>NORMAL</SchedulerType>
            <RepeatInterval>60</RepeatInterval>
            <Repeatability>true</Repeatability>
            <ProjectId>33671</ProjectId>
            <ProgramType>ODPS_SQL</ProgramType>
            <Priority>1</Priority>
            <OwnerId>19337906836551</OwnerId>
            <Connection>odps_source</Connection>
            <ParamValues>a=b</ParamValues>
            <RelatedFlowId>1231123</RelatedFlowId>
            <DqcType>1</DqcType>
            <BaselineId>123456</BaselineId>
            <Description>test</Description>
            <NodeName>liux_test_n****</NodeName>
            <ResGroupName>Shared resource group</ResGroupName>
            <BusinessId>123</BusinessId>
            <DqcDescription>[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\u003d$[yyyy-mm-dd-1]"}]</DqcDescription>
            <CronExpress>00 00 00 * * ?</CronExpress>
            <NodeId>1234</NodeId>
            <ResGroupIdentifier>group_123</ResGroupIdentifier>
            <FileType>10</FileType>
        </Nodes>
    </Data>
</ListNodesResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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_source",
      "ParamValues" : "a=b",
      "RelatedFlowId" : 1231123,
      "DqcType" : 1,
      "BaselineId" : 123456,
      "Description" : "test",
      "NodeName" : "liux_test_n****",
      "ResGroupName" : "Shared resource group",
      "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" : "group_123",
      "FileType" : 10
    } ]
  }
}

Error codes

For a list of error codes, see Service error codes.