Listing Background Tasks

Updated on 2023-07-20 GMT+08:00

View PDF

Function

This API is used to list background tasks of an instance.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain it, see Obtaining a Project ID.
instance_id	Yes	String	Instance ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
start	No	Integer	ID of the task where the query starts.
limit	No	Integer	Number of tasks to be queried.
begin_time	No	String	Time of task where the query starts. The format is YYYYMMDDHHmmss.
end_time	No	String	Time of task where the query ends. The format is YYYYMMDDHHmmss.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
task_count	String	Number of tasks.
tasks	Array of tasks objects	Task list.

**Table 4** tasks
Parameter	Type	Description
id	String	Task ID.
name	String	Task name.
user_name	String	Username.
user_id	String	User ID.
params	String	Task parameters.
status	String	Task status.
created_at	String	Start time.
updated_at	String	End time.

Example Requests

'GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/tasks?start={start}&limit={limit}&begin_time={begin_time}&end_time={end_time}'

Example Responses

Status code: 200

The tasks are listed successfully.

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