镜像服务 IMS-异步任务查询:响应消息

时间:2024-12-09 11:11:21

响应消息

  • 响应参数

    根据job_type的取值不同,响应消息的结构会有所差异,更多响应示例请参见响应示例

    参数

    参数类型

    描述

    status

    String

    任务状态,目前取值如下:

    • SUC CES S:表示该任务执行已经结束,任务执行成功。
    • FAIL:表示该任务执行已经结束,任务执行失败。
    • RUNNING:表示该任务正在执行。
    • INIT:表示该任务还未执行,正在初始化。

    job_id

    String

    任务ID。

    job_type

    String

    任务类型。

    • imsCreateImageByInstance:云服务器创建镜像
    • imsImportImageJob:外部镜像文件创建镜像
    • imsImportOvaImageJob:外部Ova镜像文件创建镜像
    • imsVolumeCreateImageJob:数据盘创建系统盘镜像
    • imsVolumesToSysDataImagesJob:数据盘创建数据盘镜像
    • imsImportDataImageJob:外部镜像文件创建数据盘镜像
    • imsCreateWholeImageByInstanceJob:云服务器创建整机镜像
    • imsCreateWholeImageByBackupJob:云备份或云服务器备份创建整机镜像
    • imsNativeImportImageJob:注册镜像
    • imsNativeExportImageJob:导出镜像
    • imsAddImageMembersJob:添加镜像成员
    • imsDelImageMembersJob:删除镜像成员
    • imsUpdateImageMembersJob:修改镜像成员
    • imsCopyImageInRegionJob:Region内复制镜像
    • imsCrossRegionCopyImageJob:跨Region复制镜像

    begin_time

    String

    任务开始执行时间。格式为UTC时间。

    end_time

    String

    任务结束时间。格式为UTC时间。

    error_code

    String

    错误码。

    fail_reason

    String

    失败原因。

    entities

    Object

    任务自定义属性。

    任务正常时,返回镜像的ID;任务异常时,返回错误码和信息。

    详情请参见表2

    表2 entities字段数据结构说明

    参数

    参数类型

    描述

    image_id

    String

    镜像ID。

    当job_type取值为以下任务类型时,会返回该参数。

    • imsCreateImageByInstance
    • imsImportImageJob
    • imsVolumeCreateImageJob
    • imsImportDataImageJob
    • imsCreateWholeImageByInstanceJob
    • imsCreateWholeImageByBackupJob
    • imsNativeImportImageJob
    • imsNativeExportImageJob
    • imsCopyImageInRegionJob
    • imsCrossRegionCopyImageJob

    current_task

    String

    当前任务名称。

    image_name

    String

    镜像名称。

    results

    Array of result objects

    批量任务执行结果。详情请参见表3

    sub_jobs_result

    Array of objects

    子任务执行结果。详情请参见表4

    sub_jobs_list

    Array of string

    子任务id列表。

    addition_error_code

    string

    添加错误码

    addition_error_msg

    string

    添加错误消息

    error_code

    string

    错误码

    error

    string

    错误消息

    alarm_code

    string

    告警代码

    表3 results字段数据结构说明

    参数

    参数类型

    描述

    image_id

    String

    镜像ID。

    当job_type取值为以下任务类型时,会返回该参数。

    • imsAddImageMembersJob
    • imsUpdateImageMembersJob

    project_id

    String

    项目ID。

    status

    String

    任务状态。

    表4 sub_jobs_result字段数据结构说明

    参数

    参数类型

    描述

    status

    String

    子任务状态,取值如下:

    • SUCCESS:表示该任务执行已经结束,任务执行成功。
    • FAIL:表示该任务执行已经结束,任务执行失败。
    • RUNNING:表示该任务正在执行。
    • INIT:表示该任务还未执行,正在初始化。

    job_id

    String

    子任务ID。

    job_type

    String

    子任务类型。

    begin_time

    String

    子任务开始执行时间。格式为UTC时间。

    end_time

    String

    子任务结束时间。格式为UTC时间。

    error_code

    String

    错误码。

    fail_reason

    String

    失败原因。

    entities

    Object

    子任务自定义属性。详情请参见表5

    • 任务正常时,返回镜像的ID。
    • 任务异常时,返回错误码和信息。
    表5 sub_jobs_result.entities字段数据结构说明

    参数

    参数类型

    描述

    image_id

    String

    镜像ID。

    当job_type取值为以下任务类型时,会返回该参数。

    • imsImportOvaImageJob
    • imsVolumesToSysDataImagesJob

    image_name

    String

    镜像名称。

support.huaweicloud.com/api-ims/ims_03_0905.html