查询一个或多个异步任务的结果
接口功能介绍
该接口通过一个或多个异步任务的jobID查询任务执行的结果。
接口约束
无
URI
POST /v4/ecs/job/query
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以调用regionID查看最新的天翼云资源池列表 | bb9fdb42056f11eda1610242ac110002 | |
jobIDs | 是 | String | 异步任务ID列表,以英文逗号分隔每个ID | a8e88ab8-888e-8888-8b88-c8f88a88e8bf,a8e88ab8-888e-8888-8b88-c8f88a88e8bk |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败),默认值:800 | 800 | |
errorCode | String | 业务细分码,为product.module.code三段式码 | ||
message | String | 失败时的错误描述,一般为英文描述 | ||
description | String | 失败时的错误描述,一般为中文描述 | ||
returnObj | Object | 返回参数 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
jobList | Array of Objects | 异步任务列表 | jobList |
表 jobList
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
jobID | String | 异步任务ID | a8e88ab8-888e-8888-8b88-c8f88a88e8bf | |
jobStatus | Integer | 任务执行状态,取值范围:0:执行中,1:执行成功,2:执行失败 | 1 |
请求示例
请求头header
无
请求体body
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"jobIDs": "bc2a015f-f57f-4df9-8938-8bc2e96e0aea,b4a23a2d-665d-4142-9530-5857bf88ea74"
}
响应示例
{
"returnObj": {
"jobList": [{
"jobStatus": 2,
"jobID": "bc2a015f-f57f-4df9-8938-8bc2e96e0aea"
}, {
"jobStatus": 1,
"jobID": "b4a23a2d-665d-4142-9530-5857bf88ea74"
}]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功。 |
错误码
errorCode | 描述 |
---|---|
Openapi.PatternCheck.NotValid | 请求参数无效 |
Ecs.QueryAsyncResult.Empty | 结果为空,请检查您的jobID是否正确 |
Openapi.Ecs.AccessFailed | 内部错误,请重试。如果多次尝试失败,请提交工单 |
Ecs.RegionInfo.Empty | 资源池信息为空 |