Help Center/ Distributed Message Service for Kafka/ API Reference/ APIs V2 (Recommended)/ Background Task Management/ Listing Background Tasks
Updated on 2026-03-16 GMT+08:00
View PDF

Listing Background Tasks

Function

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

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. For details about how to obtain it, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Definition

ID of the task where the query starts.

Constraints

N/A

Range

N/A

Default Value

N/A

limit

No

Integer

Definition

Number of tasks to be queried.

Constraints

N/A

Range

N/A

Default Value

N/A

begin_time

No

String

Definition

Time of task where the query starts. The format is YYYYMMDDHHmmss.

Constraints

N/A

Range

N/A

Default Value

N/A

end_time

No

String

Definition

Time of task where the query ends. The format is YYYYMMDDHHmmss.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 3 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 4 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?start={start}&limit={limit}&begin_time={begin_time}&end_time={end_time}'

Example Responses

Status code: 200

Background tasks are listed successfully.

{
  "task_count" : "4",
  "tasks" : [ {
    "id" : "8abfa7b372160bfd0172165864064079",
    "name" : "modifyAutoTopic",
    "user_name" : "paas_dms",
    "user_id" : "3df5acbc24a54fadb62a043c9000a307",
    "params" : "{\"old_auto_status\":true,\"new_auto_status\":false}",
    "status" : "EXECUTING",
    "created_at" : "2020-05-15T03:19:51.046Z",
    "updated_at" : "2020-05-15T03:19:51.065Z"
  }, {
    "id" : "8abfa7b372160bfd017216560af83e6e",
    "name" : "changeRetentionPolicy",
    "user_name" : "paas_dms",
    "user_id" : "3df5acbc24a54fadb62a043c9000a307",
    "params" : "{\"new_retention_policy\":\"produce_reject\",\"origin_retention_policy\":\"time_base\"}",
    "status" : "SUCCESS",
    "created_at" : "2020-05-15T03:17:17.176Z",
    "updated_at" : "2020-05-15T03:17:22.162Z"
  } ]
}

Status Codes

Status Code

Description

200

Background tasks are listed successfully.

Error Codes

See Error Codes.

Parent Topic: Background Task Management