This topic describes the StartProjectsByLabel API provided by OceanBase Migration Service (OMS) Community Edition.
Purpose
You can call this operation to start all data migration or synchronization tasks in the Not Started state under the specified label.
Call description
Limitations
This operation is applicable to OMS Community Edition V4.1.1 and later versions.
Request path
POST /api/v2?Action=StartProjectsByLabel
Request parameters
| Parameter | Type | Description |
|---|---|---|
| id | string | The label ID. |
Return result
| 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 projects. |
| ├─ total | integer | The total number of executed projects. |
| ├─ succeedProjectIds | string | The IDs of successful projects. |
| ├─ failedProjectIds | string | The IDs of failed projects. |
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":[
]
}
}