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 ID of the file. 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 view the workspace ID.	10000
ProjectIdentifier	string	No	The unique identifier of the DataWorks workspace. You can click the identifier in the upper-left corner of the DataStudio page to switch to another workspace. You must specify either this parameter or ProjectId to determine the DataWorks workspace to which the operation is applied.	dw_project
FileVersion	integer	Yes	The file version whose details you want to query.	2

Response parameters

Parameter	Type	Description	Example
	object	The returned data.
HttpStatusCode	integer	The HTTP status code returned.	200
ErrorMessage	string	The error message returned.	The connection does not exist.
RequestId	string	The ID of the request. You can troubleshoot issues based on the ID.	0000-ABCD-EFG****
ErrorCode	string	The error code returned.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Indicates whether the request is successful.	true
Data	object	The details of the file version.
FileContent	string	The file code.	SHOW TABLES;
IsCurrentProd	boolean	Indicates whether the version is the latest version in the production environment.	true
Status	string	The status of the file version. Valid values: COMMITTING, COMMITTED, CHECK_OK, PACKAGED, DEPLOYING, DEPLOYED, and CANCELLED. The value CHECK_OK is equivalent to the value COMMITTED.	COMMITTED
NodeContent	string	The scheduling configurations of the node that corresponds to the file version.	{"cycleType":0,"cronExpress":"00 05 00 * * ?"}
CommitUser	string	The ID of the Alibaba Cloud account that is used to create the file version.	7384234****
Comment	string	The description of the file version.	Second version submission
FilePropertyContent	string	The basic information about the file.	{"fileName":"ods_user_info_d","fileType":10}
FileName	string	The file name.	ods_user_info_d
UseType	string	The functional module to which the file belongs. Valid values: NORMAL, MANUAL, MANUAL_BIZ, SKIP, ADHOCQUERY, and COMPONENT. The value NORMAL indicates DataStudio. The value MANUAL indicates a manually triggered node. The value MANUAL_BIZ indicates a manually triggered workflow. The value SKIP indicates a dry-run DataStudio node. The value ADHOCQUERY indicates an ad hoc query. The value COMPONENT indicates snippets.	NORMAL
ChangeType	string	The change type of the file version. Valid values: CREATE, UPDATE, and DELETE.	UPDATE
FileVersion	integer	The file version.	2
CommitTime	long	The time when the 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": "7384234****",
    "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": 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.

Change history

Change time	Summary of changes	Operation

No change history