forked from docs/doc-exports
Xiong, Chen Xiao
83fa2f6615
Reviewed-by: Kacur, Michal <michal.kacur@t-systems.com> Co-authored-by: Xiong, Chen Xiao <chenxiaoxiong@huawei.com> Co-committed-by: Xiong, Chen Xiao <chenxiaoxiong@huawei.com>
6.6 KiB
6.6 KiB
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
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 |
|---|---|---|---|
action |
Yes |
String |
Dump task operation. The value can only be start, which indicates starting a dump task. Enumeration values:
|
tasks |
Yes |
Array of BatchTransferTask objects |
List of dump tasks to be operated. |
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