文档首页/ DevStar/ API参考/ API/ 代码生成/ 查询任务详情
更新时间：2024-07-04 GMT+08:00
查看PDF
分享

查询任务详情

功能介绍

查询任务的详情。

通过任务ID可以查看任务的状态 当任务结束时返回应用代码存放的位置。

  • 接口鉴权方式 通过华为云服务获取的用户token。
  • 代码生成位置 应用代码生成后的地址，目前支持CodeArts Repo地址和压缩包下载地址。

调试

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

URI

GET /v1/jobs/{job_id}

表1 路径参数

参数

是否必选

参数类型

描述

job_id

是

String

任务 ID: 可以通过调用 RunDevstarTemplateJob 返回结果获取

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

X-Language

否

String

语言类型，缺省值为“zh-cn”。

枚举值：

  • zh-cn：中文
  • en-us：英文

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

id

String

任务的id。

name

String

任务的名称。

job_status

Object

任务的状态。

job_result

String

任务结果信息。

show_type

String

任务显示类型，页面显示使用字段

请求示例

无

响应示例

状态码： 200

OK

{
  "id" : "zNvQCYTy",
  "name" : "zNvQCYTy",
  "job_status" : {
    "initRepository" : {
      "name" : "生成代码",
      "displayName" : null,
      "status" : "success",
      "context" : {
        "web_url" : "生成代码仓的地址"
      },
      "elapsedTime" : "15",
      "createTime" : 1587896259000,
      "startTime" : 1587896260331,
      "endTime" : 1587896275897
    },
    "initPipeline" : {
      "name" : "创建流水线",
      "displayName" : null,
      "status" : "running",
      "context" : null,
      "elapsedTime" : 2,
      "createTime" : 1587896259000,
      "startTime" : 1587896260331,
      "endTime" : 1587896275897
    },
    "errorMessage" : null
  },
  "job_result" : "running",
  "show_type" : null
}

状态码： 400

Bad Request

{
  "error_code" : "HDN.1001",
  "error_msg" : "参数错误"
}

状态码： 401

Unauthorized

{
  "error_code" : "HDN.1001",
  "error_msg" : "权限错误"
}

状态码： 403

Forbidden

{
  "error_code" : "HDN.1001",
  "error_msg" : "权限错误"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码。

父主题： 代码生成

相关文档