Querying a Dump Task List
Function
This API is used to query a dump task list.
When querying a dump task list, you need to specify the stream name.
Request
- Example request
GET https://{endpoint}/v2/{project_id}/streams/stream-test/transfer-tasks - Parameter description
Parameter
Mandatory
Type
Description
stream_name
Yes
String
Name of the DIS stream to be queried.
Response
- Example response
{ "tasks":[ { "task_name":"task", "create_time":1534142793097, "last_transfer_timestamp":1534163694103, "state":"RUNNING", "destination_type": "OBS" }, { "task_name":"another_task", "create_time":1534163306123, "last_transfer_timestamp":1534163680563, "state":"RUNNING", "destination_type": "DLI" } ], "total_number":2 } - Parameter description
Table 1 Response parameter description Parameter
Type
Description
total_number
Integer
Total number of dump tasks.
tasks
List<Task>
List of dump tasks.
Table 2 Task parameter description Parameter
Type
Description
task_name
String
Name of the dump task.
create_time
Long
Task creation timestamp.
last_transfer_timestamp
Long
Timestamp of the latest dump.
state
Integer
Dump task status. Possible values:
- ABNORMAL
- RUNNING
destination_type
String
Dump destination. Possible values:
- OBS
- MRS
- DLI
- CLOUDTABLE
- DWS
Response Code
- Normal
- Failed
For more information, see Error Codes.
Last Article: Querying Dump Task Details
Next Article: Obtaining Stream Consumption Information
Did this article solve your problem?
Thank you for your score!Your feedback would help us improve the website.