文档首页 > > API参考> API> Job管理> 查询Job状态

查询Job状态

分享
更新时间: 2019/12/05 GMT+08:00

功能介绍

查询Job的执行状态。

对于创建裸金属服务器、挂卸卷等异步API,命令下发后,会返回“job_id”,通过“job_id”可以查询任务的执行状态。

URI

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

参数说明请参见表1

表1 参数说明

参数

是否必选

描述

project_id

项目ID。

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

job_id

Job ID。

请求消息

  • 请求参数

  • 请求样例
    1
    GET https://{BMS Endpoint}/v1/bbf1946d374b44a0a2a95533562ba954/jobs/2c9eb2c5544cbf6101544f0635672b60
    

响应消息

  • 响应参数

    参数

    参数类型

    描述

    status

    String

    Job的状态。

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

    entities

    Array of objects

    Job操作的对象。请参见表2

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

    job_id

    String

    Job ID。

    job_type

    String

    Job的类型,包含以下类型:

    • baremetalBatchCreate:批量创建裸金属服务器
    • baremetalBatchOperate:批量修改裸金属服务器电源状态
    • baremetalVolumeBootReinstallOs:重装快速发放裸金属服务器操作系统
    • baremetalReinstallOs:重装本地盘裸金属服务器操作系统
    • baremetalAttachVolume:挂载单个磁盘
    • baremetalDetachVolume:卸载单个磁盘

    begin_time

    String

    开始时间。

    时间戳格式为ISO 8601,例如:2019-04-25T20:04:47.591Z

    end_time

    String

    结束时间。

    时间戳格式为ISO 8601,例如:2019-04-26T20:04:47.591Z

    error_code

    String

    Job执行失败时的错误码。

    fail_reason

    String

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

    message

    String

    出现错误时,返回的错误消息。

    code

    String

    出现错误时,返回的错误码。

    错误码和其对应的含义请参考状态码

    表2 entities字段数据结构说明

    参数

    参数类型

    描述

    sub_jobs_total

    Integer

    子任务数量。没有子任务时为0。

    sub_jobs

    Array of objects

    每个子任务的执行信息。没有子任务时为空列表。请参见表3

    表3 sub_jobs字段数据结构说明

    参数

    参数类型

    描述

    status

    String

    Job的状态。

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

    entities

    Array of objects

    Job操作的对象。根据不同Job类型,显示不同的内容。裸金属服务器相关操作显示server_id;网卡相关操作显示nic_id。

    请参见表4

    job_id

    String

    Job ID。

    job_type

    String

    Job的类型,包含以下类型:

    • baremetalSingleCreate:创建单个裸金属服务器
    • baremetalSingleOperate:修改单个裸金属服务器电源状态

    begin_time

    String

    开始时间。

    时间戳格式为ISO 8601,例如:2019-04-25T20:04:47.591Z

    end_time

    String

    结束时间。

    时间戳格式为ISO 8601,例如:2019-04-26T20:04:47.591Z

    error_code

    String

    Job执行失败时的错误码。

    fail_reason

    String

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

    message

    String

    出现错误时,返回的错误消息。

    code

    String

    出现错误时,返回的错误码。

    错误码和其对应的含义请参考状态码

    表4 entities字段数据结构说明

    参数

    参数类型

    描述

    server_id

    String

    裸金属服务器相关操作显示server_id。

    nic_id

    String

    网卡相关操作显示nic_id。

  • 响应样例
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    {
        "status": "SUCCESS",
        "entities": {
            "sub_jobs_total": 1,
            "sub_jobs": [
                {
                    "status": "SUCCESS",
                    "entities": {
                        "server_id": "bae51750-0089-41a1-9b18-5c777978ff6d"
                    },
                    "job_id": "2c9eb2c5544cbf6101544f0635672b60",
                    "job_type": "baremetalSingleCreate",
                    "begin_time": "2019-04-25T20:04:47.591Z",
                    "end_time": "2019-04-25T20:08:21.328Z",
                    "error_code": null,
                    "fail_reason": null
                }
            ]
        },
        "job_id": "2c9eb2c5544cbf6101544f0602af2b4f",
        "job_type": "baremetalBatchCreate",
        "begin_time": "2019-04-25T20:04:34.604Z",
        "end_time": "2019-04-25T20:08:41.593Z",
        "error_code": null,
        "fail_reason": null
    }
    

返回值

正常返回值:

返回值

说明

200

服务器已成功处理了请求。

其他返回值请参考状态码

错误码

请参考错误码

分享:

    相关文档

    相关产品

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

提交成功!

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

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

*必选

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

字符长度不能超过200

提交反馈 取消

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

跳转到云社区