调用GetFileVersion接口,获取文件的版本详情。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | GetFileVersion | 系统规定参数。取值为GetFileVersion。 |
FileId | Long | 是 | 1000001 | 文件的ID,您可以通过ListFiles查询对应文件的ID。 |
ProjectId | Long | 否 | 10000 | DataWorks工作空间的ID,您可以单击页面右上角的小扳手图标,进入工作空间管理页面查看。 |
ProjectIdentifier | String | 否 | dw_project | DataWorks工作空间的唯一标识符,即数据开发页面顶部切换工作空间处的英文标识。 该参数与ProjectId参数二者必须设置其一,以确定本次API调用操作的DataWorks工作空间。 |
FileVersion | Integer | 是 | 2 | 需要查询的文件版本。 |
返回数据
名称 |
类型 |
示例值 |
描述 |
HttpStatusCode | Integer | 200 | HTTP状态码。 |
ErrorMessage | String | The connection does not exist. | 错误信息。 |
RequestId | String | 0000-ABCD-EFG**** | 本次调用的唯一ID。出现错误后,您可以根据该ID排查问题。 |
ErrorCode | String | Invalid.Tenant.ConnectionNotExists | 错误码。 |
Success | Boolean | true | 调用是否成功。
|
Data | Object | 文件的版本详情。 |
|
FileContent | String | SHOW TABLES; | 生成本次文件版本的文件代码。 |
IsCurrentProd | Boolean | true | 本次文件版本是否为当前生产环境的最新版本。
|
Status | String | COMMITTED | 文件版本当前的状态,取值如下:
|
NodeContent | String | {"cycleType":0,"cronExpress":"00 05 00 * * ?"} | 本次文件版本生成时的调度配置。 |
CommitUser | String | 7384234**** | 生成本次文件版本的阿里云用户ID。 |
Comment | String | 第二次版本提交 | 本次文件版本的说明。 |
FilePropertyContent | String | {"fileName":"ods_user_info_d","fileType":10} | 生成本次文件版本的文件基本信息。 |
FileName | String | ods_user_info_d | 生成本次文件版本的文件名。 |
UseType | String | 0 | 文件所属的功能模块,取值如下:
|
ChangeType | String | UPDATE | 本次文件版本的变更类型,包括CREATE、UPDATE和DELETE。 |
FileVersion | Integer | 2 | 文件的版本。 |
CommitTime | Long | 1593881265000 | 文件版本生成的毫秒时间戳。 |
NodeId | Long | 3000001 | 文件版本生成时对应的调度任务ID。 |
示例
请求示例
http(s)://[Endpoint]/?Action=GetFileVersion
&FileId=1000001
&ProjectId=10000
&ProjectIdentifier=dw_project
&FileVersion=2
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<GetFileVersionResponse>
<HttpStatusCode>200</HttpStatusCode>
<ErrorMessage>The connection does not exist.</ErrorMessage>
<RequestId>0000-ABCD-EFG****</RequestId>
<ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
<Success>true</Success>
<Data>
<FileContent>SHOW TABLES;</FileContent>
<IsCurrentProd>true</IsCurrentProd>
<Status>COMMITTED</Status>
<NodeContent>{"cycleType":0,"cronExpress":"00 05 00 * * ?"}</NodeContent>
<CommitUser>7384234****</CommitUser>
<Comment>第二次版本提交</Comment>
<FilePropertyContent>{"fileName":"ods_user_info_d","fileType":10}</FilePropertyContent>
<FileName>ods_user_info_d</FileName>
<UseType>0</UseType>
<ChangeType>UPDATE</ChangeType>
<FileVersion>2</FileVersion>
<CommitTime>1593881265000</CommitTime>
<NodeId>3000001</NodeId>
</Data>
</GetFileVersionResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/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
}
}
错误码
HttpCode |
错误码 |
错误信息 |
描述 |
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. | 您的请求过于频繁,请尝试放缓请求速度。 |
500 | InternalError.System | An internal system error occurred. Try again later. | 系统内部错误,请稍后再试。 |
500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | 系统内部错误,请稍后再试。 |
访问错误中心查看更多错误码。
反馈
- 本页导读 (1)
文档反馈