All Products
Search
Document Center

DataWorks:ListNodes

Last Updated:Feb 08, 2025

The ID of the workspace.

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.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dataworks:*list
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
OwnerstringNo

The description of the node.

193379****
BizNamestringNo

The error code returned.

test_bizName
ProgramTypestringNo

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

ODPS_SQL
PageNumberintegerNo

The page number. Minimum value: 1. Maximum value: 100.

1
PageSizeintegerNo

The number of entries per page. Default value: 10. Maximum value: 100.

10
ProjectIdlongYes

The ID of the owner.

1234
ProjectEnvstringYes

The environment in which the node runs. Valid values: DEV and PROD.

PROD
NodeNamestringNo

The ID of the baseline with which the node is associated.

liux_test_n****
SchedulerTypestringNo

The scheduling type. Valid values:

  • NORMAL: Nodes are scheduled as expected.
  • PAUSE: Nodes are paused.
  • SKIP: Nodes are dry-run. Dry-run nodes are started as scheduled, but the system sets the status of the nodes to successful when it starts to run them.
NORMAL

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

HttpStatusCodeinteger

The interval at which the node is rerun after the node fails to run.

200
RequestIdstring

The list of nodes.

E6F0DBDD-5AD****
ErrorMessagestring

The page number of the returned page.

The connection does not exist.
ErrorCodestring

The HTTP status code returned.

Invalid.Tenant.ConnectionNotExists
Successboolean

Indicates whether the node can be rerun.

true
Dataobject

The nodes.

PageNumberinteger

The name of the node.

1
PageSizeinteger

The cron expression returned.

10
TotalCountinteger

The name of the workflow.

66
Nodesarray<object>

The information about the nodes.

Nodesobject

The returned result.

SchedulerTypestring

The types of the nodes. You can call the ListNodes operation to query the type of the node.

NORMAL
RepeatIntervallong

The environment of the workspace. Valid values: PROD and DEV.

60
Repeatabilityboolean

The name of the node.

true
RepeatModeinteger

The rerun mode. The value 0 indicates that rerun can be performed only if a failure occurs. The value 1 indicates that rerun can be performed in all cases. The value 2 indicates that rerun cannot be performed in all cases.

1
ProjectIdlong

The information about the nodes.

33671
ProgramTypestring

The error message returned.

ODPS_SQL
Priorityinteger

The ID of the owner.

1
OwnerIdstring

The additional parameters.

19337906836551
Connectionstring

The name of the resource group.

odps_first
ParamValuesstring

The type of the node.

a=b
RelatedFlowIdlong

The table and partition filter expression in Data Quality that are associated with the node.

1231123
DqcTypeinteger

The connection string.

1
BaselineIdlong

The number of the page to return. Minimum value: 1. Maximum value: 100.

123456
Descriptionstring

The priority for running the node. Valid values: 1, 3, 5, 7, and 8.

test
NodeNamestring

The total number of nodes returned.

liux_test_n****
ResGroupNamestring

The ID of the workflow.

The ID of the request. You can use the ID to query logs and troubleshoot issues.
BusinessIdlong

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

123
DqcDescriptionstring

The ID of the owner.

[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\u003d$[yyyy-mm-dd-1]"}]
CronExpressstring

The name of the workflow.

00 00 00 * * ?
NodeIdlong

The types of the nodes. You can call the ListNodes operation to query the type of the node.

1234
ResGroupIdentifierstring

The identifier of the resource group.

group_123
FileTypeinteger

Different file types have different codes. For more information, see DataWorks node collection. You can also call the ListFileType interface to query the code type of the file.

10
FileIdlong

The file ID. You can call the ListFiles operation to query the ID.

20
FileVersioninteger

The latest version number of the file.

3
DeployDatelong

The timestamp when the node was deployed. Unit: milliseconds.

1734537600000
CreateTimelong

The timestamp when the node was created. Unit: milliseconds.

1593879116000
ModifyTimelong

The timestamp when the node was modified. Unit: milliseconds.

1593879116000

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,
        "RepeatMode": 1,
        "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": "group_123",
        "FileType": 10,
        "FileId": 20,
        "FileVersion": 3,
        "DeployDate": 1734537600000,
        "CreateTime": 1593879116000,
        "ModifyTime": 1593879116000
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-10-17The response structure of the API has changedView Change Details
2024-05-30The response structure of the API has changedView Change Details
2023-06-25The internal configuration of the API is changed, but the call is not affectedView Change Details