Help Center/ Distributed Message Service for RocketMQ/ API Reference/ APIs V2 (Recommended)/ Background Task Management/ Querying a Background Task List of an Instance
Updated on 2026-04-30 GMT+08:00
View PDF

Querying a Background Task List of an Instance

Function

This API is used to query a background task list of an instance.

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. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Definition:

Number of records to query.

Constraints:

N/A

Range:

1–100

Default Value:

N/A

begin_time

No

String

Definition:

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

Constraints:

N/A

Range:

≥ 0

Default Value:

N/A

end_time

No

String

Definition:

Time of a 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.

Constraints

N/A

Range

N/A

Default Value

N/A

tasks

Array of tasks objects

Definition

Task list.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 4 tasks

Parameter

Type

Description

id

String

Definition

Task ID.

Constraints

N/A

Range

N/A

Default Value

N/A

name

String

Definition

Task name.

Constraints

N/A

Range

N/A

Default Value

N/A

user_name

String

Definition

Username.

Constraints

N/A

Range

N/A

Default Value

N/A

user_id

String

Definition

User ID.

Constraints

N/A

Range

N/A

Default Value

N/A

params

String

Definition

Task parameter.

Constraints

N/A

Range

N/A

Default Value

N/A

status

String

Definition

Task status.

Constraints

N/A

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.

Default Value

N/A

created_at

String

Definition

Start time.

Constraints

N/A

Range

N/A

Default Value

N/A

updated_at

String

Definition

End time.

Constraints

N/A

Range

N/A

Default Value

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

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

Status Codes

Status Code

Description

200

Successful

Error Codes

See Error Codes.

Parent Topic: Background Task Management