All Products
Search
Document Center

DataWorks:ListDeploymentPackageFiles

Last Updated:Jan 12, 2026

Queries a list of versions of files to be deployed.

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
ProjectIdlongYes

The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID.

12345
BusinessIdlongNo

The workflow ID. You can call the ListBusiness operation to query the workflow ID by name.

100001
SolutionIdlongNo

The solution ID.

8065
CommitFromstringNo

The start date for committing. Specify the date in the yyyy-MM-dd format.

2025-01-01
CommitTostringNo

The end date (included) for committing. Specify the date in the yyyy-MM-dd format.

2025-01-31
CommitUserIdstringNo

The ID of the user who commits the file.

2003****
FileTypeintegerNo

The type of the code for the file.

The code for files varies based on the file type. For more information, see DataWorks nodes. You can call the ListFileType operation to query the type of the code for the file.

10
ChangeTypeintegerNo

The change type. Valid values:

  • 0: addition
  • 1: update
  • 2: deletion
0
FileIdsarrayNo

The IDs of the files to be queried.

stringNo

The ID of the file to be queried.

11223**
FileNamestringNo

The name of the file.

Filename
PageNumberintegerNo

The page number.

1
PageSizeintegerNo

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

20

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

0000-ABCD-EFG****
PagingInfoobject

The pagination details.

TotalCountinteger

The total number of entries returned.

100
PageNumberinteger

The page number. Pages start from page 1.

1
PageSizeinteger

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

10
DeploymentPackageFilesarray<object>

The list of files pending deployment.

DeploymentPackageFileobject

The details of the version of the file to be deployed.

Idlong

The unique ID.

650433503
FileIdlong

The file ID.

520246913
FileVersionlong

The file version.

34
CommitTimestring

The time for committing.

2025-04-10 15:55:47
CommitUserstring

The ID of the Alibaba Cloud account used by the user who committed the file.

446***
CommitUserNamestring

The name of the Alibaba Cloud account used by the user who committed the file.

user***
ProjectIdlong

The workspace ID.

27595
TenantIdlong

The DataWorks tenant ID.

639415964191360
FileTypeinteger

The file type. The code for files varies based on the file type. For more information, see DataWorks nodes.

13
FileNamestring

The name of the file of the current version.

bak_part_basc_person_relation_all_da
Statusinteger

The status of the code file of the current version. Valid values:

  • 2: Commit check in progress.
  • 3: Commit check passed.
  • 4: Commit check failed.
  • 10: Committing.
  • 11: Committed.
  • 20: Approved.
  • 21: Rejected.
  • 22: Warning detected during checking.
  • 23: Under code review.
  • 24: Code review rejected.
  • 80: Deployment package created.
  • 100: Deploying.
  • 101: Deployed to the production environment.
  • 200: Cancelled.
100
ChangeTypeinteger

The change type, which is an integer. Valid values:

  • 0: addition
  • 1: update
  • 2: deletion
0
IsSameAsProductionVersionboolean

Indicates whether the version is a version in the production environment of the scheduling system.

true
NodeIdlong

The ID of the auto triggered node that corresponds to the file.

700005008419
Commentstring

The comment for committing.

NodeConfigurationstring

The scheduling property configurations of the node that corresponds to the file, which is a JSON string.

