文档首页/ 云应用引擎 CAE/ API参考/ CAE API/ 任务/ 获取任务详情
更新时间：2024-11-14 GMT+08:00
查看PDF
分享

获取任务详情

功能介绍

获取任务详情。

调试

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取项目ID请参见获取项目ID。

job_id

是

String

任务ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

  • 获取Token，请参考《统一身份认证服务API参考》的“获取用户Token”章节。

  • 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Enterprise-Project-ID

否

String

企业项目ID。

  • 创建环境时，环境会绑定企业项目ID。

  • 最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。

  • 该字段不传（或传为字符串“0”）时，则查询默认企业项目下的资源。

说明：

关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。

X-Environment-ID

是

String

环境ID。

  • 获取环境ID，通过《云应用引擎API参考》的“获取环境列表”章节获取环境信息。

  • 请求响应成功后在响应体的items数组中的一个元素即为一个环境的信息，其中id字段即是环境ID。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

api_version

String

API版本，固定值“v1”，该值不可修改。

kind

String

API类型，固定值“Job”，该值不可修改。

spec

JobSpec object

job规格信息。
表4 JobSpec

参数

参数类型

描述

progress

Number

任务进度。

status

String

任务状态。

tasks

Array of Task objects

子任务。
表5 Task

参数

参数类型

描述

index

Integer

任务序号。

name

String

任务名称。

status

String

任务状态。

detail

String

任务详情。

created_at

String

创建时间。

updated_at

String

更新时间。

请求示例

获取任务详情。

GET https://{endpoint}/v1/{project_id}/cae/jobs/{job_id}

响应示例

状态码： 200

请求成功。

{
  "api_version" : "v1",
  "kind" : "Job",
  "spec" : {
    "progress" : 0,
    "status" : "running",
    "tasks" : [ {
      "index" : 1,
      "name" : "upgrade",
      "status" : "init",
      "detail" : "",
      "created_at" : "2023-02-16T11:24:07.950175Z",
      "updated_at" : "2023-02-16T11:24:07.950175Z"
    } ]
  }
}

状态码

状态码

描述

200

请求成功。

错误码

请参见错误码。

父主题： 任务

相关文档