接口功能介绍
该接口通过一个或多个异步任务的jobID查询任务执行的结果。
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
注意事项：
异步任务结果查询：请先通过异步接口得到对应的任务ID（jobID），注：异步任务查询不支持查询订单接口（即涉及付费的接口，如创建云主机）
多个任务查询：当前接口可以查询同一资源池内多个任务结果，查询单个任务结果，推荐使用接口查询一个异步任务的结果来查询
接口约束
确保当前请求资源池下，这些异步任务存在（即jobIDs内逗号分割的任务都真实存在）
URI
POST /v4/ecs/job/query
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 资源池列表查询 |
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三段式码 | Openapi.PatternCheck.NotValid | |
| error | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| 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 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例：查询多个异步任务的结果查询华东1查询重启两台台云主机的任务结果
{
"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
}
状态码
请参考 状态码
错误码
请参考 错误码
