ListFileVersions - DataWorks - Alibaba Cloud Documentation Center

Queries a list of file versions.

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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
FileId	long	Yes	The file ID. You can call ListFiles to query the file ID.	100000001
ProjectId	long	No	The DataWorks workspace ID. To find this, click the wrench icon in the upper-right corner and navigate to the workspace management page.	100001
ProjectIdentifier	string	No	The unique identifier of the DataWorks workspace, which is the identifier at the top of the Data Studio page where you switch workspaces. Either this parameter or ProjectId must be specified to identify the target DataWorks workspace for this API call.	dw_project
PageNumber	integer	No	The page number for pagination.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 100.	10

Response parameters

Parameter	Type	Description	Example
	object	The response.
HttpStatusCode	integer	The HTTP status code.	200
ErrorMessage	string	The error message.	The connection does not exist.
RequestId	string	The request ID.	0000-ABCD-EFG****
ErrorCode	string	The error code.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Indicates whether the call succeeded. Valid values: true false	true
Data	object	The list of file versions.
PageNumber	integer	The current page number.	1
PageSize	integer	The number of entries on the current page.	10
TotalCount	integer	The total number of entries returned.	13
FileVersions	array<object>	The list of file version details.
FileVersion	object	The file version details.
FileContent	string	The file code for this version.	SHOW TABLES;
Status	string	The current status of the file version. Valid values: COMMITTING (committing), COMMITTED or CHECK_OK (committed), PACKAGED (ready for deployment), DEPLOYING (deploying), DEPLOYED (deployed), and CANCELLED (deployment canceled).	COMMITTED
IsCurrentProd	boolean	Indicates whether this file version is the latest version in the production environment. true false	false
CommitUser	string	The Alibaba Cloud account ID of the user who created this file version.	73842342****
NodeContent	string	The scheduling configuration for this file version.	{"cycleType":0,"cronExpress":"00 05 00 * * ?"}
Comment	string	The description of this file version.	Second version submission
FilePropertyContent	string	The text information for this file version.	{"fileName":"ods_user_info_d","fileType":10}
FileName	string	The file name for this file version.	ods_user_info_d
UseType	string	The functional module to which the file belongs. Valid values: NORMAL (Data Studio), MANUAL (manual task), MANUAL_BIZ (manual workflow), SKIP (dry-run scheduling in Data Studio), ADHOCQUERY (ad hoc query), and COMPONENT (component management).	NORMAL
ChangeType	string	The change type for this file version. Valid values: CREATE, UPDATE, and DELETE.	UPDATE
FileVersion	integer	The file version.	2
CommitTime	long	The timestamp (in milliseconds) when the file version was created.	1593881265000
NodeId	long	The scheduling task ID associated with this file version.	1234

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 200,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "0000-ABCD-EFG****",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true,
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 13,
    "FileVersions": [
      {
        "FileContent": "SHOW TABLES;",
        "Status": "COMMITTED",
        "IsCurrentProd": false,
        "CommitUser": "73842342****\n",
        "NodeContent": {
          "cycleType": 0,
          "cronExpress": "00 05 00 * * ?"
        },
        "Comment": "Second version submission",
        "FilePropertyContent": {
          "fileName": "ods_user_info_d",
          "fileType": 10
        },
        "FileName": "ods_user_info_d",
        "UseType": "NORMAL",
        "ChangeType": "UPDATE",
        "FileVersion": 2,
        "CommitTime": 1593881265000,
        "NodeId": 1234
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	No permission, please authorize
429	Throttling.Api	The request for this resource has exceeded your available limit.	-
429	Throttling.System	The DataWorks system is busy. Try again later.	-
429	Throttling.User	Your request is too frequent. Try again later.	-
500	InternalError.System	An internal system error occurred. Try again later.	-
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	-

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