{ "tagList": [], "fileId": -1, "taskRerunTime": 0, "taskRerunInterval": 0, "reRunAble": 1, "nodeId": 125803000, "nodeName": "new", "nodeType": 0, "isStop": 0, "paraValue": "", "startEffectDate": "1970-01-01 00:00:00", "endEffectDate": "9999-01-01 00:00:00", "cronExpress": "00 26 00 * * ?", "owner": "1107550004250000", "resgroupId": 6300000, "cu": "0.25", "appId": 170000, "tenantId": 524257424560000, "createTime": "2025-04-10 15:55:01", "createUser": "1107550004250000", "lastModifyTime": "2025-04-10 15:55:41", "cycleType": 0, "dependentType": 0, "dependentTypeList": [0], "lastModifyUser": "1107550004250000", "dependentDataNode": "", "input": "[{\"regionId\":\"cn-hangzhou\",\"str\":\"root_input\",\"parseType\":1}]", "output": "[{\"str\":\"project_root.526586287_out\",\"parseType\":2},{\"str\":\"project_root.new\",\"parseType\":1}]", "inputList": [{ "regionId": "cn-hangzhou", "str": "root_input", "parseType": 1 }], "outputList": [{ "str": "project_root.526586287_out", "parseType": 2 }, { "str": "project_root.new", "parseType": 1 }], "isAutoParse": 1, "startRightNow": false, "extConfig": "{\"openCustomCron\":false,\"formCron\":\"\"}", "inputContextList": [], "outputContextList": [] }
UseTypestring

The module to which the file belongs. Valid values:

  • NORMAL: The file is used for DataStudio.
  • MANUAL: The file is used for a manually triggered node.
  • MANUAL_BIZ: The file is used for a manually triggered workflow.
  • SKIP: The file is used for a dry-run node in DataStudio.
  • ADHOCQUERY: The file is used for an ad hoc query.
  • COMPONENT: The file is used for a script template.
NORMAL
SmokeTestStatusstring

The test status in the development environment.

Examples

Sample success responses

JSONformat

{
  "RequestId": "0000-ABCD-EFG****",
  "PagingInfo": {
    "TotalCount": 100,
    "PageNumber": 1,
    "PageSize": 10,
    "DeploymentPackageFiles": [
      {
        "Id": 650433503,
        "FileId": 520246913,
        "FileVersion": 34,
        "CommitTime": "2025-04-10 15:55:47",
        "CommitUser": "446***",
        "CommitUserName": "user***",
        "ProjectId": 27595,
        "TenantId": 639415964191360,
        "FileType": 13,
        "FileName": "bak_part_basc_person_relation_all_da",
        "Status": 100,
        "ChangeType": 0,
        "IsSameAsProductionVersion": true,
        "NodeId": 700005008419,
        "Comment": "",
        "NodeConfiguration": {
          "tagList": [],
          "fileId": -1,
          "taskRerunTime": 0,
          "taskRerunInterval": 0,
          "reRunAble": 1,
          "nodeId": 125803000,
          "nodeName": "new",
          "nodeType": 0,
          "isStop": 0,
          "paraValue": "",
          "startEffectDate": "1970-01-01 00:00:00",
          "endEffectDate": "9999-01-01 00:00:00",
          "cronExpress": "00 26 00 * * ?",
          "owner": 1107550004250000,
          "resgroupId": 6300000,
          "cu": 0.25,
          "appId": 170000,
          "tenantId": 524257424560000,
          "createTime": "2025-04-10 15:55:01",
          "createUser": 1107550004250000,
          "lastModifyTime": "2025-04-10 15:55:41",
          "cycleType": 0,
          "dependentType": 0,
          "dependentTypeList": [
            0
          ],
          "lastModifyUser": 1107550004250000,
          "dependentDataNode": "",
          "input": [
            {
              "regionId": "cn-hangzhou",
              "str": "root_input",
              "parseType": 1
            }
          ],
          "output": [
            {
              "str": "project_root.526586287_out",
              "parseType": 2
            },
            {
              "str": "project_root.new",
              "parseType": 1
            }
          ],
          "inputList": [
            {
              "regionId": "cn-hangzhou",
              "str": "root_input",
              "parseType": 1
            }
          ],
          "outputList": [
            {
              "str": "project_root.526586287_out",
              "parseType": 2
            },
            {
              "str": "project_root.new",
              "parseType": 1
            }
          ],
          "isAutoParse": 1,
          "startRightNow": false,
          "extConfig": {
            "openCustomCron": false,
            "formCron": ""
          },
          "inputContextList": [],
          "outputContextList": []
        },
        "UseType": "NORMAL",
        "SmokeTestStatus": ""
      }
    ]
  }
}

Error codes

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