文档首页 > > API参考> API(推荐)> 查询Job状态> 查询任务的执行状态

查询任务的执行状态

分享
更新时间: 2019/11/21 GMT+08:00

功能介绍

查询一个异步请求任务(Job)的执行状态。

对于创建云服务器、删除云服务器、云服务器批量操作和网卡操作等异步API,命令下发后,会返回任务ID(Job_id),通过Job_id可以查询本次异步请求任务的执行状态。

如何获取job_id,请参考响应(任务类)

URI

GET /v1/{project_id}/jobs/{job_id}

参数说明请参见 表1
表1 参数说明

参数

是否必选

描述

project_id

项目ID。

获取方法请参见获取项目ID

job_id

异步请求的任务ID。

请求消息

响应消息

响应参数如 表2所示。
表2 响应参数

参数

参数类型

描述

status

String

Job的状态。

  • SUCCESS:成功。
  • RUNNING:运行中。
  • FAIL:失败。
  • INIT:正在初始化。

entities

字典数据结构

Job操作的对象。

根据不同Job类型,显示不同的内容,云服务器相关操作显示server_id,网卡相关操作显示nic_id。有子Job时为子job的详情。

详情请参见表3

job_id

String

异步请求的任务ID。

job_type

String

异步请求的任务类型。

begin_time

String

开始时间。

end_time

String

结束时间。

error_code

String

Job执行失败时的错误码。

Job执行成功后,该值为null。

fail_reason

String

Job执行失败时的错误原因。

Job执行成功后,该值为null。

message

String

查询Job的API请求出现错误时,返回的错误消息。

code

String

查询Job的API请求出现错误时,返回的错误码。

错误码和其对应的含义请参考通用请求返回值

表3 entities字段数据结构说明

参数

参数类型

描述

sub_jobs_total

Integer

子任务数量。

sub_jobs

列表数据结构

每个子任务的执行信息。

详情请参见表4

表4 sub_jobs字段数据结构说明

参数

参数类型

描述

status

String

Job的状态。

  • SUCCESS:成功。
  • RUNNING:运行中。
  • FAIL:失败。
  • INIT:正在初始化。

entities

字典数据结构

Job操作的对象。根据不同Job类型,显示不同的内容,云服务器相关操作显示server_id,网卡相关操作显示nic_id。详情请参见表5

job_id

String

子任务的ID。

job_type

String

子任务的类型。

begin_time

String

开始时间。

end_time

String

结束时间。

error_code

String

Job执行失败时的错误码。

Job执行成功后,该值为null。

fail_reason

String

Job执行失败时的错误原因。

Job执行成功后,该值为null。

表5 entities字段数据结构说明

参数

参数类型

描述

server_id

String

云服务器相关操作显示server_id。

nic_id

String

网卡相关操作显示nic_id。

errorcode_message

String

子任务执行失败的具体原因。

请求示例

GET https://{endpoint}/v1/{project_id}/jobs/{job_id}

响应示例

{
    "status": "SUCCESS",
    "entities": {
        "sub_jobs_total": 1,
        "sub_jobs": [
            {
                "status": "SUCCESS",
                "entities": {
                    "server_id": "bae51750-0089-41a1-9b18-5c777978ff6d"
                },
                "job_id": "2c9eb2c5544cbf6101544f0635672b60",
                "job_type": "createSingleServer",
                "begin_time": "2016-04-25T20:04:47.591Z",
                "end_time": "2016-04-25T20:08:21.328Z",
                "error_code": null,
                "fail_reason": null
            }
        ]
    },
    "job_id": "2c9eb2c5544cbf6101544f0602af2b4f",
    "job_type": "createServer",
    "begin_time": "2016-04-25T20:04:34.604Z",
    "end_time": "2016-04-25T20:08:41.593Z",
    "error_code": null,
    "fail_reason": null
}

返回值

请参考通用请求返回值

错误码

请参考错误码说明

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区