文档首页/ 云容器引擎 CCE/ API参考（安卡拉区域）/ API/ 集群管理/ 获取任务信息
更新时间：2024-12-04 GMT+08:00
查看PDF
分享

获取任务信息

功能介绍

该API用于获取任务信息。通过某一任务请求下发后返回的jobID来查询指定任务的进度。

  • 集群管理的URL格式为：https://Endpoint/uri。其中uri为资源路径，也即API访问的路径

  • 该接口通常使用场景为：

    • 创建、删除集群时，查询相应任务的进度。

    • 创建、删除节点时，查询相应任务的进度。

URI

GET /api/v3/projects/{project_id}/jobs/{job_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见如何获取接口URI中参数。

job_id

是

String

任务ID，获取方式请参见如何获取接口URI中参数。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

消息体的类型（格式）

X-Auth-Token

是

String

调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值，获取方式请参见获取token。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

kind

String

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

apiVersion

String

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

metadata

JobMetadata object

任务元数据。

spec

JobSpec object

任务详细参数。

status

JobStatus object

任务状态信息。
表4 JobSpec

参数

参数类型

描述

type

String

任务的类型，例：“CreateCluster”- 创建集群。

clusterUID

String

任务所在的集群的ID。

resourceID

String

任务操作的资源ID。

resourceName

String

任务操作的资源名称。

extendParam

Map<String,String>

扩展参数。

subJobs

Array of Job objects

子任务的列表。

  • 包含了所有子任务的详细信息

  • 在创建集群、节点等场景下，通常会由多个子任务共同组成创建任务，在子任务都完成后，任务才会完成
表5 Job

参数

参数类型

描述

kind

String

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

apiVersion

String

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

metadata

JobMetadata object

任务元数据。

spec

JobSpec object

任务详细参数。

status

JobStatus object

任务状态信息。
表6 JobMetadata

参数

参数类型

描述

uid

String

任务的ID。

creationTimestamp

String

任务的创建时间。

updateTimestamp

String

任务的更新时间。
表7 JobStatus

参数

参数类型

描述

phase

String

任务的状态，有如下四种状态：

  • JobPhaseInitializing JobPhase = "Initializing"

  • JobPhaseRunning JobPhase = "Running"

  • JobPhaseFailed JobPhase = "Failed"

  • JobPhaseSuccess JobPhase = "Success"

reason

String

任务变为当前状态的原因

请求示例

无

响应示例

状态码： 200

表示获取任务信息成功。

{
  "kind" : "Job",
  "apiVersion" : "v3",
  "metadata" : {
    "uid" : "354331b2c-229a-11e8-9c75-0255ac100ceb",
    "creationTimestamp" : "2018-08-02 08:12:40.672772389 +0000 UTC",
    "updateTimestamp" : "2018-08-02 08:21:50.478108569 +0000 UTC"
  },
  "spec" : {
    "type" : "CreateCluster",
    "clusterUID" : "4d1ecb2c-229a-11e8-9c75-0255ac100ceb",
    "resourceID" : "6f4dcb2c-229a-11e8-9c75-0255ac100ceb",
    "resourceName" : "cluster-name",
    "extendParam" : {
      "serverID" : "bc467e3a-2338-11e8-825b-0255ac100c13"
    },
    "subJobs" : [ {
      "kind" : "Job",
      "apiVersion" : "v3",
      "metadata" : {
        "uid" : "fd474fab-9606-11e8-baa9-0255ac10215d",
        "creationTimestamp" : "2018-08-02 03:52:34.615819618 +0000 UTC",
        "updateTimestamp" : "2018-08-02 04:05:29.196243031 +0000 UTC"
      },
      "spec" : {
        "type" : "InstallMaster",
        "clusterUID" : "fcc72de0-9606-11e8-baa8-0255ac10215d",
        "resourceID" : "fd3b4ac0-9606-11e8-baa8-0255ac10215d",
        "extendParam" : {
          "serverID" : "fd3b4ac0-9606-11e8-baa8-0255ac10215d"
        }
      },
      "status" : {
        "phase" : "Success"
      }
    }, {
      "kind" : "Job",
      "apiVersion" : "v3",
      "metadata" : {
        "uid" : "fd474f82-9606-11e8-baa8-0255ac10215d",
        "creationTimestamp" : "2018-08-02 03:52:33.859150791 +0000 UTC",
        "updateTimestamp" : "2018-08-02 03:52:34.615655429 +0000 UTC"
      },
      "spec" : {
        "type" : "CreatePSMCert",
        "clusterUID" : "fcc72de0-9606-11e8-baa8-0255ac10215d"
      },
      "status" : {
        "phase" : "Success"
      }
    } ]
  },
  "status" : {
    "phase" : "Running",
    "reason" : ""
  }
}

状态码

状态码

描述

200

表示获取任务信息成功。

错误码

请参见错误码。

父主题： 集群管理