Help Center> Distributed Message Service for Kafka> API Reference> APIs V2 (Recommended)> Dumping Management> Listing Dumping Tasks
View PDF

Listing Dumping Tasks

Function

Listing Dumping Tasks

Debugging

You can use API Explorer to debug this API.

URI

GET /v2/{project_id}/connectors/{connector_id}/sink-tasks

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Tenant's project ID.

connector_id

Yes

String

Instance dump ID. The value can be obtained from response of the API for querying an instance.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

tasks

Array of tasks objects

List of dumping tasks.

total_number

Integer

Total number of dumping tasks.

max_tasks

Integer

Maximum number of tasks.

quota_tasks

Integer

Task quotas.
Table 3 tasks

Parameter

Type

Description

task_id

String

Task ID.

task_name

String

Name of the dumping task.

destination_type

String

Type of the dumping task.

create_time

Long

Time when the dumping task is created.

status

String

Dumping task status.

topics

String

Topic list or topic regular expression of the dumped task.

Example Requests

GET https://{endpoint}/v2/{project_id}/connectors/{connector_id}/sink-tasks

Example Responses

Status code: 200

Dumping tasks are listed successfully.

{
  "tasks" : [ {
    "task_id" : "2e148bed-3038-4617-8ade-b52e84a33eeb",
    "task_name" : "obsTransfer-1122976956",
    "destination_type" : "OBS",
    "create_time" : 1592309487621,
    "status" : "RUNNING",
    "topics" : "topic-test"
  } ],
  "total_number" : 1,
  "max_tasks" : 9,
  "quota_tasks" : 10
}

Status Codes

Status Code

Description

200

Dumping tasks are listed successfully.

Error Codes

See Error Codes.

Parent topic: Dumping Management