Querying a Background Task

Function

This API is used to query a specified background task.

URI

GET /v2/{project_id}/instances/{instance_id}/tasks/{task_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID.
instance_id	Yes	String	Instance ID.
task_id	Yes	String	Task ID.

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
task_count	String	Definition Number of tasks. Range N/A
tasks	Array of tasks objects	Definition Task list.

**Table 3** tasks
Parameter	Type	Description
id	String	Definition Task ID. Range N/A
name	String	Definition Task name. Range N/A
user_name	String	Definition Username. Range N/A
user_id	String	Definition User ID. Range N/A
params	String	Definition Task parameters. Range N/A
status	String	Definition Task status. Range CREATED: The background task is created. SUCCESS: The background task is successful. FAILED: The background task fails. DELETED: The background task is deleted. EXECUTING: The background task is being executed. CANCELLED: The scheduled task is canceled.
created_at	String	Definition Start time. Range N/A
updated_at	String	Definition End time. Range N/A

Example Requests

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/tasks/{task_id}

Example Responses

Status code: 200

The query is successful.

{
  "task_count" : "1",
  "tasks" : [ {
    "id" : "ff80808272dcc90f0172df1e490f41b0",
    "name" : "bindInstancePublicIp",
    "user_name" : "dms_test",
    "user_id" : "xxxxxxxx93ff484a828144c6xxxxxxxx",
    "params" : "{\"public_ip_id\":\"06a13350-4305-4338-9f0e-6b322bb1413d\",\"public_ip_address\":\"xx.xx.xx.xx\",\"enable_public_ip\":true}",
    "status" : "SUCCESS",
    "created_at" : "2020-06-23T03:00:03.471Z",
    "updated_at" : "2020-06-23T03:00:08.130Z"
  } ]
}