九游平台/ 弹性云服务器 ecs/ api参考/ api/ 查询job状态/ 查询任务的执行状态
更新时间：2024-12-03 gmt 08:00
查看pdf

查询任务的执行状态-九游平台

功能介绍

查询一个异步请求任务（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：正在初始化。
  • pending_payment : 包年/包月订单待支付。
    说明：

    pending_payment状态为创建或者变更包年/包月的弹性云服务器提交订单完成后待支付状态。如果订单取消，该状态不会自动刷新，待14天后job会自动清理。

entities

object

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字段数据结构说明

参数

参数类型

描述

server_id

string

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

nic_id

string

网卡相关操作显示nic_id。

sub_jobs_total

integer

子任务数量。

sub_jobs

array of objects

每个子任务的执行信息。

详情请参见表4
表4 sub_jobs字段数据结构说明

参数

参数类型

描述

status

string

job的状态。

  • success：成功。
  • running：运行中。
  • fail：失败。
  • init：正在初始化。

entities

object

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 sub_jobs.entities字段数据结构说明

参数

参数类型

描述

server_id

string

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

nic_id

string

网卡相关操作显示nic_id。

errorcode_message

string

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

请求示例

查询一个异步请求任务（job）的执行状态。

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
}

返回值

请参考通用请求返回值。

错误码

请参考错误码。

父主题： 查询job状态

相关文档

网站地图