Use ListDeploymentPackageFiles API to Track File Versions - DataWorks - Alibaba Cloud - DataWorks

Queries a list of versions of files to be deployed.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:*

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	integer	Yes	The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID.	12345
BusinessId	integer	No	The workflow ID. You can call the ListBusiness operation to query the workflow ID by name.	100001
SolutionId	integer	No	The solution ID.	8065
CommitFrom	string	No	The start date for committing. Specify the date in the yyyy-MM-dd format.	2025-01-01
CommitTo	string	No	The end date (included) for committing. Specify the date in the yyyy-MM-dd format.	2025-01-31
CommitUserId	string	No	The ID of the user who commits the file.	2003****
FileType	integer	No	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
ChangeType	integer	No	The change type. Valid values: 0: addition 1: update 2: deletion	0
FileIds	array	No	The IDs of the files to be queried.
	string	No	The ID of the file to be queried.	11223**
FileName	string	No	The name of the file.	Filename
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 100.	20

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	0000-ABCD-EFG****
PagingInfo	object	The pagination details.
TotalCount	integer	The total number of entries returned.	100
PageNumber	integer	The page number. Pages start from page 1.	1
PageSize	integer	The number of entries per page. Default value: 10.	10
DeploymentPackageFiles	array<object>	The list of files pending deployment.
	object	The details of the version of the file to be deployed.
Id	integer	The unique ID.	650433503
FileId	integer	The file ID.	520246913
FileVersion	integer	The file version.	34
CommitTime	string	The time for committing.	2025-04-10 15:55:47
CommitUser	string	The ID of the Alibaba Cloud account used by the user who committed the file.	446***
CommitUserName	string	The name of the Alibaba Cloud account used by the user who committed the file.	user***
ProjectId	integer	The workspace ID.	27595
TenantId	integer	The DataWorks tenant ID.	639415964191360
FileType	integer	The file type. The code for files varies based on the file type. For more information, see DataWorks nodes.	13
FileName	string	The name of the file of the current version.	bak_part_basc_person_relation_all_da
Status	integer	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
ChangeType	integer	The change type, which is an integer. Valid values: 0: addition 1: update 2: deletion	0
IsSameAsProductionVersion	boolean	Indicates whether the version is a version in the production environment of the scheduling system.	true
NodeId	integer	The ID of the auto triggered node that corresponds to the file.	700005008419
Comment	string	The comment for committing.	Test commit
NodeConfiguration	string	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": [] }
UseType	string	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
SmokeTestStatus	string	The test status in the development environment.	Not tested

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.