GetFileVersion - DataWorks - Alibaba Cloud Documentation Center

Queries the information about a file version.

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 the ListFiles operation to query the ID.	1000001
ProjectId	long	No	The DataWorks workspace ID. You can click the Workspace Manage icon in the upper-right corner of the DataStudio page to go to the Workspace page and query the workspace ID.	1000011
ProjectIdentifier	string	No	The unique identifier of the DataWorks workspace. You can view the identifier in the upper part of the DataStudio page. You can also select another identifier to switch to another workspace. You must configure either this parameter or the ProjectId parameter to determine the DataWorks workspace to which the operation is applied.	dw_project
FileVersion	integer	Yes	The file version whose information you want to query.	2

Response parameters

Parameter	Type	Description	Example
	object
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 request was successful. Valid values: true false	true
Data	object	The details of the file version.
FileContent	string	The code in the file of the current version.	SHOW TABLES;
IsCurrentProd	boolean	Indicates whether the version is the latest version in the production environment. Valid values: true false	true
Status	string	The status of the file version. Valid values: COMMITTING COMMITTED or CHECK_OK PACKAGED DEPLOYING DEPLOYED CANCELLED	COMMITTED
NodeContent	string	The scheduling configurations of the node that corresponds to the file of the current version.	{"cycleType":0,"cronExpress":"00 05 00 * * ?"}
CommitUser	string	The ID of the Alibaba Cloud account that is used to generate the file of the current version.	7384234****
Comment	string	The description of the file version.	Second version submission
FilePropertyContent	string	The basic information about the file of the current version.	{"fileName":"ods_user_info_d","fileType":10}
FileName	string	The name of the file of the current version.	ods_user_info_d
UseType	string	The module to which the file belongs. Valid values: 0: NORMAL, which indicates that the file is used for DataStudio. 1: MANUAL, which indicates that the file is used for a manually triggered node. 2: MANUAL_BIZ, which indicates that the file is used for a manually triggered workflow. 3: SKIP, which indicates that the file is used for a dry-run node in DataStudio. 10: ADHOCQUERY, which indicates that the file is used for an ad hoc query. 30: COMPONENT, which indicates that the file is used for a script template.	0
ChangeType	string	The type of the change to the file of the current version. Valid values: CREATE, UPDATE, and DELETE.	UPDATE
FileVersion	integer	The file version.	2
CommitTime	long	The time when the file version was generated. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1593881265000
NodeId	long	The ID of the node that corresponds to the file version.	3000001

Examples

Sample success responses

JSONformat

{
  "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
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.