This topic describes the CreateLabel API provided by OceanBase Migration service (OMS).
Purpose
You can call this operation to create a label.
Call description
Limitations
This operation is supported in OMS V4.1.0 and later.
Request path
POST /api/v2?Action=CreateLabel
Request parameters
| Parameter | Type | Description |
|---|---|---|
| name | string | The name of the label. |
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 label ID. |
Examples
Sample request
{
"name": "test"
}
Sample response
{
"success": true,
"errorDetail": null,
"code": null,
"message": null,
"advice": null,
"requestId": "dewx****",
"pageNumber": 1,
"pageSize": 10,
"totalCount": 415,
"cost": "12 ms",
"data": "l_****"
}
