Listing Dump Tasks
Function
This API is used to list dump 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
| 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
| Parameter | Type | Description |
|---|---|---|
| tasks | Array of tasks objects | List of dump tasks. |
| total_number | Integer | Total number of dump tasks. |
| max_tasks | Integer | Maximum number of tasks. |
| quota_tasks | Integer | Task quotas. |
| Parameter | Type | Description |
|---|---|---|
| task_id | String | Task ID. |
| task_name | String | Name of a dump task. |
| destination_type | String | Type of the dump task. |
| create_time | Long | Time when the dump task is created. |
| status | String | Dump task status. |
| topics | String | Topic list or topic regular expression of the dump task. |
Example Request
Listing dump tasks
GET https://{endpoint}/v2/{project_id}/connectors/{connector_id}/sink-tasks Example Response
Status code: 200
The dump task list is queried 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 Code
| Status Code | Description |
|---|---|
| 200 | The dump task list is queried. |
Error Code
See Error Codes.
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot