This topic describes the StopProjectsByLabel API provided by OceanBase Migration Service (OMS).
Purpose
You can call this operation to stop all data migration or synchronization tasks in the Running state under the specified label.
Call description
Limitations
This operation is supported in OMS V4.1.0 and later.
Request path
POST /api/v2?Action=StopProjectsByLabel
Request parameters
| Parameter | Type | Description |
|---|---|---|
| id | string | The label ID. |
Response parameters
| Parameter | Type | Description |
|---|---|---|
| success | boolean | Indicates whether the call is successful. |
| errorDetail | object | The error details. |
| code | string | The error code. |
| message | string | The error description. |
| advice | string | The suggestions about how to resolve the error. |
| requestId | string | The request ID. |
| pageNumber | integer | The number of the page to return. |
| pageSize | integer | The number of entries to return on each page. |
| totalCount | integer | The total number of entries returned. |
| cost | string | The time spent in processing the request, in seconds. |
| data | string | The information about tasks. |
| ├─ total | integer | The total number of executed tasks. |
| ├─ succeedProjectIds | string | The IDs of successful tasks. |
| ├─ failedProjectIds | string | The IDs of failed tasks. |
Examples
Sample request
{
"id":"l_****"
}
Sample response
{
"success":true,
"errorDetail":null,
"code":null,
"message":null,
"advice":null,
"requestId":"a7b57****",
"pageNumber":null,
"pageSize":null,
"totalCount":null,
"cost":"27 ms",
"data":{
"total":null,
"succeedProjectIds":[
],
"failedProjectIds":[
]
}
}
