查询轻量化任务状态
功能介绍
查询轻量化任务状态
图纸上传完成后,即可调用该接口获取图纸轻量化转换状态,该接口可能需要调用多次,直到返回的数据轻量化状态为SUCCESS或FAILED,即代表轻量化转换结束。
- 如果轻量化状态为SUCCESS,则代表图纸轻量化转换成功,此时可通过lightweight_file_path字段获取的路径进行轻量化文件下载。
- 如果轻量化状态为FAILED,则代表图纸轻量化转换失败,此时可以根据返回的失败原因进行排查处理。
- 如果获取的轻量化状态为其他值,说明该图纸处于上传获取转换等阶段,此时继续轮询该接口即可。
URI
POST /basic/coremgr/public/api/v1/drawing/lightweight-status
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
Authorization |
是 |
String |
机机认证token,获取token请参考链接:https://support.huaweicloud.com/devg-craftartsipdcenter/ipdcenter_08_0015.html |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
task_id |
是 |
String |
任务id 最小长度:32 最大长度:36 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
文件id 最小长度:36 最大长度:40 |
name |
String |
文件名称 最小长度:2 最大长度:512 |
status |
String |
上传状态: 上传中UPLOADING/上传完成SUCCESS/上传失败FAILED 枚举值:
|
is_chunked |
Boolean |
是否分片:true,false |
chunk_total |
Integer |
分片总数 最小值:0 最大值:1000 |
source |
String |
来源 最小长度:1 最大长度:255 |
type |
String |
文件类型:PART,ASSEMBLY 枚举值:
|
create_time |
String |
创建时间 最小长度:1 最大长度:30 |
update_time |
String |
更新时间 最小长度:0 最大长度:30 |
file_lightweight_task_result |
文件轻量化转换任务Vo对象 |
|
file_chunk_upload_result |
Array of FileChunkUploadRspVo objects |
文件分片上传响应Vo对象 数组长度:0 - 1000 |
参数 |
参数类型 |
描述 |
---|---|---|
file_id |
String |
文件id 最小长度:36 最大长度:40 |
file_name |
String |
文件名称 最小长度:2 最大长度:255 |
status |
String |
轻量化状态:UPLOADING,UNMOUNTED,MOUNTING,SUCCESS,FAILED 枚举值:
|
failed_reason |
String |
失败原因 最小长度:0 最大长度:500 |
task_id |
String |
轻量化任务id 最小长度:1 最大长度:40 |
create_time |
String |
创建时间 最小长度:1 最大长度:30 |
update_time |
String |
更新时间 最小长度:0 最大长度:30 |
lightweight_file_path |
String |
轻量化文件路径 最小长度:0 最大长度:500 |
参数 |
参数类型 |
描述 |
---|---|---|
chunk_id |
String |
文件分片id 最小长度:36 最大长度:40 |
chunk_status |
String |
上传状态: 上传中UPLOADING/上传完成SUCCESS/上传失败FAILED 枚举值:
|
chunk_index |
Integer |
分片索引 最小值:0 最大值:1000 |
create_time |
String |
创建时间 最小长度:1 最大长度:30 |
update_time |
String |
更新时间 最小长度:0 最大长度:30 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 最小长度:8 最大长度:36 |
error_msg |
String |
错误描述 最小长度:2 最大长度:512 |
请求示例
查询轻量化任务状态
/basic/coremgr/public/api/v1/drawing/lightweight-status { "task_id" : "3bfe5727-ec30-4539-bbc0-4be54fbdaee2" }
响应示例
状态码: 200
轻量化状态响应Vo对象
{ "id" : "4f2bddfa-dee7-4858-b41c-34705e9642a3", "name" : "010758215.stp", "status" : "SUCCESS", "is_chunked" : true, "chunk_total" : 29, "source" : "temp", "type" : "PART", "create_time" : "2024-06-21 10:18:10", "update_time" : "2024-06-21 10:18:32", "file_lightweight_task_result" : { "file_id" : "4f2bddfa-dee7-4858-b41c-34705e9642a3", "file_name" : "010758215.stp", "status" : "MOUNTING", "task_id" : "3bfe5727-ec30-4539-bbc0-4be54fbdaee2", "create_time" : "2024-06-21 10:18:10", "update_time" : "2024-06-21 10:18:37" } }
状态码: 400
错误响应
示例一: { "error_code" : "01090001", "error_msg" : "系统错误,请联系管理员!" } 示例二: { "error_code" : "01099901", "error_msg" : "请求参数无效!" } 示例二: { "error_code" : "01099902", "error_msg" : "认证失败!" }
状态码
状态码 |
描述 |
---|---|
200 |
轻量化状态响应Vo对象 |
400 |
错误响应 |
错误码
请参见错误码。