全部产品
Search

搜索本产品

    大数据开发治理平台 DataWorks：GetFileVersion - 获取文件的版本详情

    文档中心

    大数据开发治理平台 DataWorks：GetFileVersion - 获取文件的版本详情

    更新时间：Nov 15, 2024

    调用GetFileVersion获取文件的版本详情。

    调试

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

    授权信息

    当前API暂无授权信息透出。

    请求参数

    名称类型必填描述示例值
    FileIdlong是

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

    		1000001
    ProjectIdlong否

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

    		10000
    ProjectIdentifierstring否

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

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

    		dw_project
    FileVersioninteger是

    需要查询的文件版本。

    		2

    返回参数

    名称类型描述示例值
    object

    返回数据。

    HttpStatusCodeinteger

    HTTP 状态码。

    		200
    ErrorMessagestring

    错误信息。

    		The connection does not exist.
    RequestIdstring

    本次调用的唯一 ID。出现错误后，您可以根据该 ID 排查问题。

    		0000-ABCD-EFG****
    ErrorCodestring

    错误码。

    		Invalid.Tenant.ConnectionNotExists
    Successboolean

    调用是否成功。

    • true：成功。
    • false：失败。
    		true
    Dataobject

    文件的版本详情。

    FileContentstring

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

    		SHOW TABLES;
    IsCurrentProdboolean

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

    • true：是最新版本。
    • false：不是最新版本。
    		true
    Statusstring

    文件版本当前的状态，取值如下：

    • COMMITTING（提交中）
    • COMMITTED 或 CHECK_OK（已提交）
    • PACKAGED（准备发布）
    • DEPLOYING（发布中）
    • DEPLOYED（已发布）
    • CANCELLED（取消发布）
    		COMMITTED
    NodeContentstring

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

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

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

    		7384234****
    Commentstring

    本次文件版本的说明。

    		第二次版本提交
    FilePropertyContentstring

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

    		{"fileName":"ods_user_info_d","fileType":10}
    FileNamestring

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

    		ods_user_info_d
    UseTypestring

    文件所属的功能模块，取值如下：

    • 0：NORMAL（数据开发）
    • 1：MANUAL（手动任务）
    • 2：MANUAL_BIZ（手动工作流）
    • 3：SKIP（数据开发的空跑调度）
    • 10：ADHOCQUERY（临时查询）
    • 30：COMPONENT（组件管理）
    		0
    ChangeTypestring

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

    		UPDATE
    FileVersioninteger

    文件的版本。

    		2
    CommitTimelong

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

    		1593881265000
    NodeIdlong

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

    		3000001

    示例

    正常返回示例

    JSON格式

    {
  "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": "第二次版本提交",
    "FilePropertyContent": "{\"fileName\":\"ods_user_info_d\",\"fileType\":10}",
    "FileName": "ods_user_info_d",
    "UseType": "0",
    "ChangeType": "UPDATE",
    "FileVersion": 2,
    "CommitTime": 1593881265000,
    "NodeId": 3000001
  }
}

    错误码

    HTTP status code错误码错误信息描述
    403Forbidden.AccessAccess is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.没有权限，请授权
    429Throttling.ApiThe request for this resource has exceeded your available limit.对该资源的请求已超过您的可用上限。
    429Throttling.SystemThe DataWorks system is busy. Try again later.DataWorks系统繁忙，请稍后再试。
    429Throttling.UserYour request is too frequent. Try again later.您的请求过于频繁，请尝试放缓请求速度。
    500InternalError.SystemAn internal system error occurred. Try again later.系统内部错误，请稍后再试。
    500InternalError.UserId.MissingAn internal system error occurred. Try again later.系统内部错误，请稍后再试。

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

    变更历史

    变更时间变更内容概要操作
    暂无变更历史