Querying Dump Task
Function
This API is used to query dump tasks.
URI
GET /v2/{project_id}/streams/{stream_name}/transfer-tasks
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
stream_name |
Yes |
String |
Name of the stream to be queried. Maximum: 60 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header). |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total_number |
Integer |
Total number of dump tasks. |
quota |
Integer |
Maximum number of dump tasks that can be created. |
tasks |
Array of TransferTask objects |
List of dump tasks. |
Parameter |
Type |
Description |
---|---|---|
task_name |
String |
Name of the dump task. |
state |
String |
Dump task status. Possible values:
Enumeration values:
|
destination_type |
String |
Dump destination. Possible values:
Enumeration values:
|
create_time |
Long |
Time when the dump task is created. |
last_transfer_timestamp |
Long |
Latest dump time of the dump task. |
Example Requests
Querying Dump Tasks
GET https://{Endpoint}/v2/{project_id}/streams/{stream_name}/transfer-tasks
Example Responses
Status code: 200
Normal response.
{ "tasks" : [ { "task_id" : "As805BudhcH1lDs6gbn", "destination_type" : "OBS", "task_name" : "newtask", "create_time" : 1606554932552, "state" : "RUNNING", "last_transfer_timestamp" : 1606984428612 } ], "total_number" : 1 }
Status Codes
Status Code |
Description |
---|---|
200 |
Normal response. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank 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