Queries the version information of an object.

Debugging

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 Required GetFileVersion

The operation that you want to perform.

FileId Long Yes 1000001

The ID of the object. You can call ListFiles to query the object ID.

FileVersion Integer Yes 2

The version of the file that you want to query.

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 Required 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.

Response parameters

Parameter Type Example Description
Data Struct

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 7384234****

The Alibaba Cloud User ID 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 the basic information for this file version.

FileVersion Integer 2

The version of the file.

IsCurrentProd Boolean true

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

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

The scheduling configuration when a file version is generated.

NodeId Long 3000001

The ID of the scheduling task corresponding to the generation of 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.

ErrorCode String 0

The error code.

ErrorMessage String Success

The returned message.

HttpStatusCode Integer 200

The HTTP status code.

RequestId String 0000-ABCD-EFG****

The unique ID of the call. You can use the error ID to troubleshoot the error.

Success Boolean true

Indicates whether the call is successful.

Examples

Sample requests

http(s)://[Endpoint]/? Action=GetFileVersion
&FileId=1000001
&FileVersion=2
&ProjectId=10000
&RegionId=cn-zhangjiakou
&<Common request parameters>

Sample success responses

XML format

<RequestId>0000-ABCD-EFG****</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Data>
    <Status>COMMITTED</Status>
    <Comment> second version submission </Comment>
    <CommitUser>7384234****</CommitUser>
    <FilePropertyContent>{"fileName":"ods_user_info_d","fileType":10}</FilePropertyContent>
    <FileName>ods_user_info_d</FileName>
    <CommitTime>1593881265000</CommitTime>
    <UseType>NORMAL</UseType>
    <IsCurrentProd>true</IsCurrentProd>
    <FileContent>SHOW TABLES;</FileContent>
    <ChangeType>UPDATE</ChangeType>
    <FileVersion>2</FileVersion>
    <NodeId>3000001</NodeId>
    <NodeContent>{"cycleType":0,"cronExpress":"00 05 00 * * ?"} </NodeContent>
</Data>
<ErrorCode>0</ErrorCode>
<ErrorMessage>Success</ErrorMessage>
<Success>true</Success>

JSON format

{
    "RequestId": "0000-ABCD-EFG****",
    "HttpStatusCode": 200,
    "Data": {
        "Status": "COMMITTED",
        "Comment": "Second version submission",
        "CommitUser": "7384234****",
        "FilePropertyContent": "{\"fileName\":\"ods_user_info_d\",\"fileType\":10}",
        "FileName": "ods_user_info_d",
        "CommitTime": 1593881265000,
        "UseType": "NORMAL",
        "IsCurrentProd": true,
        "FileContent": "SHOW TABLES;",
        "ChangeType": "UPDATE",
        "FileVersion": 2,
        "NodeId": 3000001,
        "NodeContent": "{\"cycleType\":0,\"cronExpress\":\"00 05 00 * * ? \"}"
    },
    "ErrorCode": 0,
    "ErrorMessage": "Success",
    "Success": true
}

Error code

HttpCode Error code Error message Description
403 Forbidden.Access Access is forbidden. Activate DataWorks first. Your access is restricted, possibly because you have not activated DataWorks.
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.

For a list of error codes, visit the API Error Center.