All Products
Search
Document Center

DataWorks:ListNodeInputOrOutput

Last Updated:Feb 26, 2024

Queries the input and output information about a node.

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

ListNodeInputOrOutput

The operation that you want to perform. Set the value to ListNodeInputOrOutput.

NodeId

Long

Yes

12314567

The node ID. You can call the ListNodes operation to obtain the ID.

ProjectEnv

String

Yes

PROD

The environment of the workspace. Valid values: DEV and PROD. The value DEV indicates the development environment. The value PROD indicates the production environment.

IoType

String

Yes

output

The type of node that you want to query. Valid values:

  • input: ancestor node

  • output: descendant node

Response parameters

Parameter

Type

Example

Description

HttpStatusCode

Integer

200

The HTTP status code.

RequestId

String

E6F0DBDD-5AD****

The request ID.

ErrorMessage

String

The project does not exist.

The error message.

ErrorCode

String

Invalid.Tenant.ProjectNotExists

The error code.

Success

Boolean

true

Indicates whether the request was successful.

Data

Array of Data

The ancestor or descendant nodes.

TableName

String

dwd_xxx_table

This parameter does not take effect. You cannot obtain the parameter settings.

Data

String

xxxx.123141254_out

The name of the ancestor or descendant node.

NodeId

Long

1234667

The node ID.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListNodeInputOrOutput
&NodeId=12314567
&ProjectEnv=PROD
&IoType=output
&<Common request parameters>

Sample success responses

XML format

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

<ListNodeInputOrOutputResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <RequestId>E6F0DBDD-5AD****</RequestId>
    <ErrorMessage>The project does not exist.</ErrorMessage>
    <ErrorCode>Invalid.Tenant.ProjectNotExists</ErrorCode>
    <Success>true</Success>
    <Data>
        <TableName>dwd_xxx_table</TableName>
        <Data>xxxx.123141254_out</Data>
        <NodeId>1234667</NodeId>
    </Data>
</ListNodeInputOrOutputResponse>

JSON format

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

{
  "HttpStatusCode" : 200,
  "RequestId" : "E6F0DBDD-5AD****",
  "ErrorMessage" : "The project does not exist.",
  "ErrorCode" : "Invalid.Tenant.ProjectNotExists",
  "Success" : true,
  "Data" : {
    "TableName" : "dwd_xxx_table",
    "Data" : "xxxx.123141254_out",
    "NodeId" : 1234667
  }
}

Error codes

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