GetFileVersion-阿里云帮助中心

Invoke GetFileVersion to obtain the version details of a file.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
FileId	integer	Yes	The ID of the file. You can obtain the ID of the desired file by calling ListFiles.	1000001
ProjectId	integer	No	The ID of the DataWorks workspace. You can click the wrench icon in the upper-right corner of the page to go to the Workspace Management page and view it.	1000011
ProjectIdentifier	string	No	The unique identifier of the DataWorks workspace, which is the English identifier displayed at the top of the Data Development page when you switch workspaces. You must specify either this parameter or the ProjectId parameter to identify the DataWorks workspace for this API call.	dw_project
FileVersion	integer	Yes	The version of the file to query.	2

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	HTTP status code.	200
ErrorMessage	string	The error message.	The connection does not exist.
RequestId	string	The unique ID of this request. If an error occurs, you can troubleshoot the issue using this ID.	0000-ABCD-EFG****
ErrorCode	string	The error code.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Indicates whether the API call succeeded. true: Succeeded. false: Failed.	true
Data	object	Version details of the file.
FileContent	string	The code of the file for this version.	SHOW TABLES;
IsCurrentProd	boolean	Indicates whether this file version is the latest version in the current production environment. true: It is the latest version. false: It is not the latest version.	true
Status	string	Current status of the file version. Valid values: COMMITTING (Submitting) COMMITTED or CHECK_OK (Submitted) PACKAGED (Preparing for publish) DEPLOYING (In Publish) DEPLOYED (Published) CANCELLED (Publish canceled)	COMMITTED
NodeContent	string	The scan configuration at the time this file version was generated.	{"cycleType":0,"cronExpress":"00 05 00 * * ?"}
CommitUser	string	User ID of the Alibaba Cloud user who generated this file version.	7384234****
Comment	string	Description of this file version.	Second version submission
FilePropertyContent	string	Basic information of the file used to generate this file version.	{"fileName":"ods_user_info_d","fileType":10}
FileName	string	File name used to generate this file version.	ods_user_info_d
UseType	string	Function module to which the file belongs. Valid values: 0: NORMAL (Data Development) 1: MANUAL (one-time task) 2: MANUAL_BIZ (manual pipeline) 3: SKIP (Dry-Run scheduling in Data Development) 10: ADHOCQUERY (Ad Hoc Query) 30: COMPONENT (widget Management)	0
ChangeType	string	The change type of this file version, including CREATE, UPDATE, and DELETE.	UPDATE
FileVersion	integer	The version of the file.	2
CommitTime	integer	UNIX timestamp (in milliseconds) when the file version was generated.	1593881265000
NodeId	integer	The ID of the scheduling task corresponding to the generation of this file version.	3000001

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.