ListNodesByOutput - DataWorks - Alibaba Cloud Documentation Center

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	ListNodesByOutput	The operation that you want to perform. Set the value to ListNodesByOutput.
ProjectEnv	String	Yes	PROD	The environment of Operation Center. Valid values: PROD and DEV. The value PROD indicates the production environment, and the value DEV indicates the development environment.
Outputs	String	Yes	aaaaa.1231412_out,bbbb.12313123_out	The output name of the node. You can specify multiple output names. Separate them with commas (,).

Response parameters

Parameter	Type	Example	Description
HttpStatusCode	Integer	200	The HTTP status code.
RequestId	String	SDFSDFSDF-asdfDFSDF-SDFSDf-SDfSFD	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	Array of OutputNodePair		The nodes returned.
Output	String	test_0709_1.630003556_out	The output name of the current node.
NodeList	Array of Node		The information about the nodes returned.
SchedulerType	String	NORMAL	The scheduling type of the node. Valid values: NORMAL: The node is an auto triggered node. The scheduling system regularly runs the node. MANUAL: The node is a manually triggered node. The scheduling system does not regularly run the node. PAUSE: The node is a frozen node. The scheduling system regularly runs the node but sets the status of the node to failed when the scheduling system starts to run the node. SKIP: The node is a dry-run node. The scheduling system regularly runs the node but sets the status of the node to successful when the scheduling system starts to run the node.
RepeatInterval	Integer	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.
FileType	String	ODPS_SQL	The type of the node. Valid values: 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data Integration), 24 (ODPS Script), 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), 1089 (cross-tenant collaboration), 1091 (Hologres development), 1093 (Hologres SQL), 1100 (assignment), and 1221 (PyODPS 3)
ProjectId	Long	33671	The DataWorks workspace ID.
ProgramType	String	ODPS_SQL	The type of the node. This parameter is deprecated. For more information about node types, see the valid values of the FileType parameter.
Priority	Integer	1	The priority of the node. Valid values: 1, 3, 5, 7, and 8. A greater value indicates a higher priority. Default value: 1.
OwnerId	String	19337906836551	The owner ID.
Connection	String	odps_source	The name of the data source.
ParamValues	String	a=b	The scheduling parameters of the node.
RelatedFlowId	Long	1235655464	The ID of the workflow to which the node belongs.
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	1235667	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.
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	125677	The node ID.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListNodesByOutput
&Outputs=aaaaa.1231412_out,bbbb.12313123_out
&ProjectEnv=PROD
&RegionId=cn-shanghai
&<Common request parameters>

Sample success responses

XML format

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

<ListNodesByOutputResponse>
    <RequestId>SDFSDFSDF-asdfDFSDF-SDFSDf-SDfSFD</RequestId>
    <HttpStatusCode>200</HttpStatusCode>
    <Data>
        <Output>test_0709_1.630003556_out</Output>
        <NodeList>
            <BaselineId>1235667</BaselineId>
            <ResGroupName>Shared resource group</ResGroupName>
            <Description>test</Description>
            <NodeName>liux_test_n****</NodeName>
            <DqcType>1</DqcType>
            <Priority>1</Priority>
            <ParamValues>a=b</ParamValues>
            <Connection>odps_source</Connection>
            <ProjectId>33671</ProjectId>
            <RelatedFlowId>1235655464</RelatedFlowId>
            <SchedulerType>NORMAL</SchedulerType>
            <CronExpress>00 00 00 * * ?</CronExpress>
            <Repeatability>true</Repeatability>
            <OwnerId>19337906836551</OwnerId>
            <FileType>ODPS_SQL</FileType>
            <DqcDescription>[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\u003d$[yyyy-mm-dd-1]"}]</DqcDescription>
            <NodeId>125677</NodeId>
            <ProgramType>ODPS_SQL</ProgramType>
            <RepeatInterval>60</RepeatInterval>
        </NodeList>
    </Data>
    <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
    <ErrorMessage>The connection does not exist.</ErrorMessage>
    <Success>true</Success>
</ListNodesByOutputResponse>

JSON format

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

{
  "RequestId" : "SDFSDFSDF-asdfDFSDF-SDFSDf-SDfSFD",
  "HttpStatusCode" : 200,
  "Data" : {
    "Output" : "test_0709_1.630003556_out",
    "NodeList" : {
      "BaselineId" : 1235667,
      "ResGroupName" : "Shared resource group",
      "Description" : "test",
      "NodeName" : "liux_test_n****",
      "DqcType" : 1,
      "Priority" : 1,
      "ParamValues" : "a=b",
      "Connection" : "odps_source",
      "ProjectId" : 33671,
      "RelatedFlowId" : 1235655464,
      "SchedulerType" : "NORMAL",
      "CronExpress" : "00 00 00 * * ?",
      "Repeatability" : true,
      "OwnerId" : 19337906836551,
      "FileType" : "ODPS_SQL",
      "DqcDescription" : "[{\"projectName\":\"ztjy_dim\",\"tableName\":\"dim_user_agent_manage_area_a\",\"partition\":\"ds\\u003d$[yyyy-mm-dd-1]\"}]",
      "NodeId" : 125677,
      "ProgramType" : "ODPS_SQL",
      "RepeatInterval" : 60
    }
  },
  "ErrorCode" : "Invalid.Tenant.ConnectionNotExists",
  "ErrorMessage" : "The connection does not exist.",
  "Success" : true
}

Error codes

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