This API is used to check whether the conditions for OceanBase Database upgrade are met. For example, OceanBase Shell (OBShell) checks whether the required environment is prepared, whether the OceanBase Database upgrade package is uploaded, and whether all required products are ready.
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/upgrade/check
Request parameters
Parameter |
Type |
Required |
Example value |
Description |
|---|---|---|---|---|
| version | String | Yes | 4.2.1.1 | The target version of the upgrade. |
| release | String | Yes | 101000062023110109.el7 | The release version and build version of the software package for the upgrade. |
| upgradeDir | String | No | /data/upgrade | The directory used for the upgrade check task. |
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
"{
"version":"4.2.1.1",
"release": "101000062023110109.el7"
}"
Sample response
{
"successful": true,
"timestamp": "2024-01-09T16:55:58.588435165+08:00",
"duration": 75,
"status": 200,
"traceId": "8daee52899b845b8",
"data": {
"id": "11",
"dag_id": 1,
"name": "Upgrade check OB 4.2.1.1-101000062023110109.el7",
"stage": 1,
"max_stage": 6,
"state": "READY",
"operator": "RUN",
"start_time": "0001-01-01T00:00:00Z",
"end_time": "0001-01-01T00:00:00Z",
"additional_data": null,
"nodes": null
}
}