更新时间:2024-09-05 GMT+08:00
分享

查询任务的执行状态

功能介绍

查询Job的执行状态。

对于创建云服务器、删除云服务器、重建镜像等异步API,下发命令后会返回job_id,通过job_id可以查询任务的执行状态。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v2/{project_id}/job/{job_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目唯一标识。

job_id

String

任务ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

id

String

任务ID。

job_type

String

任务类型。

begin_time

String

任务创建时间。

end_time

String

任务结束时间。

status

String

任务状态。

sub_jobs_total

Integer

子任务总数。

sub_jobs

Array of JobDetailInfo objects

子任务列表。

表4 JobDetailInfo

参数

参数类型

描述

id

String

子任务ID。

job_type

String

job类型:

  • CREATE_SERVER - 创建服务器

  • DELETE_SERVER - 删除服务器

  • UPDATE_FREEZE_STATUS - 修改服务器冻结状态

  • CREATE_SERVER_IMAGE - 构建镜像

  • REINSTALL_OS - 重装操作系统

  • CHANGE_SERVER_IMAGE - 更换镜像

  • REJOIN_DOMAIN - 重新加域

  • MIGRATE_SERVER - 迁移服务器

  • UPGRADE_ACCESS_AGENT - hda升级

  • UPDATE_SERVER_TSVI - 更新虚拟会话IP

  • SCHEDULED_TASK - 定时任务job

  • COLLECT_HDA_LOG - 收集hda日志

  • COLLECT_APS_LOG - 收集aps日志

  • CREATE_SERVER_SNAPSHOT - 创建服务器快照

  • DELETE_SERVER_SNAPSHOT - 删除服务器快照

  • RESTORE_SERVER_SNAPSHOT - 恢复服务器快照

job_resource_info

JobResourceInfo object

具体的资源信息。

begin_time

String

任务创建时间。

end_time

String

任务结束时间。

status

String

任务状态。

error_code

String

任务执行失败时的错误码。

error_message

String

任务失败原因。

project_id

String

项目ID。

job_id

String

任务ID。

表5 JobResourceInfo

参数

参数类型

描述

resource_id

String

客户在云服务Console上可见的资源实例Id,全局唯一,且不可更改,最大64个字符。 注:“规格变更”场景下(包括升降配),是对某个资源实例的规格进行调整, 该资源实例其他信息(比如资源Id、资源名称)和运行的业务数据不变化。

resource_name

String

资源名称;创建、有最新资源名称场景,必填。

cloud_service_type

String

云服务类型编码;新购、规格变更场景,必填。

resource_type

String

资源类型编码;新购、规格变更场景,必填。

resource_spec_code

String

资源规格编码;新购、规格变更场景,必填。

spec_type

Map<String,Object>

规格类型,运营上需要呈现和使用的一些规格属性,多个使用K:V格式。 比如带宽的共享/独享(shareable:true/false),数据盘的系统盘/数据盘类型(root:true/false)。 当前针对共享带宽、共享盘使用,必填。

spec_size

Double

某些规格属性大小:比如带宽大小、数据盘大小。

measure

Integer

specSize的单位编码,比如GB、M,有specSize时,此字段必填。

processed_time

String

处理时间。

is_main_resource

Integer

该resourceId是否是主资源(仅开通场景使用,其他场景为空)。

  • 1 - 是

  • 0 - 否

main_resources

Array of RelativeResource objects

resourceId的主资源。 是挂载到/绑定到/依附到/包含于/关联到资源,比如IP的主资源‘云主机’、数据盘的主资源‘云主机’。 如果resourceId是依附在多个资源上,则有多个主资源,比如共享盘挂载到多个云主机上。 无关联主资源,则空,比如独立未挂载的数据盘。

extend_params

String

expireTime:到期时间,域名注册服务使用。 UTC时间,格式:yyyy-MM-ddTHH:mm:ssZ(2016-06-28T00:00:00Z)。

old_resource_id

String

仅针对ECS/BMS云服务的“切换操作系统”场景使用。 云主机切换操作系统的资源id会变化场景。 填写变更前老的资源Id。资源Id未变化,无此字段。

old_cloud_service_type

String

仅针对ECS/BMS云服务的“切换操作系统”场景使用:云主机切换操作系统的云服务类型编码会变化场景。 填写变更前老的云服务类型编码。云服务类型未变化,无此字段。

old_resource_type

String

仅针对ECS/BMS云服务“切换操作系统”场景使用。 云主机切换操作系统的资源类型编码会变化场景。 填写变更前老的资源类型编码。资源类型未变化,无此字段。

表6 RelativeResource

参数

参数类型

描述

relative_resource_id

String

关联的资源ID。

relative_resource_name

String

有资源名称的云资源,都需要返回resourceName,如果为空值,则返回“”。

relative_type

Integer

  • 关联关系类型,描述relativeResourceId和resourceId间的关联关系:

    • 0:挂载(弱关联),表示relativeResourceId和resourceId两者有关联关系,

    • 但是两者可以独立使用、分别进行交易,且分别使用和交易都不影响整套云服务的使用;比如云主机和数据盘。 * 1:绑定(强关联),表示relativeResourceId和resourceId是强绑定关系, 两者必须一起使用、一起进行交易,缺少其中一个会造成整套云服务不能使用;比如云主机和系统盘。 缺省值为0(挂载)。 subResources中的RelativeResource,此字段是必填;mainResources中的RelativeResource。

relative_cloud_service_type

String

比如ECS云服务类型为‘hws.service.type.ec2’。

relative_resource_type

String

比如VM的资源类型为‘hws.resource.type.vm’。

extend_params

String

扩展信息,Key:Value格式。

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 403

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

请求示例

GET /v2/29dfe82ada564ac2b927e1ff036d9a9b/job/575768277444198400

响应示例

状态码: 200

成功响应。

{
  "id" : "575768277444198400",
  "job_type" : "CREATE_SERVER",
  "begin_time" : "2023-06-06T02:30:06.836Z",
  "end_time" : "2023-06-06T02:45:49.577Z",
  "status" : "SUCCESS",
  "sub_jobs_total" : 1,
  "sub_jobs" : [ {
    "id" : "575768277481947136",
    "job_type" : "CREATE_SERVER",
    "job_resource_info" : {
      "resource_id" : "a2a6f5af-cbf7-4242-8988-109426870886",
      "resource_name" : "APS-20230606023006-YM08IXT04C"
    },
    "begin_time" : "2023-06-06T02:30:06.902Z",
    "end_time" : "2023-06-06T02:45:49.564Z",
    "status" : "SUCCESS",
    "error_code" : "",
    "error_message" : "",
    "project_id" : "a4da8115c9d8464ead3a38309130523f",
    "job_id" : "575768277444198400"
  } ]
}

状态码

状态码

描述

200

成功响应。

400

由于包含语法错误,当前请求无法被服务器理解。

401

鉴权失败。

403

没有操作权限。

500

服务内部错误,具体返回错误码请参见错误码说明。

错误码

请参见错误码

相关文档