更新时间:2022-01-22 GMT+08:00
分享

查询job的状态

功能介绍

查询job的状态,可用于查询创建云硬盘,扩容云硬盘,删除云硬盘等API的执行状态。

调试

您可以在API Explorer中直接运行调试该接口。

URI

  • URI格式

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

  • 参数说明

    参数

    是否必选

    描述

    project_id

    项目ID。

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

    job_id

    job ID。

请求消息

以查询jod_id为ff808081692a62c70169b4dcf9514264的状态为例。

  • 请求样例:
     GET https://{endpoint}/v1/{project_id}/jobs/ff808081692a62c70169b4dcf9514264

响应消息

  • 响应参数

    参数

    参数类型

    描述

    status

    String

    job的状态。

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

    entities

    Object

    job的响应信息。具体请参见•entities参数说明

    不同的类型的job,其中的内容不同。

    job_id

    String

    job ID。

    job_type

    String

    job的类型。

    • createVolume:创建单个云硬盘。
    • batchCreateVolume:批量创建云硬盘。
    • deleteVolume:删除单个云硬盘。
    • extendVolume:扩容云硬盘。
    • bulkDeleteVolume:批量删除云硬盘。
    • deleteSingleVolume:批量删除时逐个删除单个云硬盘。

    begin_time

    String

    开始时间。

    时间格式为:YYYY-MM-DDTHH:MM:SS.SSS'Z'

    end_time

    String

    结束时间。

    时间格式为:YYYY-MM-DDTHH:MM:SS.SSS'Z'

    error_code

    String

    job执行失败时的错误码。

    fail_reason

    String

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

    error

    Object

    出现错误时,返回的错误信息,具体请参见•error参数说明

  • entities参数说明

    参数

    参数类型

    描述

    name

    String

    云硬盘的名称。

    size

    Integer

    云硬盘的容量,单位为GB。

    sub_jobs

    Array of Objects

    子job的信息。具体请参见•sub_jobs参数说明

    volume_id

    String

    云硬盘的ID。

    volume_type

    String

    云硬盘的类型。

  • sub_jobs参数说明

    参数

    参数类型

    描述

    status

    String

    job的状态。

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

    entities

    Object

    job的响应信息。具体请参见•entities参数说明

    不同的类型的job,其中的内容不同。

    job_id

    String

    job ID。

    job_type

    String

    job的类型。

    • createVolume:创建单个云硬盘。
    • batchCreateVolume:批量创建云硬盘。
    • deleteVolume:删除单个云硬盘。
    • extendVolume:扩容云硬盘。
    • bulkDeleteVolume:批量删除云硬盘。
    • deleteSingleVolume:批量删除时逐个删除单个云硬盘。

    begin_time

    String

    开始时间。

    时间格式为:YYYY-MM-DDTHH:MM:SS.SSS'Z'

    end_time

    String

    结束时间。

    时间格式为:YYYY-MM-DDTHH:MM:SS.SSS'Z'

    error_code

    String

    job执行失败时的错误码。

    fail_reason

    String

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

  • entities参数说明

    参数

    参数类型

    描述

    name

    String

    云硬盘的名称。

    size

    Integer

    云硬盘的容量,单位为GB。

    volume_id

    String

    云硬盘的ID。

    volume_type

    String

    云硬盘的类型。

  • error参数说明

    参数

    参数类型

    描述

    message

    String

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

    code

    String

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

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

  • 响应样例
    {
        "status": "RUNNING", 
        "entities": {
            "volume_id": "bdf1bb37-f20f-4266-9a04-f43e0a127376"
        }, 
        "job_id": "4010a32d535527910153552b492c0002", 
        "job_type": "createVolume", 
        "begin_time": "2016-03-08T07:40:13.219Z", 
        "end_time": "", 
        "error_code": null, 
        "fail_reason": null
    }

    {
        "status": "SUCCESS", 
        "entities": {
            "sub_jobs": [
                {
                    "status": "SUCCESS", 
                    "entities": {
                        "volume_id": "0b549095-4937-4849-8e4c-52aa027d64f7"
                    }, 
                    "job_id": "21917a8d52a19b040152a9f2f2e50041", 
                    "job_type": "createVolume", 
                    "begin_time": "2016-02-04T01:43:37.445Z", 
                    "end_time": "2016-02-04T01:44:02.239Z", 
                    "error_code": null, 
                    "fail_reason": null
                }, 
                {
                    "status": "SUCCESS", 
                    "entities": {
                        "volume_id": "e7bca1a2-d3ed-434f-86f4-a1f11aa80072"
                    }, 
                    "job_id": "21917a8d52a19b040152a9f2f2f60042", 
                    "job_type": "createVolume", 
                    "begin_time": "2016-02-04T01:43:37.462Z", 
                    "end_time": "2016-02-04T01:44:02.245Z", 
                    "error_code": null, 
                    "fail_reason": null
                }
            ]
        }, 
        "job_id": "21917a8d52a19b040152a9f2f1eb003e", 
        "job_type": "batchCreateVolume", 
        "begin_time": "2016-02-04T01:43:37.193Z", 
        "end_time": "2016-02-04T01:44:08.283Z", 
        "error_code": null, 
        "fail_reason": null
    }

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

状态码

  • 正常

    200

错误码

请参考错误码

分享:

    相关文档

    相关产品

关闭导读