更新时间:2025-08-14 GMT+08:00
分享

获取指定ID的任务信息

功能介绍

获取DDM任务中心指定ID的任务信息。

接口约束

无。

调试

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

URI

  • URL格式

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

  • 参数说明
    表1 参数说明

    参数

    是否必选

    参数类型

    描述

    project_id

    String

    租户在某一region下的project ID。

    获取方法请参见获取项目ID

    job_id

    String

    任务ID。

请求消息

无。

请求示例

获取指定ID的任务信息。
GET https://{endpoint}/v3/{project_id}/jobs/{job_id}

响应消息

  • 正常响应参数说明
    表2 响应Body参数

    参数

    参数类型

    描述

    job

    JobInfo object

    工作流信息。

    表3 JobInfo

    参数

    参数类型

    描述

    id

    String

    任务ID。

    name

    String

    任务名称。

    status

    String

    任务执行状态。

    取值:值为“Running”,表示任务正在执行。值为“Completed”,表示任务执行成功。值为“Failed”,表示任务执行失败。

    created_time

    String

    创建时间,格式为“yyyy-mm-ddThh:mm:ssZ”。

    其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。

    end_time

    String

    结束时间,格式为“yyyy-mm-ddThh:mm:ssZ”。

    其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。

    process

    String

    任务执行进度。

    执行中状态才返回执行进度,例如“60%”,表示任务执行进度为60%,否则返回“”。

    instance

    Instance object

    执行任务的实例信息。

    表4 Instance

    参数

    参数类型

    描述

    id

    String

    实例ID。

    name

    String

    实例名称。

  • 正常响应示例
    {
        "job": {
            "id": "31b8ae23-c687-4d80-b7b4-42a66c9bb886",
            "name": "CreateInstance",
            "status": "Running",
            "created_time": "2018-08-06T10:41:14+0000",
            "end_time": "2018-08-06T16:41:14+0000",
            "process": "60%",
            "instance": {
                "id": "a48e43ff268f4c0e879652d65e63d0fbin09",
                "name": "DDM-test"
            }
        }
    }
  • 异常响应

    请参见异常请求结果

状态码

错误码

请参见错误码

相关文档