Updated on 2022-10-20 GMT+08:00

Querying Dump Task

Function

This API is used to query dump tasks.

URI

GET /v2/{project_id}/streams/{stream_name}/transfer-tasks

Table 1 Path parameters

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

Table 2 Request header 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

Table 3 Response body parameters

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.

Table 4 TransferTask

Parameter

Type

Description

task_name

String

Name of the dump task.

state

String

Dump task status. Possible values:

  • ERROR: An error occurs.
  • STARTING: The dump task is being started.
  • PAUSED: The dump task has been stopped.
  • RUNNING: The dump task is running.
  • DELETE: The dump task has been deleted.
  • ABNORMAL: The dump task is abnormal.

Enumeration values:

  • ERROR
  • STARTING
  • PAUSED
  • RUNNING
  • DELETE
  • ABNORMAL

destination_type

String

Dump destination. Possible values:

  • OBS: Data is dumped to OBS.

Enumeration values:

  • OBS

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.