获取异步进度
功能介绍
获取异步进度
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/progress/{operation_uri}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目的32位uuid,项目唯一标识,通过获取CodeArts项目ID接口查询项目列表获取。 取值范围: 字符串长度32。 |
operation_uri |
是 |
String |
参数解释: 进度id |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
参数解释: 错误码 取值范围: 大小写字母、数字。 长度限制0到20位 |
data |
ProgressVo object |
参数解释: 返回体 |
message |
String |
参数解释: 错误信息 取值范围: 大小写字母、数字、符号、中文。 长度限制0到1000位 |
参数 |
参数类型 |
描述 |
---|---|---|
uri |
String |
参数解释: 进度uri |
name |
String |
参数解释: 异步进度名称 |
total |
Integer |
参数解释: 资源总数 |
completed |
Boolean |
参数解释: 异步操作是否完成 |
informations |
Array of strings |
参数解释: 提示信息列表 |
code |
String |
参数解释: 错误编码 |
reason |
String |
参数解释: 错误信息 |
submitted_time |
String |
参数解释: 提交时间 |
begin_time |
String |
参数解释: 开始时间 |
end_time |
String |
参数解释: 结束时间 |
last_modified_time |
Integer |
参数解释: 最后修改时间 |
finished_count |
Integer |
参数解释: 执行完成总数 |
async_operation_key |
String |
参数解释: 异步操作的key |
finished_percent |
Integer |
参数解释: 异步操作完成进度 |
请求示例
无
响应示例
状态码:200
OK
{ "code" : "success", "data" : { "uri" : "79d49383043f4f84818569b38b38dcf4", "name" : "BatchCopyMindmap", "total" : 1, "completed" : true, "informations" : [ ], "code" : null, "reason" : null, "submitted_time" : "2025-01-13 07:56:56", "begin_time" : "2025-01-13 07:56:56", "end_time" : "2025-01-13 07:56:56", "last_modified_time" : 1736751416756, "finished_count" : 1, "async_operation_key" : "user_BatchCopyMindmap", "finished_percent" : 100 }, "message" : null }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
错误码
请参见错误码。