查询一个异步任务的结果
接口功能介绍
该接口通过一个异步任务的jobID查询任务执行的结果。
接口约束
无
URI
GET /v4/ecs/query-async-result
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以调用regionID查看最新的天翼云资源池列表 | bb9fdb42056f11eda1610242ac110002 | |
jobID | 是 | String | 异步任务ID | a8e88ab8-888e-8888-8b88-c8f88a88e8bf |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
errorCode | String | 业务细分码,为product.module.code三段式码,详见错误码说明 | Openapi.PatternCheck.NotValid | |
message | String | 失败时的错误描述,一般为英文描述 | SUCCESS | |
description | String | 失败时的错误描述,一般为中文描述 | 成功 | |
returnObj | Object | 成功时返回的数据 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
jobStatus | Integer | 任务执行状态,取值范围:0:执行中,1:执行成功,2:执行失败 | 1 |
请求示例
GET '.../openapi/v4/ecs/query-async-result?regionID=bb9fdb42056f11eda1610242ac110002&jobID=a8e88ab8-888e-8888-8b88-c8f88a88e8bf'
请求头header
无
请求体body
无
响应示例
{
"returnObj": {
"jobstatus": 1
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功。 |
错误码
errorCode | 描述 |
---|---|
Openapi.PatternCheck.NotValid | 请求参数无效 |
Ecs.RegionInfo.Empty | 查询资源池信息为空或资源池不存在,请确认资源池ID是否有效 |
Ecs.RegionInfo.AccessFailed | 查询资源池失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.RegionInfo.DataDamaged | 查询资源池信息不符预期,请重试。如果多次尝试失败,请提交工单 |
Ecs.Task.AsyncResultEmpty | 未查询到对应任务,请检查您的jobID是否正确 |
Openapi.EcsWorkorder.AccessFailed | 查询异步结果错误,请重试。如果多次尝试失败,请提交工单 |