華為云計算 云知識 查詢配額ShowResourceQuota
查詢配額ShowResourceQuota

 

功能介紹

該接口為擴展接口,主要用于查詢異步接口執(zhí)行情況,比如查詢導出 鏡像 任務的執(zhí)行狀態(tài)。

調試

您可以在API Explorer中調試該接口。

URI

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

參數(shù)說明請參見表1。
表1 參數(shù)說明

參數(shù)

是否必選

描述

project_id

項目ID

job_id

異步任務ID

請求消息

請求參數(shù)

請求示例

查詢異步接口執(zhí)行情況。

GET /v1/ac234de25c6741d2b1273da49eea1b9e/jobs/ff8080814dbd65d7014dbe0d84db0013

響應消息

  • 響應參數(shù)

    參數(shù)

    參數(shù)類型

    描述

    status

    String

    任務狀態(tài),目前取值如下:

    • SUC CES S:表示該任務執(zhí)行已經結束,任務執(zhí)行成功。
    • FAIL:表示該任務執(zhí)行已經結束,任務執(zhí)行失敗。
    • RUNNING:表示該任務正在執(zhí)行。
    • INIT:表示該任務還未執(zhí)行,正在初始化。

    job_id

    String

    任務ID。

    job_type

    String

    任務類型。

    • imsCreateImageByInstance: 云服務器 制作鏡像
    • imsImportImageJob:外部鏡像文件創(chuàng)建鏡像
    • imsImportOvaImageJob:外部Ova鏡像文件創(chuàng)建鏡像
    • imsVolumeCreateImageJob:數(shù)據(jù)盤制作數(shù)據(jù)盤鏡像
    • imsImportDataImageJob:外部鏡像文件制作數(shù)據(jù)盤鏡像
    • imsCreateWholeImageByInstanceJob:云服務器制作整機鏡像
    • imsCreateWholeImageByBackupJob: 云備份 云服務器備份 制作整機鏡像
    • imsNativeImportImageJob:注冊鏡像
    • imsNativeExportImageJob:導出鏡像
    • imsAddImageMembersJob:添加鏡像成員
    • imsDelImageMembersJob:刪除鏡像成員
    • imsUpdateImageMembersJob:修改鏡像成員
    • imsCopyImageInRegionJob:Region內復制鏡像
    • imsCopyImageCrossUserJob:跨Region復制鏡像

    begin_time

    String

    任務開始執(zhí)行時間。格式為UTC時間。

    end_time

    String

    任務結束時間。格式為UTC時間。

    error_code

    String

    錯誤碼。

    fail_reason

    String

    失敗原因。

    entities

    Object

    任務自定義屬性。

    任務正常時,返回鏡像的ID;任務異常時,返回錯誤碼和信息。

    詳情請參見表2。

    表2 entities字段數(shù)據(jù)結構說明

    參數(shù)

    參數(shù)類型

    描述

    image_id

    String

    鏡像ID。

    current_task

    String

    當前任務名稱。

    image_name

    String

    鏡像名稱。

    process_percent

    Double

    任務執(zhí)行進度。

    results

    Array of result objects

    批量任務執(zhí)行結果。詳情請參見表3。

    sub_jobs_result

    Array of SubJobResult objects

    子任務執(zhí)行結果。詳情請參見表4。

    sub_jobs_list

    Array of string

    子任務id列表。

    表3 result字段數(shù)據(jù)結構說明

    參數(shù)

    數(shù)據(jù)結構說明

    描述

    image_id

    String

    鏡像ID。

    project_id

    String

    項目ID。

    status

    String

    任務狀態(tài)。

    表4 SubJobResult字段數(shù)據(jù)結構說明

    參數(shù)

    數(shù)據(jù)結構說明

    描述

    status

    String

    子任務狀態(tài),取值如下:

    • SUCCESS:表示該任務執(zhí)行已經結束,任務執(zhí)行成功。
    • FAIL:表示該任務執(zhí)行已經結束,任務執(zhí)行失敗。
    • RUNNING:表示該任務正在執(zhí)行。
    • INIT:表示該任務還未執(zhí)行,正在初始化。

    job_id

    String

    子任務ID。

    job_type

    String

    子任務類型。

    begin_time

    String

    子任務開始執(zhí)行時間。格式為UTC時間。

    end_time

    String

    子任務結束時間。格式為UTC時間。

    error_code

    String

    錯誤碼。

    fail_reason

    String

    失敗原因。

    entities

    Object SubJobEntities

    子任務自定義屬性。詳情請參見表5

    • 任務正常時,返回鏡像的ID。
    • 任務異常時,返回錯誤碼和信息。
    表5 SubJobEntities字段數(shù)據(jù)結構說明

    參數(shù)

    數(shù)據(jù)結構說明

    描述

    image_id

    String

    鏡像ID。

    image_name

    String

    鏡像名稱。

  • 響應樣例
    STATUS CODE 200
    {
        "status": "SUCCESS",
        "entities": {
            "image_id": "e9e91bff-14b6-4a0b-8377-4ed0813e3360",
            "image_name": "asdfasdfasdfas",
            "process_percent": 0.20,
            "current_task": "CreateImageByInstanceTask",
            "results": [{
                    "image_id": "49e9447f-7dff-41e0-8036-f66fe5488c8b",
                    "project_id": "089b2f9a3d80d3062f24c00ca4ed5cbd",
                    "status": "success"
                }
            ]
        },
        "job_id": "ff8080814dbd65d7014dbe0d84db0013",
        "job_type": "createImageByInstance",
        "begin_time": "04-Jun-2015 18:11:06:586",
        "end_time": "",
        "error_code": null,
        "fail_reason": null
    }
    

返回值

  • 正常

    200

  • 異常

    返回值

    說明

    400 Bad Request

    請求錯誤。

    401 Unauthorized

    鑒權失敗。

    403 Forbidden

    沒有操作權限。

    500 Internal Server Error

    服務內部錯誤。

    503 Service Unavailable

    服務不可用。