获取部署任务详细信息

功能介绍

通过此API获取部署任务详细信息。

调试

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

URI

GET /v2/{project_id}/cas/jobs/{job_id}

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	租户项目ID。获取方法，请参考获取项目ID。
job_id	是	String	部署任务ID，为创建组件实例接口响应参数的job_id。

表2 查询参数
参数	是否必选	参数类型	描述
instance_id	否	String	应用组件实例ID。获取方法，请参考获取组件实例。
limit	否	Integer	指定个数。
offset	否	Integer	指定偏移量。
desc	否	String	是否降序： true=desc，false=asc。

请求消息

表3 请求Header参数
参数	是否必选	参数类型	描述
Content-Type	是	String	消息体的类型（格式），默认取值为“application/json;charset=utf8”。
X-Auth-Token	是	String	调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。

响应消息

表4 响应参数
参数	参数类型	描述
task_count	Integer	部署任务数量。
job	Object	构建工程参数，请参考表5。
tasks	Array of objects	部署任务参数，请参考表6。

表5 job
参数	参数类型	描述
CREATED_BY	String	创建者。
EXECUTION_STATUS	String	执行状态。 SUBMITTED：已提交但尚未处理。 SCHEDULED：计划在未来执行的。 RUNNING：当前正在处理。 FAILED：处于失败状态。 SUCCEEDED：处于成功状态。 CANCELLED：已取消。 PARTIALLY_FAILED：部分失败。 ROLLBACKING：正在回滚。 ROLLBACKED：已回滚。 UNKNOWN：未知状态。
JOB_DESC	String	工作描述。
JOB_ID	String	工作ID。
JOB_NAME	String	工作名称。
JOB_TYPE	String	类别： PROVISION：提供服务任务。 DEPROVISION：取消提交服务任务。 DAILY_OPERATION：日常操作任务。 SYSTEM_INNER：系统内部任务。 UNKNOWN：未知任务。
ORDER_ID	String	排序ID。
PROJECT_ID	String	创建租户Project ID。
SERVICE_INSTANCE_ID	String	实例ID。

表6 task
参数	参数类型	描述
CREATED_AT	String	创建时间。
LAST_HEALTH_CHECK	String	健康检查时间。
MESSAGES	String	消息。
OWNER_ID	String	创建用户ID。
TASK_ID	String	任务ID。
TASK_INDEX	Integer	任务序号。
TASK_NAME	String	任务名称。
TASK_STATUS	String	任务状态： SUBMITTED：已提交但尚未处理。 SCHEDULED：计划在未来执行的。 RUNNING：当前正在处理。 FAILED：处于失败状态。 SUCCEEDED：处于成功状态。 CANCELLED：已取消。 PARTIALLY_FAILED：部分失败。 SKIPPED：已跳过。 ROLLBACKING：正在回滚。 ROLLBACKED：已回滚。 UNKNOWN：未知状态。
TASK_TYPE	String	任务类型： kube：K8s任务。 restful：RESTful HTTP请求任务。 sleep：sleep等待任务。 echo：输出任务。 context：上下文任务。 sub-job：子任务。

请求示例

无

响应示例

{
    "job": {
        "JOB_ID": "JOB474362ef-091d-429f-9b3e-c9246b37dee6", 
        "JOB_NAME": "provision/provMain", 
        "JOB_TYPE": "PROVISION", 
        "SERVICE_INSTANCE_ID": "429a35a0-dee8-4648-86f6-d1f8bc74ba52", 
        "PROJECT_ID": "063a3158b1a34710b36ad208b9497d00", 
        "ORDER_ID": "", 
        "JOB_DESC": "provision/provMain", 
        "EXECUTION_STATUS": "FAILED", 
        "CREATED_BY": "585cc5c16cda4954b28d4eb460f06261"
    }, 
    "tasks": [
        {
            "MESSAGES": "{}", 
            "TASK_ID": "Task-bc64b46c-1688-4787-b7ff-87cb53b346ea", 
            "TASK_TYPE": "echo", 
            "TASK_INDEX": 1, 
            "TASK_NAME": "SEPARATOR_PREPARE_RESOURCES", 
            "TASK_STATUS": "SUCCEEDED", 
            "LAST_HEALTH_CHECK": "2020-02-04T04:01:03.344Z", 
            "CREATED_AT": "2020-02-04T04:01:03.344Z", 
            "OWNER_ID": "cas-mgr-69bb87d7c-wpqwb:30114"
        }, 
        {
            "MESSAGES": "{}", 
            "TASK_ID": "Task-15ec252f-bca0-401e-ae5b-798a639df92e", 
            "TASK_TYPE": "echo", 
            "TASK_INDEX": 4, 
            "TASK_NAME": "SEPARATOR_BUILDING", 
            "TASK_STATUS": "SUCCEEDED", 
            "LAST_HEALTH_CHECK": "2020-02-04T04:01:03.346Z", 
            "CREATED_AT": "2020-02-04T04:01:03.345Z", 
            "OWNER_ID": "cas-mgr-69bb87d7c-wpqwb:30114"
        }, 
        {
            "MESSAGES": "{}", 
            "TASK_ID": "Task-52a5d1ae-2c54-46ec-8134-53e7b6a45fb7", 
            "TASK_TYPE": "restful", 
            "TASK_INDEX": 6, 
            "TASK_NAME": "TN00091", 
            "TASK_STATUS": "SUCCEEDED", 
            "LAST_HEALTH_CHECK": "2020-02-04T04:01:08.924Z", 
            "CREATED_AT": "2020-02-04T04:01:03.346Z", 
            "OWNER_ID": "cas-mgr-69bb87d7c-wpqwb:30114"
        }, 
        {
            "MESSAGES": "{}", 
            "TASK_ID": "Task-a149b585-d31b-4c72-a665-d820efcb0bf9", 
            "TASK_TYPE": "restful", 
            "TASK_INDEX": 7, 
            "TASK_NAME": "TN00094", 
            "TASK_STATUS": "SUCCEEDED", 
            "LAST_HEALTH_CHECK": "2020-02-04T04:01:08.961Z", 
            "CREATED_AT": "2020-02-04T04:01:08.925Z", 
            "OWNER_ID": "cas-mgr-69bb87d7c-wpqwb:30114"
        }, 
        {
            "MESSAGES": "{
  \"Message\" : \"ECC00011\",
  \"Detail\" : \"Building failed.\"
}", 
            "TASK_ID": "Task-a72fe8d8-8cc1-42b5-a097-0cf9e29692a7", 
            "TASK_TYPE": "restful", 
            "TASK_INDEX": 9, 
            "TASK_NAME": "TN00097", 
            "TASK_STATUS": "FAILED", 
            "LAST_HEALTH_CHECK": "2020-02-04T04:01:38.975Z", 
            "CREATED_AT": "2020-02-04T04:01:08.962Z", 
            "OWNER_ID": "cas-mgr-69bb87d7c-wpqwb:30114"
        }
    ], 
    "task_count": 5
}