获取异步进度 - ShowProgressByOperationUri
功能介绍
此接口用于在调用异步接口(如/v5)后获取接口最终返回数据,需要与异步接口(如v5接口)搭配使用,根据项目id和异步任务uri,查询异步接口最终返回的数据
调用方法
请参见如何调用API。
URI
GET /v4/testhub/progress/{operation_uri}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
operation_uri |
是 |
String |
异步操作uri |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_uuid |
是 |
String |
项目id |
请求参数
无
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
uri |
String |
进度uri |
|
name |
String |
异步进度名称 |
|
total |
Integer |
资源总数 |
|
completed |
Boolean |
异步操作是否完成 |
|
cancelled |
Boolean |
异步操作是否取消 |
|
informations |
Array of strings |
提示信息列表 |
|
code |
String |
错误编码 |
|
reason |
String |
错误信息 |
|
submitted_time |
String |
提交时间 |
|
begin_time |
String |
开始时间 |
|
end_time |
String |
结束时间 |
|
server_ip |
String |
服务ip |
|
last_modified_time |
Long |
最后修改时间 |
|
finished_count |
Integer |
执行完成总数 |
|
return_value |
return_value object |
异步操作返回值 |
|
exception_message |
String |
异常信息 |
|
line_up_num |
Integer |
行编号 |
|
asyn_operation_key |
String |
异步操作的key |
|
is_ended |
Boolean |
异步操作的key |
|
finished_percent |
Integer |
异步操作完成进度 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
value |
Object |
异步接口返回的数据 |
|
page_no |
Integer |
分页编码,非必返 |
|
page_size |
Integer |
分页大小,非必返 |
|
total |
Integer |
总数,非必返 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释 接口调用失败错误码 取值范围 不涉及 |
|
error_msg |
String |
参数解释 接口调用失败错误信息 取值范围 不涉及 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释 接口调用失败错误码 取值范围 不涉及 |
|
error_msg |
String |
参数解释 接口调用失败错误信息 取值范围 不涉及 |
状态码：404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释 接口调用失败错误码 取值范围 不涉及 |
|
error_msg |
String |
参数解释 接口调用失败错误信息 取值范围 不涉及 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释 接口调用失败错误码 取值范围 不涉及 |
|
error_msg |
String |
参数解释 接口调用失败错误信息 取值范围 不涉及 |
请求示例
get https://{endpoint}/v4/testhub/progress/a5eb0d410ea341a192f7c12483568985v90700010id1e24c?project_uuid=3cb3c18b74f1429783175e6dab05b351
响应示例
状态码：200
OK
{
"uri" : "a5eb0d410ea341a192f7c12483568985v90700010id1e24c",
"name" : "getHomePageOverviewInfoV5",
"total" : 1,
"completed" : false,
"cancelled" : false,
"informations" : [ ],
"submitted_time" : "2025-06-19 14:11:37",
"begin_time" : "2025-06-19 14:11:37",
"last_modified_time" : 1750313497740,
"finished_count" : 0,
"line_up_num" : 0,
"asyn_operation_key" : "fe2b1b7779a447ee9b650ecc43a18c81null",
"is_ended" : false,
"finished_percent" : 0,
"code" : "错误信息",
"reason" : "错误原因",
"end_time" : "2020-11-29 16:33:40",
"server_ip" : "127.0.0.1",
"return_value" : "004t0evbbmc1",
"exception_message" : "import resource error"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server Error |
错误码
请参见错误码。
