调用ListFileVersions查询文件的版本列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ListFileVersions

要执行的操作。

FileId Long 100000001

文件的ID,您可以通过ListFiles查询对应文件的ID。

ProjectId Long 10000

Dataworks工作空间的ID,您可以单击页面右上角的小扳手图标,进入工作空间管理页面查看。

RegionId String cn-zhangjiakou

服务所在地域的列表。

ProjectIdentifier String dw_project

Dataworks工作空间的唯一标识符,即数据开发页面顶部切换工作空间处的英文标识。

该参数与ProjectId参数二者必须设置其一,以确定本次API调用操作的Dataworks工作空间。

PageNumber Integer 1

请求的数据页数,用于翻页。

PageSize Integer 10

每页显示的条数,默认为10条,最大100条。

返回数据

名称 类型 示例值 描述
Data Struct

文件的版本列表。

FileVersions Array of FileVersion

文件的版本详情。

ChangeType String UPDATE

本次文件版本的变更类型,包括CREATE、UPDATE和DELETE。

Comment String 第二次版本提交

本次文件版本的说明。

CommitTime Long 1593881265000

生成文件版本的毫秒时间戳。

CommitUser String 73842342****

生成本次文件版本的阿里云用户UID。

FileContent String SHOW TABLES;

生成本次文件版本的文件代码。

FileName String ods_user_info_d

生成本次文件版本的文件名。

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

生成本次文件版本的文本基本信息。

FileVersion Integer 2

文件的版本。

IsCurrentProd Boolean false

本次文件版本是否为当前生产环境的最新版本。

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

生成本次文件版本的调度配置。

NodeId Long 1234

生成文件版本时对应的调度任务ID。

Status String COMMITTED

文件版本当前的状态,包括COMMITTING(提交中)、COMMITTED或CHECK_OK(已提交)、PACKAGED(准备发布)、DEPLOYING(发布中)、DEPLOYED(已发布)和CANCELLED(取消发布)。

UseType String NORMAL

文件所属的功能模块,包括NORMAL(数据开发)、MANUAL(手动任务)、MANUAL_BIZ(手动工作流)、SKIP(数据开发的空跑调度)、ADHOCQUERY(临时查询)和COMPONENT(组件管理)。

PageNumber Integer 1

当前数据页的页码。

PageSize Integer 10

当前数据页的大小。

TotalCount Integer 13

满足查询条件的数据总条数。

ErrorCode String Invalid.Tenant.ConnectionNotExists

错误码。

ErrorMessage String The connection does not exist.

错误信息。

HttpStatusCode Integer 200

HTTP状态码。

RequestId String 0000-ABCD-EFG****

Dataworks工作空间的ID,您可以单击页面右上角的小扳手图标,进入工作空间管理页面查看。

Success Boolean true

调用是否成功。

示例

请求示例

http(s)://[Endpoint]/?Action=ListFileVersions
&FileId=100000001
&ProjectId=10000
&RegionId=cn-zhangjiakou
&<公共请求参数>

正常返回示例

XML 格式

<RequestId>0000-ABCD-EFG****Q</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Data>
    <TotalCount>13</TotalCount>
    <FileVersions>
        <Status>COMMITTED</Status>
        <CommitUser>73842342****</CommitUser>
        <Comment>第二次版本提交</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 格式

{
    "RequestId": "0000-ABCD-EFG****Q",
    "HttpStatusCode": 200,
    "Data": {
        "TotalCount": 13,
        "FileVersions": {
            "Status": "COMMITTED",
            "CommitUser": "73842342****",
            "Comment": "第二次版本提交",
            "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
}

错误码

HttpCode 错误码 错误信息 描述
403 Forbidden.Access Access is forbidden. Activate DataWorks first. 您被限制访问,请开通DataWorks企业版或旗舰版。
500 InternalError.System An internal system error occurred. Try again later. 系统内部错误,请稍后再试。
500 InternalError.UserId.Missing An internal system error occurred. Try again later. 系统内部错误,请稍后再试。
403 ResourceNotAuthorized.Api You are not authorized to access the resources. 您无法访问未取得授权的资源。
429 Throttling.Api The request for this resource has exceeded your available limit. 对该资源的请求已超过您的可用上限。
429 Throttling.System The DataWorks system is busy. Try again later. DataWorks系统繁忙,请稍后再试。
429 Throttling.User Your request is too frequent. Try again later. 您的请求过于频繁,请尝试放缓请求速度。

访问错误中心查看更多错误码。