查询任务的执行状态（已废弃） - ShowJob

功能介绍

查询Job的执行状态。

对于创建云应用服务器命令下发后会返回job_id，通过job_id可以查询任务的执行状态。

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
workspace:jobs:get
Read
-
-
-
-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
workspace:jobs:get	Read	-	-	-	-

URI

GET /v1/{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参数
参数	参数类型	描述
job	JobDetail object	Job信息详情。

表4 JobDetail
参数	参数类型	描述
job_id	String	任务ID。
job_type	Integer	job类型，固定值1。
job_status	Integer	job执行状态 0：失败。（如果是开通失败，云运营查询到失败状态，直接退费给客户。如果是变更失败，当前是发运维工单，暂时还不是直接退费给客户。） 1：成功。（处理结果成功。） 2：处理中。 3：正在初始化。
sub_jobs	Array of SubJobInfo objects	子任务信息。
begin_time	String	Job处理开始时间。
end_time	String	job处理结束时间。
expected_end_time	String	云服务预估的Job处理结束时间，只针对job有效，针对子job无效。
execute_code	String	Job执行结果码。
execute_message	String	Job执行结果描述，以及每个SubJob的执行结果描述。

表5 SubJobInfo
参数	参数类型	描述
job_id	String	子job标识。
job_type	Integer	任务类型，固定值2：子Job。
job_status	Integer	job状态 0：失败。 1：成功。 2：处理中。 3：正在初始化。
entities	Array of JobResourceInfo objects	SubJob中处理的云服务/云资源对象。创建、规格变更等场景是必填；冻结、解冻、删除等场景可空。
begin_time	String	任务开始时间。
end_time	String	任务结束时间。
expected_end_time	String	云服务预估的Job处理结束时间，只针对job有效，针对子job无效。
execute_code	String	Job执行结果码。
execute_message	String	Job执行结果描述，以及每个SubJob的执行结果描述。

表6 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云服务“切换操作系统”场景使用。云主机切换操作系统的资源类型编码会变化场景。填写变更前老的资源类型编码。资源类型未变化，无此字段。

表7 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

表8 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：401

表9 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：403

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：500

**表11** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

请求示例

GET /v1/29dfe82ada564ac2b927e1ff036d9a9b/job/575768277444198400

响应示例

状态码：200

成功响应。

{
  "job" : {
    "job_id" : "575768277444198400",
    "job_type" : 1,
    "job_status" : 0,
    "sub_jobs" : [ {
      "job_id" : "575768277481947136",
      "job_type" : 2,
      "job_status" : 0,
      "entities" : [ ],
      "begin_time" : "2023-06-06T02:30:06Z",
      "end_time" : "2023-06-06T02:45:49Z"
    } ],
    "begin_time" : "2023-06-06T02:30:06Z",
    "end_time" : "2023-06-06T02:45:49Z",
    "expected_end_time" : "2023-06-06T15:55:57Z",
    "execute_code" : "",
    "execute_message" : ""
  }
}

状态码

状态码	描述
200	成功响应。
400	由于包含语法错误，当前请求无法被服务器理解。
401	鉴权失败。
403	没有操作权限。
500	服务内部错误，具体返回错误码请参见错误码说明。