Obtaining Information About a Task with a Specified ID

Function

This API is used to obtain information about a task with a specified ID in the DDM task center.

Constraints

None

URI

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

Parameter description

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region To obtain this value, see Obtaining a Project ID.
instance_id	Yes	String	DDM instance ID

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token You can obtain the token by calling the IAM API used to obtain a user token.

Example Request

Obtaining information about a task with a specified ID

GET https://{endpoint}/v3/{project_id}/jobs/{job_id}

Response

Normal response

**Table 3** Response body parameters
Parameter	Type	Description
job	JobInfo object	Task information.

**Table 4** JobInfo
Parameter	Type	Description
id	String	Task ID
name	String	Task name
status	String	Task execution status. The value can be: Running: The task is being executed. Completed: The task is successfully executed. Failed: The task fails to be executed.
created_time	String	Creation time in the "yyyy-mm-ddThh:mm:ssZ" format. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the offset is +0800.
end_time	String	End time. The format is yyyy-mm-ddThh:mm:ssZ. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the offset is +0800.
process	String	Task execution progress The execution progress (such as "60%", indicating the task execution progress is 60%) is displayed only when the task is being executed. Otherwise, "" is returned.
instance	Instance object	Instance on which the task is executed

**Table 5** Instance
Parameter	Type	Description
id	String	Instance ID
name	String	Instance name

Normal response example

{
    "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"
        }
    }
}