获取异步接口的进度 - ShowProgressById

功能介绍

获取异步接口的进度。若进度rate不为100，message存当前进度；若进度rate为100，message存返回结果内容。

调用方法

URI

GET /v1/progress/{id}

表1 路径参数
参数	是否必选	参数类型	描述
id	是	String	进度唯一标识

表2 Query参数
参数	是否必选	参数类型	描述
project_id	否	String	工程唯一标识

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释：用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。约束限制：必传。取值范围：字符串长度不少于1，不超过10万。默认取值：不涉及。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
error	CommonResponseErrorOfobject object	统一错误返回
reason	String	错误原因
result	Object	结果
status	String	'状态值，如success、error' success，请求成功 error，请求报错

表5 CommonResponseErrorOfobject
参数	参数类型	描述
code	String	错误码
reason	String	错误原因

状态码：401

表6 响应Body参数
参数	参数类型	描述
error_code	String	参数解释接口调用失败错误码取值范围 12-18个字符组成的字符串
error_msg	String	参数解释接口调用失败错误信息取值范围 3-1000个字符组成的字符串

状态码：403

表7 响应Body参数
参数	参数类型	描述
error_code	String	参数解释接口调用失败错误码取值范围 12-18个字符组成的字符串
error_msg	String	参数解释接口调用失败错误信息取值范围 3-1000个字符组成的字符串

状态码：404

表8 响应Body参数
参数	参数类型	描述
error_code	String	参数解释接口调用失败错误码取值范围 12-18个字符组成的字符串
error_msg	String	参数解释接口调用失败错误信息取值范围 3-1000个字符组成的字符串

状态码：500

表9 响应Body参数
参数	参数类型	描述
error_code	String	参数解释接口调用失败错误码取值范围 12-18个字符组成的字符串
error_msg	String	参数解释接口调用失败错误信息取值范围 3-1000个字符组成的字符串

请求示例

get https://{endpoint}/v1/progress/27a64f9ad7cc440785618723f6974612?project_id=5a20b8323f3548008bd6e5669567538f

响应示例

状态码：200

SUCCESS

{
  "status" : "error",
  "result" : null,
  "reason" : null,
  "error" : {
    "code" : "APITEST.00010011",
    "reason" : "无效的id信息",
    "detail" : null
  }
}