This API is used to deploy and initialize an OceanBase cluster.
Call description
Limitations
If you set a password in the request, you must specify the X-OCS-Auth field in the header for authentication. For more information, see Authentication based on public-key encryption.
Request path
POST /api/v1/ob/init
Response parameters
| Parameter | Type | Description |
|---|---|---|
| successful | Boolean | Indicates whether the request is successful. |
| timestamp | Datetime | The timestamp when the server completed the request. |
| duration | Integer | The amount of time taken by the server to process the request, in milliseconds. |
| status | Integer | The HTTP status code. |
| traceId | String | The trace ID of the request. |
| data | Object | The information about the asynchronous task. For more information, see GetDagDetails. |
| error | Object | The information about the error that occurred. |
Examples
Sample request
POST xxx.xxx.1:2886/api/v1/ob/init
Sample response
{
"successful": true,
"timestamp": "2024-01-09T16:38:29.712344717+08:00",
"duration": 4,
"status": 200,
"traceId": "4f0fd04e3befd3bd",
"data": {
"id": "22130706433028869",
"dag_id": 4,
"name": "Initialize cluster",
"stage": 1,
"max_stage": 10,
"state": "READY",
"operator": "RUN",
"start_time": "2024-01-09T16:38:29.708290486+08:00",
"end_time": "2024-01-09T16:38:29.708290486+08:00",
"additional_data": null,
"nodes": null
}
}
