Listing Dumping Tasks

Function

This API is used to list dumping tasks.

This API is out-of-date and may not be maintained in the future. Please use the API described in Querying Smart Connect Tasks.

Call Method

For details, see How to Call an API.

URI

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

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID.
connector_id	Yes	String	Instance dump ID. For details, see Querying Instance IDs.

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 a 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 dumping task.

Example Request

Listing dumping tasks

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

Example Response

Status code: 200

Successfully listing dumping tasks

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