vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dis/api-ref/BatchStartTransferTask.html
gtema 6bc123a554 Reimplementation of docs/doc-exports#263 
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: gtema <artem.goncharov@gmail.com>
Co-committed-by: gtema <artem.goncharov@gmail.com>
2022-11-11 12:03:08 +00:00

6.6 KiB
Raw Blame History

Starting Dump Tasks in Batches

Function

This API is used to start dump tasks in batches.

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, only the following operation is supported:

  • start: The dump task is started.

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 in Batches

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