接口功能介绍
该接口通过一个异步任务的jobID查询任务执行的结果
准备工作:
构造请求:在调用前需要了解如何构造请求,详情查看构造请求
认证鉴权:openapi请求需要进行加密调用,详细查看认证鉴权
注意事项:
异步任务结果查询:请先通过异步接口得到对应的任务ID(jobID),注:异步任务查询不支持查询订单接口(即涉及付费的接口,如创建云主机)
单个任务查询:当前接口只能查询单个任务结果,查询同资源池下多个任务结果,请使用接口查询多个异步任务的结果来查询
接口约束
确保当前请求资源池下,该异步任务存在(即jobID真实存在)
URI
GET /v4/ecs/query-async-result
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以查看地域和可用区来了解资源池 获取: 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
jobID | 是 | String | 异步任务ID | a8e88ab8-888e-8888-8b88-c8f88a88e8bf |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
errorCode | String | 错误码,为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
error | String | 错误码,为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
message | String | 失败时的错误描述,一般为英文描述 | SUCCESS | |
description | String | 失败时的错误描述,一般为中文描述 | 成功 | |
returnObj | Object | 成功时返回的数据 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
jobStatus | Integer | 任务执行状态,取值范围: 0(执行中), 1(执行成功), 2(执行失败) |
1 |
枚举参数
无
请求示例
请求url
示例:查询异步任务的结果
查询华东1重启一台云主机的任务结果
GET '.../v4/ecs/query-async-result?regionID=bb9fdb42056f11eda1610242ac110002&jobID=a8e88ab8-888e-8888-8b88-c8f88a88e8bf'
请求头header
无
请求体body
无
响应示例
{
"returnObj": {
"jobstatus": 1
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码