接口功能介绍
查看异步任务job任务状态等
接口约束
无
URI
GET /v4/job/info
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| jobID | 是 | String | 异步任务ID | b703410a-2e4b-43a8-b8b1-88f3e219116b |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码('800为成功，900为失败) ，默认值:800 | 800 | |
| errorCode | String | 错误码，为product.module.code三段式码。为空表示成功。 | ||
| message | String | 失败时的错误描述，一般为英文描述 | ||
| description | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | Object | 返回参数 | returnObj | |
| error | String | 错误码，为product.module.code三段式码。请求成功时不返回该字段 | Openapi.Workorder.AccessFailed |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| jobID | String | 异步任务ID | ||
| status | Integer | 任务状态 (0:执行中 1:执行成功 2:执行失败) | 1 | |
| jobStatus | String | job任务状态(executing:执行中, success:执行成功, fail:执行失败) | ||
| fields | Object | 任务信息 |
表 fields
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| taskName | String | 任务名 |
枚举参数
无
请求示例
请求url
/v4/job/info?jobID=b703410a-2e4b-43a8-b8b1-88f3e219116b®ionID=81f7728662dd11ec810800155d307d5b
请求头header
无
请求体body
无
响应示例
成功响应示例：
{
"returnObj": {
"status": 2,
"resourceId": "'mock-vm-100",
"fields": {
"isMaz": "1",
"azId": null,
"azName": "az2",
"taskName": "ecs_task.tasks.instance_task.os_stop_server_task",
"projectIdEcs": null,
"logMark": "335893169617"
},
"jobStatus": "fail",
"jobID": "b703410a-2e4b-43a8-b8b1-88f3e219116b"
},
"errorCode": "",
"message": "",
"description": "",
"statusCode": 800
}
失败响应示例：
{
"errorCode": "Openapi.Workorder.AccessFailed",
"error": "Openapi.Workorder.AccessFailed",
"details": "",
"message": "access internal service failed: query job empty",
"description": "系统错误: 查询异步任务为空",
"statusCode": 900
}
状态码
请参考 状态码
错误码
请参考 错误码
