doc-exports/docs/dis/api-ref/BatchStartTransferTask.html

Starting Dump Tasks

Function

This API is used to start dump tasks.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/streams/{stream_name}/transfer-tasks/action

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 body parameters

Parameter	Mandatory	Type	Description
action	Yes	String	Dump task operation. Currently, the following operation is supported: start: starting dump tasks Enumeration values: start
tasks	Yes	Array of BatchTransferTask objects	List of dump tasks to be operated

Table 3 BatchTransferTask

Parameter	Mandatory	Type	Description
id	Yes	String	Dump task ID

Response Parameters

None

Example Requests

Starting Dump Tasks

POST https://{Endpoint}/v2/{project_id}/streams/{stream_name}/transfer-tasks/action

{
  "action" : "start",
  "tasks" : [ {
    "id" : "9dSu1wfCytSk1aOLxvF"
  } ]
}

Example Responses

None

Status Codes

Status Code	Description
200	Normal response

Error Codes

See Error Codes.

Parent topic: Dump Task Management