Queries file versions.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListFileVersions

The operation that you want to perform.

FileId Long Yes 100000001

The file ID. You can retrieve the file ID by ListFiles You can call this operation to query the ID of a file.

ProjectId Long Yes 10000

Dataworks workspace ID and click the workspace manage icon in the upper-right corner to view the workspace information.

RegionId String Yes cn-zhangjiakou

The list of regions where the services are located.

ProjectIdentifier String No dw_project

Dataworks unique identifier of the workspace, that is, the name of the workspace at the top of the data Development page.

You must specify either this parameter or the ProjectId parameter to determine the Dataworks workspace for the current API call.

PageNumber Integer No 1

The number of data pages that are requested.

PageSize Integer No 10

The number of entries to return on each page. Default value: 10. Maximum value: 100.

Response parameters

Parameter Type Example Description
Data Struct

The version list of the file.

FileVersions Array of FileVersion

The detailed version information.

ChangeType String UPDATE

The type of an UPDATE for an object of the current version. Valid values: CREATE, UPDATE, and DELETE.

Comment String Second version submission

Description of this document version.

CommitTime Long 1593881265000

The millisecond timestamp when the file version was generated.

CommitUser String 73842342****

The Alibaba Cloud UID used to generate this file version.

FileContent String SHOW TABLES;

Generate the code for this file version.

FileName String ods_user_info_d

Generate the file name of this file version.

FilePropertyContent String {"fileName":"ods_user_info_d","fileType":10}

Generate basic information about the file version.

FileVersion Integer 2

The version of the file.

IsCurrentProd Boolean false

Indicates whether the document is the latest version in the production environment.

NodeContent String {"cycleType":0,"cronExpress":"00 05 00 * * ?"}

Generate the scheduling configuration for this file version.

NodeId Long 1234

The ID of the scheduling task that generated the file version.

Status String COMMITTED

The current status of the file version, including COMMITTED, COMMITTED or CHECK_OK, PACKAGED, DEPLOYING, DEPLOYED, and CANCELLED.

UseType String NORMAL

The functional module to which the file belongs, including NORMAL, MANUAL, MANUAL_BIZ, SKIP, adocquery, and COMPONENT.

PageNumber Integer 1

The number of the page to return.

PageSize Integer 10

The size of the current data page.

TotalCount Integer 13

The total number of data records that meet the query conditions.

ErrorCode String Invalid.Tenant.ConnectionNotExists

The error code.

ErrorMessage String The connection does not exist.

The error message.

HttpStatusCode Integer 200

The HTTP status code.

RequestId String 0000-ABCD-EFG****

Dataworks workspace ID and click the workspace manage icon in the upper-right corner to view the workspace information.

Success Boolean true

Indicates whether the request was successful.


Sample requests

     http(s)://[Endpoint]/? Action=ListFileVersions &FileId=100000001 &ProjectId=10000 &RegionId=cn-zhangjiakou &<common request parameters> 

Sample success responses

XML format

     <RequestId> 0000-abcd-efg****q </RequestId> <HttpStatusCode> 200 </HttpStatusCode> <Data> <TotalCount> 13 </TotalCount> <FileVersions> <Status> COMMITTED </Status> <CommitUser> 73842342**** </CommitUser> <Comment> second version submitted </Comment> <CommitTime> 1593881265000 </CommitTime> <FileName> ods_user_info_d </FileName> <FilePropertyContent> {"fileName":"ods_user_info_d","fileType":10} </FilePropertyContent> <UseType> NORMAL </UseType> <IsCurrentProd> false </IsCurrentProd> <FileContent> SHOW TABLES; </FileContent> <ChangeType> UPDATE </ChangeType> <FileVersion> 2 </FileVersion> <NodeId> 3000001 </NodeId> <NodeContent> {"cycleType":0,"cronExpress":"00 05 00 * *? "} </NodeContent> </FileVersions> <PageSize>10</PageSize> <PageNumber>1</PageNumber> </Data> <Success>true</Success> 

JSON Format

     {"RequestId": "0000-ABCD-EFG****Q", "HttpStatusCode": 200, "Data": { "TotalCount": 13, "FileVersions": { "Status": "COMMITTED", "CommitUser": "73842342 totalinstances *", "Comment": "The second version commit", "CommitTime": 1593881265000, "FileName": "ods_user_info_d", "FilePropertyContent": "{\" fileName\":\" ods_user_info_d\",\" fileType\":10}", "UseType": "NORMAL", "IsCurrentProd": false, "FileContent": "SHOW TABLES;", "ChangeType": "UPDATE", "FileVersion": 2, "NodeId": 3000001, "NodeContent": "{\"cycleType\":0,\"cronExpress\":\"00 05 00 * *? \"}" }, "PageSize": 10, "PageNumber": 1 }, "Success": true } 

Error codes

HttpCode Error codes Error message Description
403 Forbidden.Access Access is forbidden. Activate DataWorks first. You have restricted access. Please activate DataWorks Enterprise Edition or above.
500 InternalError.System An internal system error occurred. Try again later. An internal system error occurred. Please try again later.
500 InternalError.UserId.Missing An internal system error occurred. Try again later. An internal system error occurred. Please try again later.
403 ResourceNotAuthorized.Api You are not authorized to access the resources. You cannot access resources without authorization.
429 Throttling.Api The request for this resource has exceeded your available limit. The request for the resource exceeds your available upper limit.
429 Throttling.System The DataWorks system is busy. Try again later. DataWorks the system is busy, please try again later.
429 Throttling.User Your request is too frequent. Try again later. Your request is too frequent, please try to slow down the request speed.

Go to the Error CenterFor more information, see error codes.