更新时间:2022-02-22 GMT+08:00

查询job的状态

功能介绍

查询job的状态,可用于查询创建备份,删除备份,从备份恢复磁盘等API的执行状态。

URI

  • URI格式

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

  • 参数说明

    参数

    是否必选

    描述

    project_id

    项目ID。

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

    job_id

    job ID。

请求

响应

  • 要素说明

    参数

    参数类型

    描述

    status

    string

    job的状态。

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

    entities

    map<string, string>

    job的响应信息。不同的类型的job,其中的内容不同。

    job_id

    string

    job ID。

    job_type

    string

    job的类型。

    begin_time

    string

    开始时间。

    end_time

    string

    结束时间。

    error_code

    string

    job执行失败时的错误码。

    fail_reason

    string

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

    message

    string

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

    code

    string

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

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

    sub_jobs

    list

    每个子job的执行信息。没有子job时为空列表。每个子job的结构与父job类似。

  • 响应样例
    {
        "status": "SUCCESS",
        "entities": {
            "bks_create_volume_name": "autobk_volume",
            "backup_id": "ba5401a2-7cd2-4c01-8c0d-c936ab412d6d",
            "volume_id": "7e5fdc5a-5e36-4b22-8bcc-7f17037290cc",
            "snapshot_id": "a77a96bf-dd18-40bf-a446-fdcefc1719ec"
        },
        "job_id": "4010b39b5281d3590152874bfa3b1604",
        "job_type": "bksCreateBackup",
        "begin_time": "2016-01-28T16:14:09.466Z",
        "end_time": "2016-01-28T16:25:27.690Z",
        "error_code": null,
        "fail_reason": null
    }

    {
    "error": {
    "message": "XXXX",
    "code": "XXX"
    }
    }

状态码

  • 正常

    200

  • 异常

    状态码

    说明

    400 Bad Request

    服务器未能处理请求。

    401 Unauthorized

    被请求的页面需要用户名和密码。

    403 Forbidden

    对被请求页面的访问被禁止。

    404 Not Found

    服务器无法找到被请求的页面。

    405 Method Not Allowed

    请求中指定的方法不被允许。

    406 Not Acceptable

    服务器生成的响应无法被客户端所接受。

    407 Proxy Authentication Required

    用户必须首先使用代理服务器进行验证,这样请求才会被处理。

    408 Request Timeout

    请求超出了服务器的等待时间。

    409 Conflict

    由于冲突,请求无法被完成。

    500 Internal Server Error

    请求未完成。服务异常。

    501 Not Implemented

    请求未完成。服务器不支持所请求的功能。

    502 Bad Gateway

    请求未完成。服务器从上游服务器收到一个无效的响应。

    503 Service Unavailable

    请求未完成。系统暂时异常。

    504 Gateway Timeout

    网关超时。

错误码

请参考错误码